Class sap.ui.ux3. Shell Module: sap/ui/ux3/Shell

oContent

the content to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

addHeaderItem(oHeaderItem): sap.ui.ux3.Shell

Adds some headerItem to the aggregation headerItems.

Parameters:

oHeaderItem

the headerItem to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

addPaneBarItem(oPaneBarItem): sap.ui.ux3.Shell

Adds some paneBarItem to the aggregation paneBarItems.

Parameters:

{sap.ui.core.Item}

oPaneBarItem

the paneBarItem to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

addPaneContent(oPaneContent): sap.ui.ux3.Shell

Adds some paneContent to the aggregation paneContent.

Parameters:

oPaneContent

the paneContent to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

addToolPopup(oToolPopup): sap.ui.ux3.Shell

Adds some toolPopup to the aggregation toolPopups.

Parameters:

{sap.ui.ux3.ToolPopup}

oToolPopup

the toolPopup to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

addWorksetItem(oWorksetItem): sap.ui.ux3.Shell

Adds some worksetItem to the aggregation worksetItems.

Parameters:

oWorksetItem

the worksetItem to add; if empty, nothing is inserted

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

attachFeedSubmit(oData?, fnFunction, oListener?): sap.ui.ux3.Shell

Attaches event handler fnFunction to the feedSubmit event of this sap.ui.ux3.Shell.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Shell itself.

Fired when a new feed entry is submitted.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.ux3.Shell` itself

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

attachLogout(oData?, fnFunction, oListener?): sap.ui.ux3.Shell

Attaches event handler fnFunction to the logout event of this sap.ui.ux3.Shell.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Shell itself.

Fired when the user clicks the "Log-off" button

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.ux3.Shell` itself

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

attachPaneBarItemSelected(oData?, fnFunction, oListener?): sap.ui.ux3.Shell

Attaches event handler fnFunction to the paneBarItemSelected event of this sap.ui.ux3.Shell.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Shell itself.

An item in the right-hand-side pane bar has been selected, the pane is now visible and can be filled with UI elements.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.ux3.Shell` itself

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

attachPaneClosed(oData?, fnFunction, oListener?): sap.ui.ux3.Shell

Attaches event handler fnFunction to the paneClosed event of this sap.ui.ux3.Shell.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Shell itself.

Fired after a side pane of the shell is closed. It is also fired, when an open pane is closed by calling setShowPane(false), if and only if the pane was opened before.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.ux3.Shell` itself

Since:: 1.12.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

attachSearch(oData?, fnFunction, oListener?): sap.ui.ux3.Shell

Attaches event handler fnFunction to the search event of this sap.ui.ux3.Shell.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Shell itself.

Fired when search has been triggered.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.ux3.Shell` itself

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

attachWorksetItemSelected(oData?, fnFunction, oListener?): sap.ui.ux3.Shell

Attaches event handler fnFunction to the worksetItemSelected event of this sap.ui.ux3.Shell.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Shell itself.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.ux3.Shell` itself

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

closePane(): sap.ui.ux3.Shell

Closes the side Pane (if open).

Returns 'this' to allow method chaining.

Returns:

{sap.ui.ux3.Shell}

destroyContent(): sap.ui.ux3.Shell

Destroys all the content in the aggregation content.

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

destroyHeaderItems(): sap.ui.ux3.Shell

Destroys all the headerItems in the aggregation headerItems.

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

destroyNotificationBar(): sap.ui.ux3.Shell

Destroys the notificationBar in the aggregation notificationBar.

Since:: 1.7.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

destroyPaneBarItems(): sap.ui.ux3.Shell

Destroys all the paneBarItems in the aggregation paneBarItems.

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

destroyPaneContent(): sap.ui.ux3.Shell

Destroys all the paneContent in the aggregation paneContent.

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

destroyToolPopups(): sap.ui.ux3.Shell

Destroys all the toolPopups in the aggregation toolPopups.

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

