class sap.ui.ux3.OverlayDialog

Control sample: sap.ui.ux3.OverlayDialog
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/OverlayDialog
Application Component: CA-UI5-CTR

Dialog implementation based on the Overlay. If used in a Shell it leaves the Tool-Palette, Pane-Bar and Header-Items accessible.


Constructor

Constructor for a new OverlayDialog.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.ux3.OverlayDialog(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given.

mSettings? object

Initial settings for the new control.


Properties

Name Type Default Value Description
height sap.ui.core.CSSSize auto

Determines the height of the Overlay Dialog. If the height is set to "auto" it is always 50% of the overlay height.

Visibility: public
width sap.ui.core.CSSSize auto

Determines the width of the Overlay Dialog. If the width is set to "auto" it is always 50% of the overlay width.

Visibility: public

Borrowed Properties

Name Type Default Value Description
closeButtonVisible boolean true

Defines whether the 'Close' button shall be visible.

Visibility: public
openButtonVisible boolean true

Defines whether the 'Open' button shall be visible.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
content 0..n sap.ui.core.Control

Content for the OverlayDialog.


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

destroyContent

Destroys all the content in the aggregation content.

sap.ui.ux3.OverlayDialog.extend

Creates a new subclass of class sap.ui.ux3.OverlayDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.ux3.Overlay.extend.

getContent

Gets content of aggregation content.

Content for the OverlayDialog.

getHeight

Gets current value of property height.

Determines the height of the Overlay Dialog. If the height is set to "auto" it is always 50% of the overlay height.

Default value is 'auto'.

sap.ui.ux3.OverlayDialog.getMetadata

Returns a metadata object for class sap.ui.ux3.OverlayDialog.

getWidth

Gets current value of property width.

Determines the width of the Overlay Dialog. If the width is set to "auto" it is always 50% of the overlay width.

Default value is 'auto'.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

insertContent

Inserts a content into the aggregation content.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

setHeight

The height for the OverlayDialog.

setOpenButtonVisible

This Method is not supported for the OverlayDialog.

setWidth

The width for the OverlayDialog.

addContent

Adds some content to the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to add; if empty, nothing is inserted

destroyContent

Destroys all the content in the aggregation content.

sap.ui.ux3.OverlayDialog.extend

Creates a new subclass of class sap.ui.ux3.OverlayDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.ux3.Overlay.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getContent

Gets content of aggregation content.

Content for the OverlayDialog.

getHeight

Gets current value of property height.

Determines the height of the Overlay Dialog. If the height is set to "auto" it is always 50% of the overlay height.

Default value is 'auto'.

sap.ui.ux3.OverlayDialog.getMetadata

Returns a metadata object for class sap.ui.ux3.OverlayDialog.

getWidth

Gets current value of property width.

Determines the width of the Overlay Dialog. If the width is set to "auto" it is always 50% of the overlay width.

Default value is 'auto'.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content whose index is looked for

insertContent

Inserts a content into the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to insert; if empty, nothing is inserted

iIndex int

The 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

Param Type DefaultValue Description
vContent int string sap.ui.core.Control

The content to remove or its index or id

setHeight

The height for the OverlayDialog.

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize

setOpenButtonVisible

This Method is not supported for the OverlayDialog.

Param Type DefaultValue Description
bVisible boolean

setWidth

The width for the OverlayDialog.

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize