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

extends Control

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.
Deprecated API:
Since version 1.38.
Constructor Summary
new sap.ui.ux3.Shell(sId?, mSettings?)Constructor for a new Shell.
Event Summary
feedSubmit(oControlEvent)Fired when a new feed entry is submitted.
logout(oControlEvent)Fired when the user clicks the "Log-off" button
paneBarItemSelected(oControlEvent)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(oControlEvent)Fired after a side pane of the shell is closed.
search(oControlEvent)Fired when search has been triggered.
worksetItemSelected(oControlEvent)Fired when a workset item was selected by the user.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.Shell.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.Shell with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.Shell.getMetadata()Returns a metadata object for class sap.ui.ux3.Shell.
addContent(oContent)Adds some content to the aggregation content.
addHeaderItem(oHeaderItem)Adds some headerItem to the aggregation headerItems.
addPaneBarItem(oPaneBarItem)Adds some paneBarItem to the aggregation paneBarItems.
addPaneContent(oPaneContent)Adds some paneContent to the aggregation paneContent.
addToolPopup(oToolPopup)Adds some toolPopup to the aggregation toolPopups.
addWorksetItem(oWorksetItem)Adds some worksetItem to the aggregation worksetItems.
attachFeedSubmit(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the feedSubmit event of this sap.ui.ux3.Shell.
attachLogout(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the logout event of this sap.ui.ux3.Shell.
attachPaneBarItemSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the paneBarItemSelected event of this sap.ui.ux3.Shell.
attachPaneClosed(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the paneClosed event of this sap.ui.ux3.Shell.
attachSearch(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the search event of this sap.ui.ux3.Shell.
attachWorksetItemSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the worksetItemSelected event of this sap.ui.ux3.Shell.
closePane()Closes the side Pane (if open).
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(fnFunction, oListener)Detaches event handler fnFunction from the feedSubmit event of this sap.ui.ux3.Shell.
detachLogout(fnFunction, oListener)Detaches event handler fnFunction from the logout event of this sap.ui.ux3.Shell.
detachPaneBarItemSelected(fnFunction, oListener)Detaches event handler fnFunction from the paneBarItemSelected event of this sap.ui.ux3.Shell.
detachPaneClosed(fnFunction, oListener)Detaches event handler fnFunction from the paneClosed event of this sap.ui.ux3.Shell.
detachSearch(fnFunction, oListener)Detaches event handler fnFunction from the search event of this sap.ui.ux3.Shell.
detachWorksetItemSelected(fnFunction, oListener)Detaches event handler fnFunction from the worksetItemSelected event of this sap.ui.ux3.Shell.
fireFeedSubmit(mParameters?)Fires event feedSubmit to attached listeners.
fireLogout(mParameters?)Fires event logout to attached listeners.
firePaneBarItemSelected(mParameters?)Fires event paneBarItemSelected to attached listeners.
firePaneClosed(mParameters?)Fires event paneClosed to attached listeners.
fireSearch(mParameters?)Fires event search to attached listeners.
fireWorksetItemSelected(mParameters?)Fires event worksetItemSelected to attached listeners.
getAllowOverlayHeaderAccess()Gets current value of property allowOverlayHeaderAccess.
getAppIcon()Gets current value of property appIcon.
getAppIconTooltip()Gets current value of property appIconTooltip.
getApplyContentPadding()Gets current value of property applyContentPadding.
getAppTitle()Gets current value of property appTitle.
getContent()Gets content of aggregation content.
getDesignType()Gets current value of property designType.
getFullHeightContent()Gets current value of property fullHeightContent.
getHeaderItems()Gets content of aggregation headerItems.
getHeaderType()Gets current value of property headerType.
getLogoutButtonTooltip()Gets current value of property logoutButtonTooltip.
getNotificationBar()Gets content of aggregation notificationBar.
getPaneBarItems()Gets content of aggregation paneBarItems.
getPaneContent()Gets content of aggregation paneContent.
getPaneWidth()Gets current value of property paneWidth.
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.
getShowLogoutButton()Gets current value of property showLogoutButton.
getShowPane()Gets current value of property showPane.
getShowSearchTool()Gets current value of property showSearchTool.
getShowTools()Gets current value of property showTools.
getToolPopups()Gets content of aggregation toolPopups.
getWorksetItems()Gets content of aggregation worksetItems.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
indexOfHeaderItem(oHeaderItem)Checks for the provided sap.ui.core.Control in the aggregation headerItems.
indexOfPaneBarItem(oPaneBarItem)Checks for the provided sap.ui.core.Item in the aggregation paneBarItems.
indexOfPaneContent(oPaneContent)Checks for the provided sap.ui.core.Control in the aggregation paneContent.
indexOfToolPopup(oToolPopup)Checks for the provided sap.ui.ux3.ToolPopup in the aggregation toolPopups.
indexOfWorksetItem(oWorksetItem)Checks for the provided sap.ui.ux3.NavigationItem in the aggregation worksetItems.
initializePersonalization(oSettings)Experimental method! Do not use! Makes Shell personalization available and injects the given personalization settings.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
insertHeaderItem(oHeaderItem, iIndex)Inserts a headerItem into the aggregation headerItems.
insertPaneBarItem(oPaneBarItem, iIndex)Inserts a paneBarItem into the aggregation paneBarItems.
insertPaneContent(oPaneContent, iIndex)Inserts a paneContent into the aggregation paneContent.
insertToolPopup(oToolPopup, iIndex)Inserts a toolPopup into the aggregation toolPopups.
insertWorksetItem(oWorksetItem, iIndex)Inserts a worksetItem into the aggregation worksetItems.
isPaneOpen()Returns 'true' if the side Pane is currently open.
openPane(sPaneBarItemId)Opens the side Pane.
openPersonalizationDialog()Experimental method! Do not use!
removeAllContent()Removes all the controls from the aggregation content.
removeAllHeaderItems()Removes all the controls from the aggregation headerItems.
removeAllPaneBarItems()Removes all the controls from the aggregation paneBarItems.
removeAllPaneContent()Removes all the controls from the aggregation paneContent.
removeAllToolPopups()Removes all the controls from the aggregation toolPopups.
removeAllWorksetItems()Removes all the controls from the aggregation worksetItems.
removeContent(vContent)Removes a content from the aggregation content.
removeHeaderItem(vHeaderItem)Removes a headerItem from the aggregation headerItems.
removePaneBarItem(vPaneBarItem)Removes a paneBarItem from the aggregation paneBarItems.
removePaneContent(vPaneContent)Removes a paneContent from the aggregation paneContent.
removeToolPopup(vToolPopup)Removes a toolPopup from the aggregation toolPopups.
removeWorksetItem(vWorksetItem)Removes a worksetItem from the aggregation worksetItems.
setAllowOverlayHeaderAccess(bAllowOverlayHeaderAccess)Sets a new value for property allowOverlayHeaderAccess.
setAppIcon(sAppIcon)Sets a new value for property appIcon.
setAppIconTooltip(sAppIconTooltip)Sets a new value for property appIconTooltip.
setApplyContentPadding(bApplyContentPadding)Sets a new value for property applyContentPadding.
setAppTitle(sAppTitle)Sets a new value for property appTitle.
setContent(oContent, bDestroyOldContent)Replaces the existing Shell content with the given Control(-Tree).
setDesignType(sDesignType)Sets a new value for property designType.
setFullHeightContent(bFullHeightContent)Sets a new value for property fullHeightContent.
setHeaderType(sHeaderType)Sets a new value for property headerType.
setLogoutButtonTooltip(sLogoutButtonTooltip)Sets a new value for property logoutButtonTooltip.
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).
setPaneContent(oContent, bDestroyOldContent)Replaces the existing side pane content with the given Control(-Tree).
setPaneWidth(iPaneWidth)Sets a new value for property paneWidth.
setSelectedWorksetItem(oSelectedWorksetItem)Sets the associated selectedWorksetItem.
setShowFeederTool(bShowFeederTool)Sets a new value for property showFeederTool.
setShowLogoutButton(bShowLogoutButton)Sets a new value for property showLogoutButton.
setShowPane(bShowPane)Sets a new value for property showPane.
setShowSearchTool(bShowSearchTool)Sets a new value for property showSearchTool.
setShowTools(bShowTools)Sets a new value for property showTools.
getShowInspectorTool()Gets current value of property showInspectorTool.
setShowInspectorTool(bShowInspectorTool)Sets a new value for property showInspectorTool.
Constructor Detail
new sap.ui.ux3.Shell(sId?, mSettings?)

Constructor for a new Shell.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
feedSubmit(oControlEvent)
Fired when a new feed entry is submitted.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
logout(oControlEvent)
Fired when the user clicks the "Log-off" button
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
paneBarItemSelected(oControlEvent)
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:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.idThe ID of the selected PaneBarItem.
sap.ui.core.ItemoControlEvent.getParameters.itemThe selected Item
stringoControlEvent.getParameters.keyThe key of the selected Item (or null if there is no key)
paneClosed(oControlEvent)
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:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.idThe id of the PaneBarItem to which the closed pane belonged.
Since:
1.12.0
search(oControlEvent)
Fired when search has been triggered.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
worksetItemSelected(oControlEvent)
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.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.idThe 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.
sap.ui.ux3.NavigationItemoControlEvent.getParameters.itemThe selected NavigationItem
stringoControlEvent.getParameters.keyThe key of the selected NavigationItem (or null if there is no key)
Method Detail
sap.ui.ux3.Shell.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.ux3.Shell.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.Shell.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addContent(oContent): sap.ui.ux3.Shell
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
addHeaderItem(oHeaderItem): sap.ui.ux3.Shell
Adds some headerItem to the aggregation headerItems.
Parameters:
sap.ui.core.ControloHeaderItemthe headerItem to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ShellReference 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.ItemoPaneBarItemthe paneBarItem to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
addPaneContent(oPaneContent): sap.ui.ux3.Shell
Adds some paneContent to the aggregation paneContent.
Parameters:
sap.ui.core.ControloPaneContentthe paneContent to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ShellReference 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.ToolPopupoToolPopupthe toolPopup to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
addWorksetItem(oWorksetItem): sap.ui.ux3.Shell
Adds some worksetItem to the aggregation worksetItems.
Parameters:
sap.ui.ux3.NavigationItemoWorksetItemthe worksetItem to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ShellReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself
Returns:
sap.ui.ux3.ShellReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself
Returns:
sap.ui.ux3.ShellReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself
Returns:
sap.ui.ux3.ShellReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.12.0
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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself
Returns:
sap.ui.ux3.ShellReference 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.

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.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell itself
Returns:
sap.ui.ux3.ShellReference 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.ShellReference 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.ShellReference to this in order to allow method chaining
destroyNotificationBar(): sap.ui.ux3.Shell
Destroys the notificationBar in the aggregation notificationBar.
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.7.0
destroyPaneBarItems(): sap.ui.ux3.Shell
Destroys all the paneBarItems in the aggregation paneBarItems.
Returns:
sap.ui.ux3.ShellReference 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.ShellReference 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.ShellReference 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.ShellReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ShellReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ShellReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ShellReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.12.0
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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ShellReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
fireFeedSubmit(mParameters?): sap.ui.ux3.Shell
Fires event feedSubmit to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
fireLogout(mParameters?): sap.ui.ux3.Shell
Fires event logout to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
firePaneBarItemSelected(mParameters?): sap.ui.ux3.Shell
Fires event paneBarItemSelected to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.id?The ID of the selected PaneBarItem.
sap.ui.core.ItemmParameters.item?The selected Item
stringmParameters.key?The key of the selected Item (or null if there is no key)
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
firePaneClosed(mParameters?): sap.ui.ux3.Shell
Fires event paneClosed to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.id?The id of the PaneBarItem to which the closed pane belonged.
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.12.0
fireSearch(mParameters?): sap.ui.ux3.Shell
Fires event search to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
fireWorksetItemSelected(mParameters?): 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.

Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.id?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.
sap.ui.ux3.NavigationItemmParameters.item?The selected NavigationItem
stringmParameters.key?The key of the selected NavigationItem (or null if there is no key)
Returns:
booleanWhether 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.

Returns:
booleanValue of property allowOverlayHeaderAccess
Since:
1.14.0
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.URIValue of property appIcon
getAppIconTooltip(): string

Gets current value of property appIconTooltip.

The tooltip of the application icon in the header

Returns:
stringValue 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.

Returns:
booleanValue of property applyContentPadding
Since:
1.9.0
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:
stringValue 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:
sap.ui.core.Control[]
getDesignType(): sap.ui.ux3.ShellDesignType

Gets current value of property designType.

Defines which design type is to be used.

Default value is Standard.

Returns:
sap.ui.ux3.ShellDesignTypeValue of property designType
Since:
1.12.0
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.

Returns:
booleanValue of property fullHeightContent
Since:
1.9.0
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.core.Control[]
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.ShellHeaderTypeValue 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.

Returns:
stringValue of property logoutButtonTooltip
Since:
1.9.0
getNotificationBar(): sap.ui.ux3.NotificationBar

Gets content of aggregation notificationBar.

The NotificationBar which should be integrated into the Shell.

Returns:
sap.ui.ux3.NotificationBar
Since:
1.7.0
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.core.Control[]
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:
intValue of property paneWidth
getSearchField(): sap.ui.commons.SearchField
Returns the SearchField control which is used in the Search Tool.
Returns:
sap.ui.commons.SearchField
getSelectedWorksetItem(): sap.ui.core.ID
ID of the element which is the current target of the association selectedWorksetItem, or null.
Returns:
sap.ui.core.ID
getShowFeederTool(): boolean

Gets current value of property showFeederTool.

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

Default value is true.

Returns:
booleanValue 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:
booleanValue 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:
booleanValue 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:
booleanValue 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:
booleanValue 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:
sap.ui.core.ControloContentThe content whose index is looked for
Returns:
intThe 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:
sap.ui.core.ControloHeaderItemThe headerItem whose index is looked for
Returns:
intThe 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.ItemoPaneBarItemThe paneBarItem whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfPaneContent(oPaneContent): int
Checks for the provided sap.ui.core.Control in the aggregation paneContent. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloPaneContentThe paneContent whose index is looked for
Returns:
intThe 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.ToolPopupoToolPopupThe toolPopup whose index is looked for
Returns:
intThe 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:
sap.ui.ux3.NavigationItemoWorksetItemThe worksetItem whose index is looked for
Returns:
intThe 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:
objectoSettingsPersonalization settings object
insertContent(oContent, iIndex): sap.ui.ux3.Shell
Inserts a content into the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 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.ShellReference 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.ControloHeaderItemthe headerItem to insert; if empty, nothing is inserted
intiIndexthe 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.ShellReference 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.ItemoPaneBarItemthe paneBarItem to insert; if empty, nothing is inserted
intiIndexthe 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.ShellReference 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.ControloPaneContentthe paneContent to insert; if empty, nothing is inserted
intiIndexthe 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.ShellReference 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.ToolPopupoToolPopupthe toolPopup to insert; if empty, nothing is inserted
intiIndexthe 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.ShellReference 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.NavigationItemoWorksetItemthe worksetItem to insert; if empty, nothing is inserted
intiIndexthe 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.ShellReference 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:
stringsPaneBarItemIdThe 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:
sap.ui.core.Control[]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:
sap.ui.core.Control[]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:
sap.ui.core.Control[]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.ControlvContentThe content to remove or its index or id
Returns:
sap.ui.core.ControlThe removed content or null
removeHeaderItem(vHeaderItem): sap.ui.core.Control
Removes a headerItem from the aggregation headerItems.
Parameters:
int|string|sap.ui.core.ControlvHeaderItemThe headerItem to remove or its index or id
Returns:
sap.ui.core.ControlThe removed headerItem or null
removePaneBarItem(vPaneBarItem): sap.ui.core.Item
Removes a paneBarItem from the aggregation paneBarItems.
Parameters:
int|string|sap.ui.core.ItemvPaneBarItemThe paneBarItem to remove or its index or id
Returns:
sap.ui.core.ItemThe removed paneBarItem or null
removePaneContent(vPaneContent): sap.ui.core.Control
Removes a paneContent from the aggregation paneContent.
Parameters:
int|string|sap.ui.core.ControlvPaneContentThe paneContent to remove or its index or id
Returns:
sap.ui.core.ControlThe removed paneContent or null
removeToolPopup(vToolPopup): sap.ui.ux3.ToolPopup
Removes a toolPopup from the aggregation toolPopups.
Parameters:
int|string|sap.ui.ux3.ToolPopupvToolPopupThe toolPopup to remove or its index or id
Returns:
sap.ui.ux3.ToolPopupThe removed toolPopup or null
removeWorksetItem(vWorksetItem): sap.ui.ux3.NavigationItem
Removes a worksetItem from the aggregation worksetItems.
Parameters:
int|string|sap.ui.ux3.NavigationItemvWorksetItemThe worksetItem to remove or its index or id
Returns:
sap.ui.ux3.NavigationItemThe 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:
booleanbAllowOverlayHeaderAccessNew value for property allowOverlayHeaderAccess
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.14.0
setAppIcon(sAppIcon): sap.ui.ux3.Shell

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.

Parameters:
sap.ui.core.URIsAppIconNew value for property appIcon
Returns:
sap.ui.ux3.ShellReference 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:
stringsAppIconTooltipNew value for property appIconTooltip
Returns:
sap.ui.ux3.ShellReference 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:
booleanbApplyContentPaddingNew value for property applyContentPadding
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.9.0
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:
stringsAppTitleNew value for property appTitle
Returns:
sap.ui.ux3.ShellReference 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.ControloContentThe 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.
booleanbDestroyOldContentIf set, the controls previously contained in the Shell will be destroyed, to avoid memory leaks.
Returns:
sap.ui.core.Control[]
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.ShellDesignTypesDesignTypeNew value for property designType
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.12.0
setFullHeightContent(bFullHeightContent): sap.ui.ux3.Shell

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.

Parameters:
booleanbFullHeightContentNew value for property fullHeightContent
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.9.0
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.ShellHeaderTypesHeaderTypeNew value for property headerType
Returns:
sap.ui.ux3.ShellReference 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:
stringsLogoutButtonTooltipNew value for property logoutButtonTooltip
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Since:
1.9.0
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:
intpxhow many pixels of free space should be next to the Shell (between 0 and 600)
functioncomplete?optional callback function to call after the animation
stringouterId?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.ControloContentThe 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.
booleanbDestroyOldContentIf set, the controls previously contained in the pane will be destroyed, to avoid memory leaks.
Returns:
sap.ui.core.Control[]
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:
intiPaneWidthNew value for property paneWidth
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
setSelectedWorksetItem(oSelectedWorksetItem): sap.ui.ux3.Shell
Sets the associated selectedWorksetItem.
Parameters:
sap.ui.core.ID|sap.ui.ux3.NavigationItemoSelectedWorksetItemID of an element which becomes the new target of this selectedWorksetItem association; alternatively, an element instance may be given
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
setShowFeederTool(bShowFeederTool): sap.ui.ux3.Shell

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.

Parameters:
booleanbShowFeederToolNew value for property showFeederTool
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
setShowLogoutButton(bShowLogoutButton): sap.ui.ux3.Shell

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.

Parameters:
booleanbShowLogoutButtonNew value for property showLogoutButton
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
setShowPane(bShowPane): sap.ui.ux3.Shell

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.

Parameters:
booleanbShowPaneNew value for property showPane
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
setShowSearchTool(bShowSearchTool): sap.ui.ux3.Shell

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.

Parameters:
booleanbShowSearchToolNew value for property showSearchTool
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
setShowTools(bShowTools): sap.ui.ux3.Shell

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.

Parameters:
booleanbShowToolsNew value for property showTools
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
getShowInspectorTool(): boolean

Gets current value of property showInspectorTool.

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

Default value is false.

Returns:
booleanValue of property showInspectorTool
Deprecated API:
Since version 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.
setShowInspectorTool(bShowInspectorTool): sap.ui.ux3.Shell

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.

Parameters:
booleanbShowInspectorToolNew value for property showInspectorTool
Returns:
sap.ui.ux3.ShellReference to this in order to allow method chaining
Deprecated API:
Since version 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.