class sap.ui.ux3.Shell

Control sample: sap.ui.ux3.Shell
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/Shell
Application Component: CA-UI5-CTR

The Ux3 GoldReflection Shell, which is an application frame with navigation capabilities. It is supposed to be added to a direct child of the BODY tag of a page and there should be no other parts of the page consuming space outside the Shell.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.ux3.Shell(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


Properties

Name Type Default Value Description
allowOverlayHeaderAccess boolean false

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

Since: 1.14.0.

Visibility: public
appIcon sap.ui.core.URI

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.

Visibility: public
appIconTooltip string

The tooltip of the application icon in the header

Visibility: public
appTitle string

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.

Visibility: public
applyContentPadding boolean true

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

Since: 1.9.0.

Visibility: public
designType sap.ui.ux3.ShellDesignType Standard

Defines which design type is to be used.

Since: 1.12.0.

Visibility: public
fullHeightContent boolean false

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.

Since: 1.9.0.

Visibility: public
headerType sap.ui.ux3.ShellHeaderType Standard

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

Visibility: public
logoutButtonTooltip string

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.

Visibility: public
paneWidth int 250

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).

Visibility: public
showFeederTool boolean true

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

Visibility: public
showInspectorTool boolean false

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

Visibility: public
showLogoutButton boolean true

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

Visibility: public
showPane boolean true

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

Visibility: public
showSearchTool boolean true

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

Visibility: public
showTools boolean true

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

Visibility: public

Aggregations

Default Aggregation: content

Name Cardinality Type Description
_paneOverflowMenu 0..1 sap.ui.commons.Menu

The menu that is shown when there are too many pane-bar entries to fit onto the screen. It is shown after a click on the overflow button that appears in that case.

Since: 1.14.0.

content (default) 0..n sap.ui.core.Control

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.

headerItems 0..n sap.ui.core.Control

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.

notificationBar 0..1 sap.ui.ux3.NotificationBar

The NotificationBar which should be integrated into the Shell.

Since: 1.7.0.

paneBarItems 0..n sap.ui.core.Item

The items to appear in the PaneBar.

paneContent 0..n sap.ui.core.Control

The content to appear in the pane area.

toolPopups 0..n sap.ui.ux3.ToolPopup

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

worksetItems 0..n sap.ui.ux3.NavigationItem

The workset items.


Associations

Name Cardinality Type Description
selectedWorksetItem 0..1 sap.ui.ux3.NavigationItem

The ID of the Item that is currently selected. When setting, the NavigationItem itself can be given instead of its ID. There will not be a worksetItemSelected event, the application is responsible to show the proper content according to the newly selected WorksetItem. If the set WorksetItem does not exist in this Shell, the first item (and first sub-item) will be selected after the call. When getting, always the ID is returned, by which the NavigationItem instance can be retrieved.


Events Overview

Event Description
feedSubmit

Fired when a new feed entry is submitted.

logout

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

paneBarItemSelected

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

paneClosed

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.

Since: 1.12.0.

search

Fired when search has been triggered.

worksetItemSelected

Fired when a workset item was selected by the user. The application may populate the sub-items of the given workset item in the event handler, but this must happen synchronously. If this is done, the application is responsible for displaying the correct content for the selected one of the newly created sub-items. The Shell will currently always mark the first sub-item as selected.

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

feedSubmit

Fired when a new feed entry is submitted.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

logout

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

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

paneBarItemSelected

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

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
id string

The ID of the selected PaneBarItem.

item sap.ui.core.Item

The selected Item

key string

The key of the selected Item (or null if there is no key)

paneClosed

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.

Since: 1.12.0.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
id string

The id of the PaneBarItem to which the closed pane belonged.

search

Fired when search has been triggered.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

worksetItemSelected

Fired when a workset item was selected by the user. The application may populate the sub-items of the given workset item in the event handler, but this must happen synchronously. If this is done, the application is responsible for displaying the correct content for the selected one of the newly created sub-items. The Shell will currently always mark the first sub-item as selected.

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

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
id string

The 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 sap.ui.ux3.NavigationItem

The selected NavigationItem

key string

The key of the selected NavigationItem (or null if there is no key)


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

addHeaderItem

Adds some headerItem to the aggregation headerItems.

addPaneBarItem

Adds some paneBarItem to the aggregation paneBarItems.

addPaneContent

Adds some paneContent to the aggregation paneContent.

addToolPopup

Adds some toolPopup to the aggregation toolPopups.

addWorksetItem

