Class sap.ui.unified.SplitContainerModule: sap/ui/unified/SplitContainer

extends Control

Provides a main content and a secondary content area

Experimental API:Since version 1.15.0. API is not yet finished and might change completely


Since: 1.15.0.
Constructor Summary
new sap.ui.unified.SplitContainer(sId?, mSettings?)Constructor for a new SplitContainer.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.unified.SplitContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.SplitContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.SplitContainer.getMetadata()Returns a metadata object for class sap.ui.unified.SplitContainer.
addContent(oContent)Adds some content to the aggregation content.
addSecondaryContent(oSecondaryContent)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.
getContent()Gets content of aggregation content.
getOrientation()Gets current value of property orientation.
getSecondaryContent()Gets content of aggregation secondaryContent.
getSecondaryContentSize()Gets current value of property secondaryContentSize.
getShowSecondaryContent()Gets current value of property showSecondaryContent.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
indexOfSecondaryContent(oSecondaryContent)Checks for the provided sap.ui.core.Control in the aggregation secondaryContent.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
insertSecondaryContent(oSecondaryContent, iIndex)Inserts a secondaryContent into the aggregation secondaryContent.
removeAllContent()Removes all the controls from the aggregation content.
removeAllSecondaryContent()Removes all the controls from the aggregation secondaryContent.
removeContent(vContent)Removes a content from the aggregation content.
removeSecondaryContent(vSecondaryContent)Removes a secondaryContent from the aggregation secondaryContent.
setOrientation(sOrientation)Sets a new value for property orientation.
setSecondaryContentSize(sSecondaryContentSize)Sets a new value for property secondaryContentSize.
setShowSecondaryContent(bShowSecondaryContent)Sets a new value for property showSecondaryContent.
getSecondaryContentWidth()Gets current value of property secondaryContentWidth.
setSecondaryContentWidth(sSecondaryContentWidth)Sets a new value for property secondaryContentWidth.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.unified.SplitContainer(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.ui.unified.SplitContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.unified.SplitContainer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.SplitContainer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.ui.unified.SplitContainer
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
addSecondaryContent(oSecondaryContent): sap.ui.unified.SplitContainer
Adds some secondaryContent to the aggregation secondaryContent.
Parameters:
{sap.ui.core.Control}oSecondaryContent the secondaryContent to add; if empty, nothing is inserted
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
destroyContent(): sap.ui.unified.SplitContainer
Destroys all the content in the aggregation content.
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
destroySecondaryContent(): sap.ui.unified.SplitContainer
Destroys all the secondaryContent in the aggregation secondaryContent.
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

The content to appear in the main area.

Returns:
{sap.ui.core.Control[]}
getOrientation(): sap.ui.core.Orientation
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.

Since:
1.22.0
Returns:
{sap.ui.core.Orientation} Value of property orientation
getSecondaryContent(): sap.ui.core.Control[]
Gets content of aggregation secondaryContent.

The content to appear in the secondary area.

Returns:
{sap.ui.core.Control[]}
getSecondaryContentSize(): sap.ui.core.CSSSize
Gets current value of property secondaryContentSize.

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

Default value is 250px.

Returns:
{sap.ui.core.CSSSize} Value of property secondaryContentSize
getShowSecondaryContent(): boolean
Gets current value of property showSecondaryContent.

Shows / Hides the secondary area.

Returns:
{boolean} Value of property showSecondaryContent
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfSecondaryContent(oSecondaryContent): int
Checks for the provided sap.ui.core.Control in the aggregation secondaryContent. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oSecondaryContent The secondaryContent whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.unified.SplitContainer
Inserts a content into the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
insertSecondaryContent(oSecondaryContent, iIndex): sap.ui.unified.SplitContainer
Inserts a secondaryContent into the aggregation secondaryContent.
Parameters:
{sap.ui.core.Control}oSecondaryContent the secondaryContent to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllSecondaryContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation secondaryContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.core.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
removeSecondaryContent(vSecondaryContent): sap.ui.core.Control
Removes a secondaryContent from the aggregation secondaryContent.
Parameters:
{int|string|sap.ui.core.Control}vSecondaryContent The secondaryContentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed secondaryContent or null
setOrientation(sOrientation): sap.ui.unified.SplitContainer
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.

Parameters:
{sap.ui.core.Orientation}sOrientation New value for property orientation
Since:
1.22.0
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
setSecondaryContentSize(sSecondaryContentSize): sap.ui.unified.SplitContainer
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.

Parameters:
{sap.ui.core.CSSSize}sSecondaryContentSize New value for property secondaryContentSize
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
setShowSecondaryContent(bShowSecondaryContent): sap.ui.unified.SplitContainer
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.

Parameters:
{boolean}bShowSecondaryContent New value for property showSecondaryContent
Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining
getSecondaryContentWidth(): sap.ui.core.CSSSize
Gets current value of property secondaryContentWidth.

Do not use. Use secondaryContentSize instead.

Default value is 250px.

Deprecated:
Since version 1.22.

Only available for backwards compatibility.

Returns:
{sap.ui.core.CSSSize} Value of property secondaryContentWidth
setSecondaryContentWidth(sSecondaryContentWidth): sap.ui.unified.SplitContainer
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.

Parameters:
{sap.ui.core.CSSSize}sSecondaryContentWidth New value for property secondaryContentWidth
Deprecated:
Since version 1.22.

Only available for backwards compatibility.

Returns:
{sap.ui.unified.SplitContainer} Reference to this in order to allow method chaining