destroyWorksetItems(): sap.ui.ux3.Shell

Destroys all the worksetItems in the aggregation worksetItems.

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

detachFeedSubmit(fnFunction, oListener): sap.ui.ux3.Shell

Detaches event handler fnFunction from the feedSubmit event of this sap.ui.ux3.Shell.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

detachLogout(fnFunction, oListener): sap.ui.ux3.Shell

Detaches event handler fnFunction from the logout event of this sap.ui.ux3.Shell.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

detachPaneBarItemSelected(fnFunction, oListener): sap.ui.ux3.Shell

Detaches event handler fnFunction from the paneBarItemSelected event of this sap.ui.ux3.Shell.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

detachPaneClosed(fnFunction, oListener): sap.ui.ux3.Shell

Detaches event handler fnFunction from the paneClosed event of this sap.ui.ux3.Shell.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Since:: 1.12.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

detachSearch(fnFunction, oListener): sap.ui.ux3.Shell

Detaches event handler fnFunction from the search event of this sap.ui.ux3.Shell.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

detachWorksetItemSelected(fnFunction, oListener): sap.ui.ux3.Shell

Detaches event handler fnFunction from the worksetItemSelected event of this sap.ui.ux3.Shell.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

fireFeedSubmit(mArguments?): sap.ui.ux3.Shell

Fires event feedSubmit to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

fireLogout(mArguments?): sap.ui.ux3.Shell

Fires event logout to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

firePaneBarItemSelected(mArguments?): sap.ui.ux3.Shell

Fires event paneBarItemSelected to attached listeners.

Expects the following event parameters:

id of type stringThe ID of the selected PaneBarItem.
item of type sap.ui.core.ItemThe selected Item
key of type stringThe key of the selected Item (or null if there is no key)

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

firePaneClosed(mArguments?): sap.ui.ux3.Shell

Fires event paneClosed to attached listeners.

Expects the following event parameters:

id of type stringThe id of the PaneBarItem to which the closed pane belonged.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.12.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

fireSearch(mArguments?): sap.ui.ux3.Shell

Fires event search to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

fireWorksetItemSelected(mArguments?): boolean

Fires event worksetItemSelected to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

id of type stringThe id of the workset item that has been newly selected by the user. If a top-level item has been clicked which has sub-items, the ID of the currently active sub-item (/leaf) is given.
item of type sap.ui.ux3.NavigationItemThe selected NavigationItem
key of type stringThe key of the selected NavigationItem (or null if there is no key)

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{boolean}

Whether or not to prevent the default action

getAllowOverlayHeaderAccess(): boolean

Gets current value of property allowOverlayHeaderAccess.

Whether the Shell header (Title Area + Header Items) can be accessed when an Overlay, OverlayContainer or ThingInspector is open.

Default value is false.

Since:: 1.14.0

Returns:

{boolean} Value of property allowOverlayHeaderAccess

getAppIcon(): sap.ui.core.URI

Gets current value of property appIcon.

The URL of the image to appear in the left part of the header, usually a branding image containing a logo and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first. If the appIcon is set, for accessibility reasons the appIconTooltip must also be set.

Returns:

{sap.ui.core.URI} Value of property appIcon

getAppIconTooltip(): string

Gets current value of property appIconTooltip.

The tooltip of the application icon in the header

Returns:

{string} Value of property appIconTooltip

getApplyContentPadding(): boolean

Gets current value of property applyContentPadding.

Whether the Shell content area should have a theme-dependent padding or not.

Default value is true.

Since:: 1.9.0

Returns:

{boolean} Value of property applyContentPadding

getAppTitle(): string

Gets current value of property appTitle.

The application title to appear in the left part of the header, usually a company and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first.

Returns:

{string} Value of property appTitle

getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The content to appear in the main canvas. Each modification of this aggregation leads to a re-rendering of the content area - but not to a re-rendering of the complete Shell.