Adds some worksetItem to the aggregation worksetItems.

attachFeedSubmit

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.

attachLogout

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

attachPaneBarItemSelected

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.

attachPaneClosed

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.

attachSearch

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.

attachWorksetItemSelected

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.

Fired when a workset item was selected by the user. The application may populate the sub-items of the given workset item in the event handler, but this must happen synchronously. If this is done, the application is responsible for displaying the correct content for the selected one of the newly created sub-items. The Shell will currently always mark the first sub-item as selected.

closePane

Closes the side Pane (if open).

Returns 'this' to allow method chaining.

destroyContent

Destroys all the content in the aggregation content.

destroyHeaderItems

Destroys all the headerItems in the aggregation headerItems.

destroyNotificationBar

Destroys the notificationBar in the aggregation notificationBar.

destroyPaneBarItems

Destroys all the paneBarItems in the aggregation paneBarItems.

destroyPaneContent

Destroys all the paneContent in the aggregation paneContent.

destroyToolPopups

Destroys all the toolPopups in the aggregation toolPopups.

destroyWorksetItems

Destroys all the worksetItems in the aggregation worksetItems.

detachFeedSubmit

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.

detachLogout

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.

detachPaneBarItemSelected

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.

detachPaneClosed

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.

detachSearch

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.

detachWorksetItemSelected

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.

sap.ui.ux3.Shell.extend

Creates a new subclass of class sap.ui.ux3.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.core.Control.extend.

fireFeedSubmit

Fires event feedSubmit to attached listeners.

fireLogout

Fires event logout to attached listeners.

firePaneBarItemSelected

Fires event paneBarItemSelected to attached listeners.

firePaneClosed

Fires event paneClosed to attached listeners.

fireSearch

Fires event search to attached listeners.

fireWorksetItemSelected

Fires event worksetItemSelected to attached listeners.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object. The return value of this method indicates whether the default action should be executed.

getAllowOverlayHeaderAccess

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.

getAppIcon

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.

getAppIconTooltip

Gets current value of property appIconTooltip.

The tooltip of the application icon in the header

getApplyContentPadding

Gets current value of property applyContentPadding.

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

Default value is true.

getAppTitle

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.

getContent

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.

getDesignType

Gets current value of property designType.

Defines which design type is to be used.

Default value is Standard.

getFullHeightContent

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.

getHeaderItems

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.

getHeaderType

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.

getLogoutButtonTooltip

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.

sap.ui.ux3.Shell.getMetadata

Returns a metadata object for class sap.ui.ux3.Shell.

getNotificationBar

Gets content of aggregation notificationBar.

The NotificationBar which should be integrated into the Shell.

getPaneBarItems

Gets content of aggregation paneBarItems.

The items to appear in the PaneBar.

getPaneContent

Gets content of aggregation paneContent.

The content to appear in the pane area.

getPaneWidth

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.

getSearchField

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

getSelectedWorksetItem

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

getShowFeederTool

Gets current value of property showFeederTool.

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

Default value is true.

getShowInspectorTool

Gets current value of property showInspectorTool.

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

Default value is false.

Since 1.7.2 According to the current Ux designs, the ThingInspector should NOT be opened like this from the Tool Pane. And technically, the ThingInspector is not a ToolPopup. Instead trigger it from the respective elements in the Shell content.
getShowLogoutButton

Gets current value of property showLogoutButton.

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

Default value is true.

getShowPane

Gets current value of property showPane.

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

Default value is true.

getShowSearchTool

Gets current value of property showSearchTool.

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

Default value is true.

getShowTools

Gets current value of property showTools.

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

Default value is true.

getToolPopups

Gets content of aggregation toolPopups.

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

getWorksetItems

Gets content of aggregation worksetItems.

The workset items.

indexOfContent

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

indexOfHeaderItem

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

indexOfPaneBarItem

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

indexOfPaneContent

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

indexOfToolPopup

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

indexOfWorksetItem

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

initializePersonalization

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.

insertContent

Inserts a content into the aggregation content.

insertHeaderItem

Inserts a headerItem into the aggregation headerItems.

insertPaneBarItem

Inserts a paneBarItem into the aggregation paneBarItems.

insertPaneContent

Inserts a paneContent into the aggregation paneContent.

insertToolPopup

Inserts a toolPopup into the aggregation toolPopups.

insertWorksetItem

Inserts a worksetItem into the aggregation worksetItems.

isPaneOpen

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

openPane

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.

openPersonalizationDialog

Experimental method! Do not use!

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllHeaderItems

Removes all the controls from the aggregation headerItems.

Additionally, it unregisters them from the hosting UIArea.

removeAllPaneBarItems

Removes all the controls from the aggregation paneBarItems.

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.

removeAllToolPopups

Removes all the controls from the aggregation toolPopups.

Additionally, it unregisters them from the hosting UIArea.

removeAllWorksetItems

Removes all the controls from the aggregation worksetItems.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

removeHeaderItem

Removes a headerItem from the aggregation headerItems.

removePaneBarItem

Removes a paneBarItem from the aggregation paneBarItems.

removePaneContent

Removes a paneContent from the aggregation paneContent.

removeToolPopup

Removes a toolPopup from the aggregation toolPopups.

removeWorksetItem

Removes a worksetItem from the aggregation worksetItems.

setAllowOverlayHeaderAccess

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.

setAppIcon

Sets a new value for 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.

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

setAppIconTooltip

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.

setApplyContentPadding

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.

setAppTitle

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.

setContent

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.

setDesignType

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.

setFullHeightContent

Sets a new value for 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.

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

Default value is false.

setHeaderType

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.

setLogoutButtonTooltip

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.

setOffsetRight

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.

setPaneContent

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.

setPaneWidth

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.

setSelectedWorksetItem

Sets the associated selectedWorksetItem.

setShowFeederTool

Sets a new value for property showFeederTool.

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

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

Default value is true.

setShowInspectorTool

Sets a new value for property showInspectorTool.

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

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

Default value is false.

Since 1.7.2 According to the current Ux designs, the ThingInspector should NOT be opened like this from the Tool Pane. And technically, the ThingInspector is not a ToolPopup. Instead trigger it from the respective elements in the Shell content.
setShowLogoutButton

Sets a new value for property showLogoutButton.

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

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

Default value is true.

setShowPane

Sets a new value for property showPane.

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

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

Default value is true.

setShowSearchTool

Sets a new value for property showSearchTool.

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

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

Default value is true.

setShowTools

Sets a new value for property showTools.

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

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

Default value is true.

addContent

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

addHeaderItem

Adds some headerItem to the aggregation headerItems.

Param Type DefaultValue Description
oHeaderItem sap.ui.core.Control

The headerItem to add; if empty, nothing is inserted

addPaneBarItem

Adds some paneBarItem to the aggregation paneBarItems.

Param Type DefaultValue Description
oPaneBarItem sap.ui.core.Item

The paneBarItem to add; if empty, nothing is inserted

addPaneContent

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

addToolPopup

Adds some toolPopup to the aggregation toolPopups.

Param Type DefaultValue Description
oToolPopup sap.ui.ux3.ToolPopup

The toolPopup to add; if empty, nothing is inserted

addWorksetItem

Adds some worksetItem to the aggregation worksetItems.

Param Type DefaultValue Description
oWorksetItem sap.ui.ux3.NavigationItem

The worksetItem to add; if empty, nothing is inserted

attachFeedSubmit

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself

attachLogout

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

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself

attachPaneBarItemSelected

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself

attachPaneClosed

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself

attachSearch

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself

attachWorksetItemSelected

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.

Fired when a workset item was selected by the user. The application may populate the sub-items of the given workset item in the event handler, but this must happen synchronously. If this is done, the application is responsible for displaying the correct content for the selected one of the newly created sub-items. The Shell will currently always mark the first sub-item as selected.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself

closePane

Closes the side Pane (if open).

Returns 'this' to allow method chaining.

destroyContent

Destroys all the content in the aggregation content.

destroyHeaderItems

Destroys all the headerItems in the aggregation headerItems.

destroyNotificationBar

Destroys the notificationBar in the aggregation notificationBar.

destroyPaneBarItems

Destroys all the paneBarItems in the aggregation paneBarItems.

destroyPaneContent

Destroys all the paneContent in the aggregation paneContent.

destroyToolPopups

Destroys all the toolPopups in the aggregation toolPopups.

destroyWorksetItems

Destroys all the worksetItems in the aggregation worksetItems.

detachFeedSubmit

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachLogout

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachPaneBarItemSelected

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachPaneClosed

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSearch

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachWorksetItemSelected

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.ux3.Shell.extend

Creates a new subclass of class sap.ui.ux3.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.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

fireFeedSubmit

Fires event feedSubmit to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireLogout

Fires event logout to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

firePaneBarItemSelected

Fires event paneBarItemSelected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

id string

The ID of the selected PaneBarItem.

item sap.ui.core.Item

