Shell 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. replaced by {@link sap.m.Shell} sap.ui.core/Control 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. 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. The tooltip of the application icon in the header Whether the Logoff button in the header should be displayed or not. 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. Whether the "Global Search" tool should be displayed or not. Whether the "Inspector" tool should be displayed or not. 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. Whether the "Feeder" tool should be displayed or not. Whether the tool area should be displayed at all or not. Whether the pane bar should be displayed at all or not. Defines which header type to be used. Depending on the header type some other functionality might be obsolete. Defines which design type is to be used. 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). Whether the Shell content area should have a theme-dependent padding or not. 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. Whether the Shell header (Title Area + Header Items) can be accessed when an Overlay, OverlayContainer or ThingInspector is open. 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. 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. The selected NavigationItem The key of the selected NavigationItem (or null if there is no key) An item in the right-hand-side pane bar has been selected, the pane is now visible and can be filled with UI elements. The ID of the selected PaneBarItem. The selected Item The key of the selected Item (or null if there is no key) Fired when the user clicks the "Log-off" button Fired when search has been triggered. Fired when a new feed entry is submitted. 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. The id of the PaneBarItem to which the closed pane belonged. The workset items. The items to appear in the PaneBar. The content to appear in the pane area. 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. The items which appear in the ToolPalette and are opened as popup when clicked. 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. The NotificationBar which should be integrated into the Shell. 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. 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. Returns the SearchField control which is used in the Search Tool. 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. The ID of the PaneBarItem which should be marked as selected. Closes the side Pane (if open). Returns 'this' to allow method chaining. Returns 'true' if the side Pane is currently open. 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. 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. If set, the controls previously contained in the Shell will be destroyed, to avoid memory leaks. 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. 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. If set, the controls previously contained in the pane will be destroyed, to avoid memory leaks. Experimental method! Do not use! 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. Personalization settings object