Returns:

getDesignType(): sap.ui.ux3.ShellDesignType

Gets current value of property designType.

Defines which design type is to be used.

Default value is Standard.

Since:: 1.12.0

Returns:

{sap.ui.ux3.ShellDesignType} Value of property designType

getFullHeightContent(): boolean

Gets current value of property fullHeightContent.

If set to true, the content area has a defined height. This means that any content put inside can use "100%" height in CSS and will then consume all available space. However, if content is larger, scrollbars will appear at the content area of the Shell and not on window level.

Default value is false.

Since:: 1.9.0

Returns:

{boolean} Value of property fullHeightContent

getHeaderItems(): sap.ui.core.Control[]

Gets content of aggregation headerItems.

Controls to appear in the header next to the logout button. It is recommended to only use controls of type Button, MenuButton and TextView. The respective UI guidelines need to be enforced on a higher level.

Returns:

{sap.ui.ux3.NotificationBar}

getHeaderType(): sap.ui.ux3.ShellHeaderType

Gets current value of property headerType.

Defines which header type to be used. Depending on the header type some other functionality might be obsolete.

Default value is Standard.

Returns:

{sap.ui.ux3.ShellHeaderType} Value of property headerType

getLogoutButtonTooltip(): string

Gets current value of property logoutButtonTooltip.

The tooltip to be displayed for the Logout Button of the Shell. If not set, a text meaning "Logout" in the current language will be displayed.

Since:: 1.9.0

Returns:

{string} Value of property logoutButtonTooltip

getNotificationBar(): sap.ui.ux3.NotificationBar

Gets content of aggregation notificationBar.

The NotificationBar which should be integrated into the Shell.

Since:: 1.7.0

Returns:

getPaneBarItems(): sap.ui.core.Item[]

Gets content of aggregation paneBarItems.

The items to appear in the PaneBar.

Returns:

{sap.ui.core.Item[]}

getPaneContent(): sap.ui.core.Control[]

Gets content of aggregation paneContent.

The content to appear in the pane area.

Returns:

{sap.ui.commons.SearchField}

getPaneWidth(): int

Gets current value of property paneWidth.

The width of the right-hand side pane in pixels. The value must be a non-negative integer. The Shell reserves the right to define a minimum width (currently 50px).

Default value is 250.

Returns:

{int} Value of property paneWidth

getSearchField(): sap.ui.commons.SearchField

Returns the SearchField control which is used in the Search Tool.

Returns:

getSelectedWorksetItem(): sap.ui.ux3.NavigationItem

ID of the element which is the current target of the association selectedWorksetItem, or null.

Returns:

getShowFeederTool(): boolean

Gets current value of property showFeederTool.

Whether the "Feeder" tool should be displayed or not.

Default value is true.

Returns:

{boolean} Value of property showFeederTool

getShowLogoutButton(): boolean

Gets current value of property showLogoutButton.

Whether the Logoff button in the header should be displayed or not.

Default value is true.

Returns:

{boolean} Value of property showLogoutButton

getShowPane(): boolean

Gets current value of property showPane.

Whether the pane bar should be displayed at all or not.

Default value is true.

Returns:

{boolean} Value of property showPane

getShowSearchTool(): boolean

Gets current value of property showSearchTool.

Whether the "Global Search" tool should be displayed or not.

Default value is true.

Returns:

{boolean} Value of property showSearchTool

getShowTools(): boolean

Gets current value of property showTools.

Whether the tool area should be displayed at all or not.

Default value is true.

Returns:

{boolean} Value of property showTools

getToolPopups(): sap.ui.ux3.ToolPopup[]

Gets content of aggregation toolPopups.

The items which appear in the ToolPalette and are opened as popup when clicked.

Returns:

{sap.ui.ux3.ToolPopup[]}

getWorksetItems(): sap.ui.ux3.NavigationItem[]

Gets content of aggregation worksetItems.