The selected Item

key string

The key of the selected Item (or null if there is no key)

firePaneClosed

Fires event paneClosed to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

id string

The id of the PaneBarItem to which the closed pane belonged.

fireSearch

Fires event search to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireWorksetItemSelected

Fires event worksetItemSelected to attached listeners.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object. The return value of this method indicates whether the default action should be executed.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

id string

The 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 sap.ui.ux3.NavigationItem

The selected NavigationItem

key string

The key of the selected NavigationItem (or null if there is no key)

getAllowOverlayHeaderAccess

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.

getAppIcon

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.

getAppIconTooltip

Gets current value of property appIconTooltip.

The tooltip of the application icon in the header

getApplyContentPadding

Gets current value of property applyContentPadding.

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

Default value is true.

getAppTitle

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.

getContent

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.

getDesignType

Gets current value of property designType.

Defines which design type is to be used.

Default value is Standard.

getFullHeightContent

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.

getHeaderItems

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.

getHeaderType

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.

getLogoutButtonTooltip

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.

sap.ui.ux3.Shell.getMetadata

Returns a metadata object for class sap.ui.ux3.Shell.

getNotificationBar

Gets content of aggregation notificationBar.

The NotificationBar which should be integrated into the Shell.

getPaneBarItems

Gets content of aggregation paneBarItems.

The items to appear in the PaneBar.

getPaneContent

Gets content of aggregation paneContent.

The content to appear in the pane area.

getPaneWidth

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.

getSearchField

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

getSelectedWorksetItem

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

getShowFeederTool

Gets current value of property showFeederTool.

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

Default value is true.

getShowInspectorTool

Gets current value of property showInspectorTool.

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

Default value is false.

Since 1.7.2 According to the current Ux designs, the ThingInspector should NOT be opened like this from the Tool Pane. And technically, the ThingInspector is not a ToolPopup. Instead trigger it from the respective elements in the Shell content.

getShowLogoutButton

Gets current value of property showLogoutButton.

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

Default value is true.

getShowPane

Gets current value of property showPane.

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

Default value is true.

getShowSearchTool

Gets current value of property showSearchTool.

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

Default value is true.

getShowTools

Gets current value of property showTools.

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

Default value is true.

getToolPopups

Gets content of aggregation toolPopups.

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

getWorksetItems

Gets content of aggregation worksetItems.

The workset items.

indexOfContent

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

indexOfHeaderItem

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

Param Type DefaultValue Description
oHeaderItem sap.ui.core.Control

The headerItem whose index is looked for

indexOfPaneBarItem

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

Param Type DefaultValue Description
oPaneBarItem sap.ui.core.Item

The paneBarItem whose index is looked for

indexOfPaneContent

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

indexOfToolPopup

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

Param Type DefaultValue Description
oToolPopup sap.ui.ux3.ToolPopup

The toolPopup whose index is looked for

indexOfWorksetItem

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

Param Type DefaultValue Description
oWorksetItem sap.ui.ux3.NavigationItem

The worksetItem whose index is looked for

initializePersonalization

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.

Param Type DefaultValue Description
oSettings object

Personalization settings object

insertContent

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 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

insertHeaderItem

Inserts a headerItem into the aggregation headerItems.

Param Type DefaultValue Description
oHeaderItem sap.ui.core.Control

The headerItem to insert; if empty, nothing is inserted

iIndex int

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

insertPaneBarItem

Inserts a paneBarItem into the aggregation paneBarItems.

Param Type DefaultValue Description
oPaneBarItem sap.ui.core.Item

The paneBarItem to insert; if empty, nothing is inserted

iIndex int

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

insertPaneContent

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 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

insertToolPopup

Inserts a toolPopup into the aggregation toolPopups.

Param Type DefaultValue Description
oToolPopup sap.ui.ux3.ToolPopup

The toolPopup to insert; if empty, nothing is inserted

iIndex int

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

insertWorksetItem

Inserts a worksetItem into the aggregation worksetItems.

Param Type DefaultValue Description
oWorksetItem sap.ui.ux3.NavigationItem

The worksetItem to insert; if empty, nothing is inserted

iIndex int

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

isPaneOpen

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

openPane

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.

Param Type DefaultValue Description
sPaneBarItemId string

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

openPersonalizationDialog

Experimental method! Do not use!

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllHeaderItems

Removes all the controls from the aggregation headerItems.

Additionally, it unregisters them from the hosting UIArea.

removeAllPaneBarItems

Removes all the controls from the aggregation paneBarItems.

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.

