class sap.ui.ux3.OverlayContainer

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

Is to be embedded into the Overlay control as content container


Constructor

Constructor for a new OverlayContainer.

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.OverlayContainer(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

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: content

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

Aggregation for content


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

destroyContent

Destroys all the content in the aggregation content.

sap.ui.ux3.OverlayContainer.extend

Creates a new subclass of class sap.ui.ux3.OverlayContainer 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.

Aggregation for content

sap.ui.ux3.OverlayContainer.getMetadata

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

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.

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.OverlayContainer.extend

Creates a new subclass of class sap.ui.ux3.OverlayContainer 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.

Aggregation for content

sap.ui.ux3.OverlayContainer.getMetadata

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

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