The workset items.

Returns:

{sap.ui.ux3.NavigationItem[]}

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:

oContent

The content whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfHeaderItem(oHeaderItem): int

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

Parameters:

oHeaderItem

The headerItem whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfPaneBarItem(oPaneBarItem): int

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

Parameters:

{sap.ui.core.Item}

oPaneBarItem

The paneBarItem 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:

oPaneContent

The paneContent whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfToolPopup(oToolPopup): int

Checks for the provided sap.ui.ux3.ToolPopup in the aggregation toolPopups. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.ux3.ToolPopup}

oToolPopup

The toolPopup whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfWorksetItem(oWorksetItem): int

Checks for the provided sap.ui.ux3.NavigationItem in the aggregation worksetItems. and returns its index if found or -1 otherwise.

Parameters:

oWorksetItem

The worksetItem whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

initializePersonalization(oSettings): void

Experimental method! Do not use!

Makes Shell personalization available and injects the given personalization settings. This should be called before the user can do any adaptations per drag&drop or using the personalization dialog. Otherwise it may override the user's new settings.

Parameters:

{object}

oSettings

Personalization settings object

insertContent(oContent, iIndex): sap.ui.ux3.Shell

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.ux3.Shell} Reference to this in order to allow method chaining

insertHeaderItem(oHeaderItem, iIndex): sap.ui.ux3.Shell

Inserts a headerItem into the aggregation headerItems.

Parameters:

{sap.ui.core.Control}	oHeaderItem	the headerItem to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the headerItem should be inserted at; for a negative value of `iIndex`, the headerItem is inserted at position 0; for a value greater than the current size of the aggregation, the headerItem is inserted at the last position

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

insertPaneBarItem(oPaneBarItem, iIndex): sap.ui.ux3.Shell

Inserts a paneBarItem into the aggregation paneBarItems.

Parameters:

{sap.ui.core.Item}	oPaneBarItem	the paneBarItem to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the paneBarItem should be inserted at; for a negative value of `iIndex`, the paneBarItem is inserted at position 0; for a value greater than the current size of the aggregation, the paneBarItem is inserted at the last position

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

insertPaneContent(oPaneContent, iIndex): sap.ui.ux3.Shell

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.ux3.Shell} Reference to this in order to allow method chaining

insertToolPopup(oToolPopup, iIndex): sap.ui.ux3.Shell

Inserts a toolPopup into the aggregation toolPopups.

Parameters:

{sap.ui.ux3.ToolPopup}	oToolPopup	the toolPopup to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the toolPopup should be inserted at; for a negative value of `iIndex`, the toolPopup is inserted at position 0; for a value greater than the current size of the aggregation, the toolPopup is inserted at the last position

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

insertWorksetItem(oWorksetItem, iIndex): sap.ui.ux3.Shell

Inserts a worksetItem into the aggregation worksetItems.

Parameters:

{sap.ui.ux3.NavigationItem}	oWorksetItem	the worksetItem to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the worksetItem should be inserted at; for a negative value of `iIndex`, the worksetItem is inserted at position 0; for a value greater than the current size of the aggregation, the worksetItem is inserted at the last position

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

isPaneOpen(): boolean

Returns 'true' if the side Pane is currently open.

Returns:

{boolean}

openPane(sPaneBarItemId): sap.ui.ux3.Shell

Opens the side Pane.

A valid ID of a paneBarItem must be given, so this item can be marked as selected. A "paneBarItemSelected" event is then fired as if the opening was triggered by the user by a click on the respective PaneBarItem. This method can be called (with different IDs) even when the Pane is already open. It has then the same effect as if the user switches between PaneBarItems.

Returns 'this' to allow method chaining.

Parameters:

{string}

sPaneBarItemId

The ID of the PaneBarItem which should be marked as selected.

Returns:

{sap.ui.ux3.Shell}

openPersonalizationDialog(): void

Experimental method! Do not use!

removeAllContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:

An array of the removed elements (might be empty)

removeAllHeaderItems(): sap.ui.core.Control[]

Removes all the controls from the aggregation headerItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:

An array of the removed elements (might be empty)

removeAllPaneBarItems(): sap.ui.core.Item[]

Removes all the controls from the aggregation paneBarItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.core.Item[]}

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:

An array of the removed elements (might be empty)

removeAllToolPopups(): sap.ui.ux3.ToolPopup[]

Removes all the controls from the aggregation toolPopups.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.ux3.ToolPopup[]}

An array of the removed elements (might be empty)

removeAllWorksetItems(): sap.ui.ux3.NavigationItem[]

Removes all the controls from the aggregation worksetItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.ux3.NavigationItem[]}

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

removeHeaderItem(vHeaderItem): sap.ui.core.Control

Removes a headerItem from the aggregation headerItems.

Parameters:

{int|string|sap.ui.core.Control}

vHeaderItem

The headerItemto remove or its index or id

Returns:

{sap.ui.core.Control} The removed headerItem or null

removePaneBarItem(vPaneBarItem): sap.ui.core.Item

Removes a paneBarItem from the aggregation paneBarItems.

Parameters:

{int|string|sap.ui.core.Item}

vPaneBarItem

The paneBarItemto remove or its index or id

Returns:

{sap.ui.core.Item} The removed paneBarItem 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

removeToolPopup(vToolPopup): sap.ui.ux3.ToolPopup

Removes a toolPopup from the aggregation toolPopups.

Parameters:

{int|string|sap.ui.ux3.ToolPopup}

vToolPopup

The toolPopupto remove or its index or id

Returns:

{sap.ui.ux3.ToolPopup} The removed toolPopup or null

removeWorksetItem(vWorksetItem): sap.ui.ux3.NavigationItem

Removes a worksetItem from the aggregation worksetItems.

Parameters:

{int|string|sap.ui.ux3.NavigationItem}

vWorksetItem

The worksetItemto remove or its index or id

Returns:

{sap.ui.ux3.NavigationItem} The removed worksetItem or null

setAllowOverlayHeaderAccess(bAllowOverlayHeaderAccess): sap.ui.ux3.Shell

Sets a new value for property allowOverlayHeaderAccess.

Whether the Shell header (Title Area + Header Items) can be accessed when an Overlay, OverlayContainer or ThingInspector is open.

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

Default value is false.

Parameters:

{boolean} bAllowOverlayHeaderAccess New value for property allowOverlayHeaderAccess

Since:: 1.14.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setAppIcon(sAppIcon): sap.ui.ux3.Shell

Sets a new value for property appIcon.

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

Parameters:

{sap.ui.core.URI} sAppIcon New value for property appIcon

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setAppIconTooltip(sAppIconTooltip): sap.ui.ux3.Shell

Sets a new value for property appIconTooltip.

The tooltip of the application icon in the header

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

Parameters:

{string} sAppIconTooltip New value for property appIconTooltip

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setApplyContentPadding(bApplyContentPadding): sap.ui.ux3.Shell

Sets a new value for property applyContentPadding.

Whether the Shell content area should have a theme-dependent padding or not.

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

Default value is true.

Parameters:

{boolean} bApplyContentPadding New value for property applyContentPadding

Since:: 1.9.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setAppTitle(sAppTitle): sap.ui.ux3.Shell

Sets a new value for property appTitle.

The application title to appear in the left part of the header, usually a company and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first.

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

Parameters:

{string} sAppTitle New value for property appTitle

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setContent(oContent, bDestroyOldContent): sap.ui.core.Control[]

Replaces the existing Shell content with the given Control(-Tree). Only leads to a re-rendering of the content area (not the complete Shell). This method may be more convenient than a series of calls to "removeContent" and "addContent", which each lead to a re-rendering of the content area (but again not of the complete Shell).