removeAllToolPopups

Removes all the controls from the aggregation toolPopups.

Additionally, it unregisters them from the hosting UIArea.

removeAllWorksetItems

Removes all the controls from the aggregation worksetItems.

Additionally, it unregisters them from the hosting UIArea.

removeContent

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

removeHeaderItem

Removes a headerItem from the aggregation headerItems.

Param Type DefaultValue Description
vHeaderItem int string sap.ui.core.Control

The headerItem to remove or its index or id

removePaneBarItem

Removes a paneBarItem from the aggregation paneBarItems.

Param Type DefaultValue Description
vPaneBarItem int string sap.ui.core.Item

The paneBarItem to remove or its index or id

removePaneContent

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

removeToolPopup

Removes a toolPopup from the aggregation toolPopups.

Param Type DefaultValue Description
vToolPopup int string sap.ui.ux3.ToolPopup

The toolPopup to remove or its index or id

removeWorksetItem

Removes a worksetItem from the aggregation worksetItems.

Param Type DefaultValue Description
vWorksetItem int string sap.ui.ux3.NavigationItem

The worksetItem to remove or its index or id

setAllowOverlayHeaderAccess

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.

Param Type DefaultValue Description
bAllowOverlayHeaderAccess boolean false

New value for property allowOverlayHeaderAccess

setAppIcon

Sets a new value for 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.

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

Param Type DefaultValue Description
sAppIcon sap.ui.core.URI

New value for property appIcon

setAppIconTooltip

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.

Param Type DefaultValue Description
sAppIconTooltip string

New value for property appIconTooltip

setApplyContentPadding

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.

Param Type DefaultValue Description
bApplyContentPadding boolean true

New value for property applyContentPadding

setAppTitle

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.

Param Type DefaultValue Description
sAppTitle string

New value for property appTitle

setContent

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.

Param Type DefaultValue Description
oContent sap.ui.core.Control

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.

bDestroyOldContent boolean

If set, the controls previously contained in the Shell will be destroyed, to avoid memory leaks.

setDesignType

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.

Param Type DefaultValue Description
sDesignType sap.ui.ux3.ShellDesignType Standard

New value for property designType

setFullHeightContent

Sets a new value for 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.

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
bFullHeightContent boolean false

New value for property fullHeightContent

setHeaderType

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.

Param Type DefaultValue Description
sHeaderType sap.ui.ux3.ShellHeaderType Standard

New value for property headerType

setLogoutButtonTooltip

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.

Param Type DefaultValue Description
sLogoutButtonTooltip string

New value for property logoutButtonTooltip

setOffsetRight

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.

Param Type DefaultValue Description
px int

how many pixels of free space should be next to the Shell (between 0 and 600)

complete function

optional callback function to call after the animation

outerId string

optional id of the content representing the outside sidebar. If specified the width of the content is animated.

setPaneContent

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.

Param Type DefaultValue Description
oContent sap.ui.core.Control

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.

bDestroyOldContent boolean

If set, the controls previously contained in the pane will be destroyed, to avoid memory leaks.

setPaneWidth

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.

Param Type DefaultValue Description
iPaneWidth int 250

New value for property paneWidth

setSelectedWorksetItem

Sets the associated selectedWorksetItem.

Param Type DefaultValue Description
oSelectedWorksetItem sap.ui.core.ID sap.ui.ux3.NavigationItem

ID of an element which becomes the new target of this selectedWorksetItem association; alternatively, an element instance may be given

setShowFeederTool

Sets a new value for property showFeederTool.

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

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
bShowFeederTool boolean true

New value for property showFeederTool

setShowInspectorTool

Sets a new value for property showInspectorTool.

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

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

Default value is false.

Since 1.7.2 According to the current Ux designs, the ThingInspector should NOT be opened like this from the Tool Pane. And technically, the ThingInspector is not a ToolPopup. Instead trigger it from the respective elements in the Shell content.
Param Type DefaultValue Description
bShowInspectorTool boolean false

New value for property showInspectorTool

setShowLogoutButton

Sets a new value for property showLogoutButton.

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

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
bShowLogoutButton boolean true

New value for property showLogoutButton

setShowPane

Sets a new value for property showPane.

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

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
bShowPane boolean true

New value for property showPane

setShowSearchTool

Sets a new value for property showSearchTool.

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

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
bShowSearchTool boolean true

New value for property showSearchTool

setShowTools

Sets a new value for property showTools.

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

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
bShowTools boolean true

New value for property showTools