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.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.unified.ShellLayout(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 |
Name | Type | Default Value | Description |
---|---|---|---|
headerHiding | boolean | false | Whether the header can be hidden (manually or automatically). This feature is only available when touch events are supported. Visibility: public |
headerVisible | boolean | true | If set to false, no header (and no items, search, ...) is shown. Visibility: public |
showPane | boolean | false | Shows / Hides the side pane. Visibility: public |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
canvasSplitContainer | 0..1 | sap.ui.unified.SplitContainer |
Private storage for the internal split container for the canvas. |
content (default) | 0..n | sap.ui.core.Control |
The content to appear in the main canvas. |
curtainSplitContainer | 0..1 | sap.ui.unified.SplitContainer |
Private storage for the internal split container for the curtain. |
header | 0..1 | sap.ui.core.Control |
The control to appear in the header area. |
paneContent | 0..n | sap.ui.core.Control |
The content to appear in the pane area. |
Method | Description |
---|---|
addContent |
Adds some content to the aggregation content. |
addPaneContent |
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. |
sap.ui.unified.ShellLayout.extend |
Creates a new subclass of class sap.ui.unified.ShellLayout with name
|
getContent |
Gets content of aggregation content. The content to appear in the main canvas. |
getHeader |
Gets content of aggregation header. The control to appear in the header area. |
getHeaderHiding |
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 |
getHeaderVisible |
Gets current value of property headerVisible. If set to false, no header (and no items, search, ...) is shown. Default value is |
sap.ui.unified.ShellLayout.getMetadata |
Returns a metadata object for class sap.ui.unified.ShellLayout. |
getPaneContent |
Gets content of aggregation paneContent. The content to appear in the pane area. |
getShowPane |
Gets current value of property showPane. Shows / Hides the side pane. Default value is |
indexOfContent |
Checks for the provided |
indexOfPaneContent |
Checks for the provided |
insertContent |
Inserts a content into the aggregation content. |
insertPaneContent |
Inserts a paneContent into the aggregation paneContent. |
removeAllContent |
Removes all the controls from the aggregation content. Additionally, it unregisters them from the hosting UIArea. |
removeAllPaneContent |
Removes all the controls from the aggregation paneContent. Additionally, it unregisters them from the hosting UIArea. |
removeContent |
Removes a content from the aggregation content. |
removePaneContent |
Removes a paneContent from the aggregation paneContent. |
setHeader |
Sets the aggregated header. |
setHeaderHiding |
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 Default value is |
setHeaderVisible |
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 Default value is |
setShowPane |
Sets a new value for property showPane. Shows / Hides the side pane. When called with a value of Default value is |
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 |
Adds some paneContent to the aggregation paneContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPaneContent | sap.ui.core.Control |
The paneContent to add; if empty, nothing is inserted |
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.
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 |
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
.
Gets current value of property headerVisible.
If set to false, no header (and no items, search, ...) is shown.
Default value is true
.
Returns a metadata object for class sap.ui.unified.ShellLayout.
Gets current value of property showPane.
Shows / Hides the side pane.
Default value is false
.
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 |
Checks for the provided sap.ui.core.Control
in the aggregation paneContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPaneContent | sap.ui.core.Control |
The paneContent whose index is looked for |
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 |
Inserts a paneContent into the aggregation paneContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPaneContent | sap.ui.core.Control |
The paneContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation paneContent.
Additionally, it unregisters them from the hosting UIArea.
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 |
Removes a paneContent from the aggregation paneContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vPaneContent | int string sap.ui.core.Control |
The paneContent to remove or its index or id |
Sets the aggregated header.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeader | sap.ui.core.Control |
The header to set |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bHeaderHiding | boolean | false |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bHeaderVisible | boolean | true |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowPane | boolean | false |
New value for property |