By default the old content is not destroyed and is returned by this method in an array for further usage. To avoid memory leaks, the old content should be destroyed (if not needed later), by setting the "destroyOldContent" flag or by destroying it manually later on. If "destroyOldContent" is set, an empty array is returned.

Parameters:

{sap.ui.core.Control}	oContent	The new Content. In this method it must be exactly one control (-tree). Use addContent() to add more control (-trees) to the main content area of the Shell.
{boolean}	bDestroyOldContent	If set, the controls previously contained in the Shell will be destroyed, to avoid memory leaks.

Returns:

setDesignType(sDesignType): sap.ui.ux3.Shell

Sets a new value for property designType.

Defines which design type is to be used.

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

Default value is Standard.

Parameters:

{sap.ui.ux3.ShellDesignType} sDesignType New value for property designType

Since:: 1.12.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setFullHeightContent(bFullHeightContent): sap.ui.ux3.Shell

Sets a new value for property fullHeightContent.

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

Default value is false.

Parameters:

{boolean} bFullHeightContent New value for property fullHeightContent

Since:: 1.9.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setHeaderType(sHeaderType): sap.ui.ux3.Shell

Sets a new value for property headerType.

Defines which header type to be used. Depending on the header type some other functionality might be obsolete.

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

Default value is Standard.

Parameters:

{sap.ui.ux3.ShellHeaderType} sHeaderType New value for property headerType

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setLogoutButtonTooltip(sLogoutButtonTooltip): sap.ui.ux3.Shell

Sets a new value for property logoutButtonTooltip.

The tooltip to be displayed for the Logout Button of the Shell. If not set, a text meaning "Logout" in the current language will be displayed.

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

Parameters:

{string} sLogoutButtonTooltip New value for property logoutButtonTooltip

Since:: 1.9.0

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setOffsetRight(px, complete?, outerId?)

Moves the complete Shell away from the right window border by the given number of pixels (left border in RTL case).

So there is space for a sidebar or so outside the Shell. The CSS class 'sapUiUx3ShellOuterSideBar' provides the basic position capabilities for the sidebar DOM element.

This feature is not public. The usage is only granted to special groups on request.

Parameters:

{int}	px	how many pixels of free space should be next to the Shell (between 0 and 600)
{function}	complete?	optional callback function to call after the animation
{string}	outerId?	optional id of the content representing the outside sidebar. If specified the width of the content is animated.

Since:: 1.7.0

setPaneContent(oContent, bDestroyOldContent): sap.ui.core.Control[]

Replaces the existing side pane content with the given Control(-Tree). This method is optimized to only re-render the pane content (and not the shell) which is faster and smoother than any other way of changing the "paneContent" aggregation.

By default, the old pane content is not destroyed and is returned by this method in an array for further usage. To avoid memory leaks, the old content should be destroyed (if not needed later), by setting the "destroyOldContent" flag or by destroying it manually later on. If "destroyOldContent" is set, an empty array is returned.

Parameters:

{sap.ui.core.Control}	oContent	The new Pane content. In this method it must be exactly one control (-tree). This could likely be a layout or a specific ux3 Pane control. Use addPaneContent() to add more control (-trees) to the Pane.
{boolean}	bDestroyOldContent	If set, the controls previously contained in the pane will be destroyed, to avoid memory leaks.

Returns:

setPaneWidth(iPaneWidth): sap.ui.ux3.Shell

Sets a new value for property paneWidth.

The width of the right-hand side pane in pixels. The value must be a non-negative integer. The Shell reserves the right to define a minimum width (currently 50px).

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

Default value is 250.

Parameters:

{int} iPaneWidth New value for property paneWidth

Returns:

{sap.ui.ux3.Shell} Reference to this in order to allow method chaining

setSelectedWorksetItem(oSelectedWorksetItem): sap.ui.ux3.Shell

Sets the associated selectedWorksetItem.

Parameters: