Class sap.ui.unified.ShellModule: sap/ui/unified/Shell
extends ShellLayout
The shell control 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.15.1.
Constructor Summary
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ui.unified.Shell.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.Shell with name
sClassName and enriches it with the information contained in oClassInfo.addCurtainPaneContent(oCurtainPaneContent)Adds some curtainPaneContent to the aggregation
curtainPaneContent.destroyCurtainPaneContent()Destroys all the curtainPaneContent in the aggregation
curtainPaneContent.destroyHeader()Destroys the header in the aggregation named
header, but only if a custom header is set.indexOfCurtainContent(oCurtainContent)Checks for the provided
sap.ui.core.Control in the aggregation curtainContent.indexOfCurtainPaneContent(oCurtainPaneContent)Checks for the provided
sap.ui.core.Control in the aggregation curtainPaneContent.indexOfHeadEndItem(oHeadEndItem)Checks for the provided
sap.ui.unified.ShellHeadItem in the aggregation headEndItems.indexOfHeadItem(oHeadItem)Checks for the provided
sap.ui.unified.ShellHeadItem in the aggregation headItems.insertCurtainContent(oCurtainContent, iIndex)Inserts a curtainContent into the aggregation
curtainContent.insertCurtainPaneContent(oCurtainPaneContent, iIndex)Inserts a curtainPaneContent into the aggregation
curtainPaneContent.removeCurtainPaneContent(vCurtainPaneContent)Removes a curtainPaneContent from the aggregation
curtainPaneContent.Methods borrowed from class sap.ui.unified.ShellLayout
addContent, addPaneContent, destroyContent, destroyPaneContent, getContent, getHeader, getHeaderHiding, getHeaderVisible, getPaneContent, getShowPane, indexOfContent, indexOfPaneContent, insertContent, insertPaneContent, removeAllContent, removeAllPaneContent, removeContent, removePaneContent, setHeaderHiding, setHeaderVisible, setShowPane
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
Constructor Detail
new sap.ui.unified.Shell(sId?, mSettings?)
Constructor for a new Shell.
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:
- Properties
- icon : sap.ui.core.URI
- showCurtain : boolean
- showCurtainPane : boolean
- searchVisible : boolean (default: true)
- Aggregations
- curtainContent : sap.ui.core.Control[]
- curtainPaneContent : sap.ui.core.Control[]
- headItems : sap.ui.unified.ShellHeadItem[]
- headEndItems : sap.ui.unified.ShellHeadItem[]
- search : sap.ui.core.Control
- user : sap.ui.unified.ShellHeadUserItem
In addition, all settings applicable to the base type sap.ui.unified.ShellLayout 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.Shell.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.Shell 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.unified.ShellLayout.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.Shell.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.Shell.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
addCurtainContent(oCurtainContent): sap.ui.unified.Shell
Adds some curtainContent to the aggregation
curtainContent. Parameters:
| {sap.ui.core.Control} | oCurtainContent | the curtainContent to add; if empty, nothing is inserted |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
addCurtainPaneContent(oCurtainPaneContent): sap.ui.unified.Shell
Adds some curtainPaneContent to the aggregation
curtainPaneContent. Parameters:
| {sap.ui.core.Control} | oCurtainPaneContent | the curtainPaneContent to add; if empty, nothing is inserted |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
addHeadEndItem(oHeadEndItem): sap.ui.unified.Shell
Adds some headEndItem to the aggregation
headEndItems. Parameters:
| {sap.ui.unified.ShellHeadItem} | oHeadEndItem | the headEndItem to add; if empty, nothing is inserted |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
addHeadItem(oHeadItem): sap.ui.unified.Shell
Adds some headItem to the aggregation
headItems. Parameters:
| {sap.ui.unified.ShellHeadItem} | oHeadItem | the headItem to add; if empty, nothing is inserted |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
destroyCurtainContent(): sap.ui.unified.Shell
Destroys all the curtainContent in the aggregation
curtainContent. Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
destroyCurtainPaneContent(): sap.ui.unified.Shell
Destroys all the curtainPaneContent in the aggregation
curtainPaneContent. Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
destroyHeadEndItems(): sap.ui.unified.Shell
Destroys all the headEndItems in the aggregation
headEndItems. Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
destroyHeader(): sap.ui.unified.Shell
Destroys the header in the aggregation named
header, but only if a custom header is set. The default header can not be destroyed. Returns:
| {sap.ui.unified.Shell} | this to allow method chaining |
destroyHeadItems(): sap.ui.unified.Shell
Destroys all the headItems in the aggregation
headItems. Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
destroySearch(): sap.ui.unified.Shell
Destroys the search in the aggregation
search. Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
destroyUser(): sap.ui.unified.Shell
Destroys the user in the aggregation
user. - Since:
- 1.22.0
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
getCurtainContent(): sap.ui.core.Control[]
Gets content of aggregation
curtainContent. The content to appear in the curtain area.
Returns:
| {sap.ui.core.Control[]} |
getCurtainPaneContent(): sap.ui.core.Control[]
Gets content of aggregation
curtainPaneContent. The content to appear in the pane area of the curtain.
Returns:
| {sap.ui.core.Control[]} |
getHeadEndItems(): sap.ui.unified.ShellHeadItem[]
Gets content of aggregation
headEndItems. The buttons shown in the end (right in left-to-right case) of the Shell header. Currently max. 3 visible buttons are supported (when user is set only 1). If a custom header is set this aggregation has no effect.
Returns:
| {sap.ui.unified.ShellHeadItem[]} |
getHeadItems(): sap.ui.unified.ShellHeadItem[]
Gets content of aggregation
headItems. The buttons shown in the begin (left in left-to-right case) of the Shell header. Currently max. 3 visible buttons are supported. If a custom header is set this aggregation has no effect.
Returns:
| {sap.ui.unified.ShellHeadItem[]} |
getIcon(): sap.ui.core.URI
Gets current value of property
icon. The application icon. If a custom header is set this property has no effect.
Returns:
| {sap.ui.core.URI} | Value of property icon |
getSearch(): sap.ui.core.Control
Gets content of aggregation
search. Experimental (This aggregation might change in future!): The search control which should be displayed in the shell header. If a custom header is set this aggregation has no effect.
Returns:
| {sap.ui.core.Control} |
getSearchVisible(): boolean
Gets current value of property
searchVisible. If set to false, the search area (aggregation 'search') is hidden. If a custom header is set this property has no effect.
Default value is true.
- Since:
- 1.18
Returns:
| {boolean} | Value of property searchVisible |
getUser(): sap.ui.unified.ShellHeadUserItem
Gets content of aggregation
user. The user item which is rendered in the shell header beside the items. If a custom header is set this aggregation has no effect.
- Since:
- 1.22.0
Returns:
| {sap.ui.unified.ShellHeadUserItem} |
indexOfCurtainContent(oCurtainContent): int
Checks for the provided
sap.ui.core.Control in the aggregation curtainContent. and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.core.Control} | oCurtainContent | The curtainContent whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfCurtainPaneContent(oCurtainPaneContent): int
Checks for the provided
sap.ui.core.Control in the aggregation curtainPaneContent. and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.core.Control} | oCurtainPaneContent | The curtainPaneContent whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfHeadEndItem(oHeadEndItem): int
Checks for the provided
sap.ui.unified.ShellHeadItem in the aggregation headEndItems. and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.unified.ShellHeadItem} | oHeadEndItem | The headEndItem whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfHeadItem(oHeadItem): int
Checks for the provided
sap.ui.unified.ShellHeadItem in the aggregation headItems. and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.unified.ShellHeadItem} | oHeadItem | The headItem whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
insertCurtainContent(oCurtainContent, iIndex): sap.ui.unified.Shell
Inserts a curtainContent into the aggregation
curtainContent. Parameters:
| {sap.ui.core.Control} | oCurtainContent | the curtainContent to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the curtainContent should be inserted at; for a negative value of iIndex, the curtainContent is inserted at position 0; for a value greater than the current size of the aggregation, the curtainContent is inserted at the last position |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
insertCurtainPaneContent(oCurtainPaneContent, iIndex): sap.ui.unified.Shell
Inserts a curtainPaneContent into the aggregation
curtainPaneContent. Parameters:
| {sap.ui.core.Control} | oCurtainPaneContent | the curtainPaneContent to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the curtainPaneContent should be inserted at; for a negative value of iIndex, the curtainPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, the curtainPaneContent is inserted at the last position |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
insertHeadEndItem(oHeadEndItem, iIndex): sap.ui.unified.Shell
Inserts a headEndItem into the aggregation
headEndItems. Parameters:
| {sap.ui.unified.ShellHeadItem} | oHeadEndItem | the headEndItem to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the headEndItem should be inserted at; for a negative value of iIndex, the headEndItem is inserted at position 0; for a value greater than the current size of the aggregation, the headEndItem is inserted at the last position |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
insertHeadItem(oHeadItem, iIndex): sap.ui.unified.Shell
Inserts a headItem into the aggregation
headItems. Parameters:
| {sap.ui.unified.ShellHeadItem} | oHeadItem | the headItem to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the headItem should be inserted at; for a negative value of iIndex, the headItem is inserted at position 0; for a value greater than the current size of the aggregation, the headItem is inserted at the last position |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
removeAllCurtainContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation
curtainContent. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.ui.core.Control[]} | An array of the removed elements (might be empty) |
removeAllCurtainPaneContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation
curtainPaneContent. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.ui.core.Control[]} | An array of the removed elements (might be empty) |
removeAllHeadEndItems(): sap.ui.unified.ShellHeadItem[]
Removes all the controls from the aggregation
headEndItems. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.ui.unified.ShellHeadItem[]} | An array of the removed elements (might be empty) |
removeAllHeadItems(): sap.ui.unified.ShellHeadItem[]
Removes all the controls from the aggregation
headItems. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.ui.unified.ShellHeadItem[]} | An array of the removed elements (might be empty) |
removeCurtainContent(vCurtainContent): sap.ui.core.Control
Removes a curtainContent from the aggregation
curtainContent. Parameters:
| {int|string|sap.ui.core.Control} | vCurtainContent | The curtainContentto remove or its index or id |
Returns:
| {sap.ui.core.Control} | The removed curtainContent or null |
removeCurtainPaneContent(vCurtainPaneContent): sap.ui.core.Control
Removes a curtainPaneContent from the aggregation
curtainPaneContent. Parameters:
| {int|string|sap.ui.core.Control} | vCurtainPaneContent | The curtainPaneContentto remove or its index or id |
Returns:
| {sap.ui.core.Control} | The removed curtainPaneContent or null |
removeHeadEndItem(vHeadEndItem): sap.ui.unified.ShellHeadItem
Removes a headEndItem from the aggregation
headEndItems. Parameters:
| {int|string|sap.ui.unified.ShellHeadItem} | vHeadEndItem | The headEndItemto remove or its index or id |
Returns:
| {sap.ui.unified.ShellHeadItem} | The removed headEndItem or null |
removeHeadItem(vHeadItem): sap.ui.unified.ShellHeadItem
Removes a headItem from the aggregation
headItems. Parameters:
| {int|string|sap.ui.unified.ShellHeadItem} | vHeadItem | The headItemto remove or its index or id |
Returns:
| {sap.ui.unified.ShellHeadItem} | The removed headItem or null |
setHeader(oHeader): sap.ui.unified.Shell
Setter for the aggregated
header. Parameters:
| {sap.ui.core.Control} | oHeader | The Control which should be rendered within the Shell header or null to render the default Shell header. |
Returns:
| {sap.ui.unified.Shell} | this to allow method chaining |
setIcon(sIcon): sap.ui.unified.Shell
Sets a new value for property
icon. The application icon. If a custom header is set this property has no effect.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {sap.ui.core.URI} | sIcon | New value for property icon |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
setSearch(oSearch): sap.ui.unified.Shell
Sets the aggregated
search. Parameters:
| {sap.ui.core.Control} | oSearch | The search to set |
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
setSearchVisible(bSearchVisible): sap.ui.unified.Shell
Sets a new value for property
searchVisible. If set to false, the search area (aggregation 'search') is hidden. If a custom header is set this property has no effect.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bSearchVisible | New value for property searchVisible |
- Since:
- 1.18
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
setUser(oUser): sap.ui.unified.Shell
Sets the aggregated
user. Parameters:
| {sap.ui.unified.ShellHeadUserItem} | oUser | The user to set |
- Since:
- 1.22.0
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
getShowCurtain(): boolean
Gets current value of property
showCurtain. Shows / Hides the curtain.
- Deprecated:
- Since version 1.16.3. Curtain is deprecated and replaced by ShellOverlay mechanism.
Returns:
| {boolean} | Value of property showCurtain |
getShowCurtainPane(): boolean
Gets current value of property
showCurtainPane. Shows / Hides the side pane on the curtain.
- Deprecated:
- Since version 1.16.3. Curtain is deprecated and replaced by ShellOverlay mechanism.
Returns:
| {boolean} | Value of property showCurtainPane |
setShowCurtain(bShowCurtain): sap.ui.unified.Shell
Sets a new value for property
showCurtain. Shows / Hides the curtain.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {boolean} | bShowCurtain | New value for property showCurtain |
- Deprecated:
- Since version 1.16.3. Curtain is deprecated and replaced by ShellOverlay mechanism.
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |
setShowCurtainPane(bShowCurtainPane): sap.ui.unified.Shell
Sets a new value for property
showCurtainPane. Shows / Hides the side pane on the curtain.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {boolean} | bShowCurtainPane | New value for property showCurtainPane |
- Deprecated:
- Since version 1.16.3. Curtain is deprecated and replaced by ShellOverlay mechanism.
Returns:
| {sap.ui.unified.Shell} | Reference to this in order to allow method chaining |