class sap.ui.unified.SplitContainer

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/unified/SplitContainer
Application Component: CA-UI5-TBL

Provides a main content and a secondary content area


Constructor

Constructor for a new SplitContainer.

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.unified.SplitContainer(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
orientation sap.ui.core.Orientation Horizontal

Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").

Since: 1.22.0.

Visibility: public
secondaryContentSize sap.ui.core.CSSSize 250px

The width if the secondary content. The height is always 100%.

Visibility: public
secondaryContentWidth sap.ui.core.CSSSize 250px

Do not use. Use secondaryContentSize instead.

Visibility: public
showSecondaryContent boolean

Shows / Hides the secondary area.

Visibility: public

Aggregations

Default Aggregation: content

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

The content to appear in the main area.

secondaryContent 0..n sap.ui.core.Control

The content to appear in the secondary area.


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

addSecondaryContent

Adds some secondaryContent to the aggregation secondaryContent.

destroyContent

Destroys all the content in the aggregation content.

destroySecondaryContent

Destroys all the secondaryContent in the aggregation secondaryContent.

sap.ui.unified.SplitContainer.extend

Creates a new subclass of class sap.ui.unified.SplitContainer 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.core.Control.extend.

getContent

Gets content of aggregation content.

The content to appear in the main area.

sap.ui.unified.SplitContainer.getMetadata

Returns a metadata object for class sap.ui.unified.SplitContainer.

getOrientation

Gets current value of property orientation.

Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").

Default value is Horizontal.

getSecondaryContent

Gets content of aggregation secondaryContent.

The content to appear in the secondary area.

getSecondaryContentSize

Gets current value of property secondaryContentSize.

The width if the secondary content. The height is always 100%.

Default value is '250px'.

getSecondaryContentWidth

Gets current value of property secondaryContentWidth.

Do not use. Use secondaryContentSize instead.

Default value is '250px'.

Since 1.22 Only available for backwards compatibility.
getShowSecondaryContent

Gets current value of property showSecondaryContent.

Shows / Hides the secondary area.

indexOfContent

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

indexOfSecondaryContent

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

insertContent

Inserts a content into the aggregation content.

insertSecondaryContent

Inserts a secondaryContent into the aggregation secondaryContent.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllSecondaryContent

Removes all the controls from the aggregation secondaryContent.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

removeSecondaryContent

Removes a secondaryContent from the aggregation secondaryContent.

setOrientation

Sets a new value for property orientation.

Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Horizontal.

setSecondaryContentSize

Sets a new value for property secondaryContentSize.

The width if the secondary content. The height is always 100%.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is '250px'.

setSecondaryContentWidth

Sets a new value for property secondaryContentWidth.

Do not use. Use secondaryContentSize instead.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is '250px'.

Since 1.22 Only available for backwards compatibility.
setShowSecondaryContent

Sets a new value for property showSecondaryContent.

Shows / Hides the secondary area.

When called with a value of null or undefined, the default value of the property will be restored.

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

addSecondaryContent

Adds some secondaryContent to the aggregation secondaryContent.

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

The secondaryContent to add; if empty, nothing is inserted

destroyContent

Destroys all the content in the aggregation content.

destroySecondaryContent

Destroys all the secondaryContent in the aggregation secondaryContent.

sap.ui.unified.SplitContainer.extend

Creates a new subclass of class sap.ui.unified.SplitContainer 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.core.Control.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.

The content to appear in the main area.

sap.ui.unified.SplitContainer.getMetadata

Returns a metadata object for class sap.ui.unified.SplitContainer.

getOrientation

Gets current value of property orientation.

Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").

Default value is Horizontal.

getSecondaryContent

Gets content of aggregation secondaryContent.

The content to appear in the secondary area.

getSecondaryContentSize

Gets current value of property secondaryContentSize.

The width if the secondary content. The height is always 100%.

Default value is '250px'.

getSecondaryContentWidth

Gets current value of property secondaryContentWidth.

Do not use. Use secondaryContentSize instead.

Default value is '250px'.

Since 1.22 Only available for backwards compatibility.

getShowSecondaryContent

Gets current value of property showSecondaryContent.

Shows / Hides the secondary area.

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

indexOfSecondaryContent

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

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

The secondaryContent 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

insertSecondaryContent

Inserts a secondaryContent into the aggregation secondaryContent.

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

The secondaryContent to insert; if empty, nothing is inserted

iIndex int

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

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllSecondaryContent

Removes all the controls from the aggregation secondaryContent.

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

removeSecondaryContent

Removes a secondaryContent from the aggregation secondaryContent.

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

The secondaryContent to remove or its index or id

setOrientation

Sets a new value for property orientation.

Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Horizontal.

Param Type DefaultValue Description
sOrientation sap.ui.core.Orientation Horizontal

New value for property orientation

setSecondaryContentSize

Sets a new value for property secondaryContentSize.

The width if the secondary content. The height is always 100%.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is '250px'.

Param Type DefaultValue Description
sSecondaryContentSize sap.ui.core.CSSSize '250px'

New value for property secondaryContentSize

setSecondaryContentWidth

Sets a new value for property secondaryContentWidth.

Do not use. Use secondaryContentSize instead.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is '250px'.

Since 1.22 Only available for backwards compatibility.
Param Type DefaultValue Description
sSecondaryContentWidth sap.ui.core.CSSSize '250px'

New value for property secondaryContentWidth

setShowSecondaryContent

Sets a new value for property showSecondaryContent.

Shows / Hides the secondary area.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
bShowSecondaryContent boolean

New value for property showSecondaryContent