Class sap.suite.ui.commons.ThreePanelThingInspectorModule: sap/suite/ui/commons/ThreePanelThingInspector


This control extends the sap.ui.ux3.ThingInspector control. It displays the sap.suite.ui.commons.ThreePanelThingViewer control in the sap.ui.ux3.Overlay control.

Deprecated API:Since version 1.32. Deprecated. Object page should be used instead.

Constructor Summary
new sap.suite.ui.commons.ThreePanelThingInspector(sId?, mSettings?)Constructor for a new ThreePanelThingInspector.
Events borrowed from class sap.ui.ux3.Overlay
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.commons.ThreePanelThingInspector.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ThreePanelThingInspector with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ThreePanelThingInspector.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ThreePanelThingInspector.
addMenuContent(oMenuContent)Adds some menuContent oMenuContent to the aggregation named menuContent.
destroyMenuContent()Destroys all the menuContent in the aggregation named menuContent.
getLogo()Getter for property logo.
getMenuContent()Getter for aggregation menuContent.
getShowHeader()Getter for property showHeader.
getSidebarWidth()Getter for property sidebarWidth.
indexOfMenuContent(oMenuContent)Checks for the provided sap.ui.commons.Link in the aggregation named menuContent and returns its index if found or -1 otherwise.
insertMenuContent(oMenuContent, iIndex)Inserts a menuContent into the aggregation named menuContent.
removeAllMenuContent()Removes all the controls in the aggregation named menuContent.
removeMenuContent(vMenuContent)Removes an menuContent from the aggregation named menuContent.
setLogo(sLogo)Setter for property logo.
setShowHeader(bShowHeader)Setter for property showHeader.
setSidebarWidth(sSidebarWidth)Setter for property sidebarWidth.
Constructor Detail
new sap.suite.ui.commons.ThreePanelThingInspector(sId?, mSettings?)
Constructor for a new ThreePanelThingInspector.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
  • Associations
    • Events

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

      Parameters:
      {string}sId? id for the new control, generated automatically if no id is given
      {object}mSettings? initial settings for the new control
      Deprecated:
      Since version 1.32. Deprecated. Object page should be used instead.
      Method Detail
      sap.suite.ui.commons.ThreePanelThingInspector.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.ThreePanelThingInspector with name sClassName and enriches it with the information contained in oClassInfo.

      oClassInfo might contain the same kind of informations as described in Element.extend.

      Parameters:
      {string}sClassName name of the class to be created
      {object}oClassInfo? object literal with informations about the class
      {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
      Returns:
      {function} the created class / constructor function
      sap.suite.ui.commons.ThreePanelThingInspector.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.ThreePanelThingInspector.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addMenuContent(oMenuContent): sap.suite.ui.commons.ThreePanelThingInspector
      Adds some menuContent oMenuContent to the aggregation named menuContent.
      Parameters:
      {sap.ui.commons.Link}oMenuContent the menuContent to add; if empty, nothing is inserted
      Returns:
      {sap.suite.ui.commons.ThreePanelThingInspector}this to allow method chaining
      Destroys all the menuContent in the aggregation named menuContent.
      Returns:
      {sap.suite.ui.commons.ThreePanelThingInspector}this to allow method chaining
      getLogo(): sap.ui.core.URI
      Getter for property logo. A URL of the source of the ThingViewer's key visual image.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.URI} the value of property logo
      getMenuContent(): sap.ui.commons.Link[]
      Getter for aggregation menuContent.
      The items of the ThingViewer's Action Menu.
      Returns:
      {sap.ui.commons.Link[]}
      getShowHeader(): boolean
      Getter for property showHeader. Shows or hides a middle panel of the ThingViewer named Header that contains general information.

      Default value is true

      Returns:
      {boolean} the value of property showHeader
      getSidebarWidth(): sap.ui.core.CSSSize
      Getter for property sidebarWidth. The width of the ThingViewer's navigation panel.

      Default value is 224px

      Returns:
      {sap.ui.core.CSSSize} the value of property sidebarWidth
      indexOfMenuContent(oMenuContent): int
      Checks for the provided sap.ui.commons.Link in the aggregation named menuContent and returns its index if found or -1 otherwise.
      Parameters:
      {sap.ui.commons.Link}oMenuContent the menuContent whose index is looked for.
      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      insertMenuContent(oMenuContent, iIndex): sap.suite.ui.commons.ThreePanelThingInspector
      Inserts a menuContent into the aggregation named menuContent.
      Parameters:
      {sap.ui.commons.Link}oMenuContent the menuContent to insert; if empty, nothing is inserted
      {int}iIndex the 0-based index the menuContent should be inserted at; for a negative value of iIndex, the menuContent is inserted at position 0; for a value greater than the current size of the aggregation, the menuContent is inserted at the last position
      Returns:
      {sap.suite.ui.commons.ThreePanelThingInspector}this to allow method chaining
      removeAllMenuContent(): sap.ui.commons.Link[]
      Removes all the controls in the aggregation named menuContent.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.ui.commons.Link[]} an array of the removed elements (might be empty)
      removeMenuContent(vMenuContent): sap.ui.commons.Link
      Removes an menuContent from the aggregation named menuContent.
      Parameters:
      {int|string|sap.ui.commons.Link}vMenuContent the menuContent to remove or its index or id
      Returns:
      {sap.ui.commons.Link} the removed menuContent or null
      Setter for property logo.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.URI}sLogo new value for property logo
      Returns:
      {sap.suite.ui.commons.ThreePanelThingInspector}this to allow method chaining
      Setter for property showHeader.

      Default value is true

      Parameters:
      {boolean}bShowHeader new value for property showHeader
      Returns:
      {sap.suite.ui.commons.ThreePanelThingInspector}this to allow method chaining
      setSidebarWidth(sSidebarWidth): sap.suite.ui.commons.ThreePanelThingInspector
      Setter for property sidebarWidth.

      Default value is 224px

      Parameters:
      {sap.ui.core.CSSSize}sSidebarWidth new value for property sidebarWidth
      Returns:
      {sap.suite.ui.commons.ThreePanelThingInspector}this to allow method chaining