Class sap.ui.unified.ShellLayoutModule: sap/ui/unified/ShellLayout

extends Control
known direct subclasses: Shell

The shell layout is the base for the shell control which is meant as root control (full-screen) of an application. It was build as root control of the Fiori Launchpad application and provides the basic capabilities for this purpose. Do not use this control within applications which run inside the Fiori Lauchpad and do not use it for other scenarios than the root control usecase.


Since: 1.25.0.
Constructor Summary
new sap.ui.unified.ShellLayout(sId?, mSettings?)Constructor for a new ShellLayout.
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.ShellLayout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.ShellLayout with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.ShellLayout.getMetadata()Returns a metadata object for class sap.ui.unified.ShellLayout.
addContent(oContent)Adds some content to the aggregation content.
addPaneContent(oPaneContent)Adds some paneContent to the aggregation paneContent.
destroyContent()Destroys all the content in the aggregation content.
destroyHeader()Destroys the header in the aggregation header.
destroyPaneContent()Destroys all the paneContent in the aggregation paneContent.
getContent()Gets content of aggregation content.
getHeader()Gets content of aggregation header.
getHeaderHiding()Gets current value of property headerHiding.
getHeaderVisible()Gets current value of property headerVisible.
getPaneContent()Gets content of aggregation paneContent.
getShowPane()Gets current value of property showPane.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
indexOfPaneContent(oPaneContent)Checks for the provided sap.ui.core.Control in the aggregation paneContent.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
insertPaneContent(oPaneContent, iIndex)Inserts a paneContent into the aggregation paneContent.
removeAllContent()Removes all the controls from the aggregation content.
removeAllPaneContent()Removes all the controls from the aggregation paneContent.
removeContent(vContent)Removes a content from the aggregation content.
removePaneContent(vPaneContent)Removes a paneContent from the aggregation paneContent.
setHeader(oHeader)Sets the aggregated header.
setHeaderHiding(bHeaderHiding)Sets a new value for property headerHiding.
setHeaderVisible(bHeaderVisible)Sets a new value for property headerVisible.
setShowPane(bShowPane)Sets a new value for property showPane.
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.ShellLayout(sId?, mSettings?)
Constructor for a new ShellLayout.

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.ShellLayout.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.ShellLayout 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.ShellLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.ShellLayout.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.ui.unified.ShellLayout
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.ShellLayout} Reference to this in order to allow method chaining
addPaneContent(oPaneContent): sap.ui.unified.ShellLayout
Adds some paneContent to the aggregation paneContent.
Parameters:
{sap.ui.core.Control}oPaneContent the paneContent to add; if empty, nothing is inserted
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining
destroyContent(): sap.ui.unified.ShellLayout
Destroys all the content in the aggregation content.
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining
destroyHeader(): sap.ui.unified.ShellLayout
Destroys the header in the aggregation header.
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining
destroyPaneContent(): sap.ui.unified.ShellLayout
Destroys all the paneContent in the aggregation paneContent.
Returns:
{sap.ui.unified.ShellLayout} 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 canvas.

Returns:
{sap.ui.core.Control[]}
getHeader(): sap.ui.core.Control
Gets content of aggregation header.

The control to appear in the header area.

Returns:
{sap.ui.core.Control}
getHeaderHiding(): boolean
Gets current value of property headerHiding.

Whether the header can be hidden (manually or automatically). This feature is only available when touch events are supported.

Default value is false.

Returns:
{boolean} Value of property headerHiding
getHeaderVisible(): boolean
Gets current value of property headerVisible.

If set to false, no header (and no items, search, ...) is shown.

Default value is true.

Returns:
{boolean} Value of property headerVisible
getPaneContent(): sap.ui.core.Control[]
Gets content of aggregation paneContent.

The content to appear in the pane area.

Returns:
{sap.ui.core.Control[]}
getShowPane(): boolean
Gets current value of property showPane.

Shows / Hides the side pane.

Default value is false.

Returns:
{boolean} Value of property showPane
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
indexOfPaneContent(oPaneContent): int
Checks for the provided sap.ui.core.Control in the aggregation paneContent. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oPaneContent The paneContent 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.ShellLayout
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.ShellLayout} Reference to this in order to allow method chaining
insertPaneContent(oPaneContent, iIndex): sap.ui.unified.ShellLayout
Inserts a paneContent into the aggregation paneContent.
Parameters:
{sap.ui.core.Control}oPaneContent the paneContent to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the paneContent should be inserted at; for a negative value of iIndex, the paneContent is inserted at position 0; for a value greater than the current size of the aggregation, the paneContent is inserted at the last position
Returns:
{sap.ui.unified.ShellLayout} 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)
removeAllPaneContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation paneContent.

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
removePaneContent(vPaneContent): sap.ui.core.Control
Removes a paneContent from the aggregation paneContent.
Parameters:
{int|string|sap.ui.core.Control}vPaneContent The paneContentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed paneContent or null
setHeader(oHeader): sap.ui.unified.ShellLayout
Sets the aggregated header.
Parameters:
{sap.ui.core.Control}oHeader The header to set
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining
setHeaderHiding(bHeaderHiding): sap.ui.unified.ShellLayout
Sets a new value for property headerHiding.

Whether the header can be hidden (manually or automatically). This feature is only available when touch events are supported.

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

Default value is false.

Parameters:
{boolean}bHeaderHiding New value for property headerHiding
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining
setHeaderVisible(bHeaderVisible): sap.ui.unified.ShellLayout
Sets a new value for property headerVisible.

If set to false, no header (and no items, search, ...) is shown.

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

Default value is true.

Parameters:
{boolean}bHeaderVisible New value for property headerVisible
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining
setShowPane(bShowPane): sap.ui.unified.ShellLayout
Sets a new value for property showPane.

Shows / Hides the side pane.

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

Default value is false.

Parameters:
{boolean}bShowPane New value for property showPane
Returns:
{sap.ui.unified.ShellLayout} Reference to this in order to allow method chaining