Class sap.suite.ui.commons.ThreePanelThingViewerModule: sap/suite/ui/commons/ThreePanelThingViewer

extends ThingViewer

This control extends the sap.ui.ux3.ThingViewer control. The first panel can display a thing icon, a title, the Action Menu button, up to two rows of text descriptions (the first is wrapped, the second is truncated), vertical navigation bar (sap.suite.ui.commons.VerticalNavigationBar), and an image aka key visual. The second panel displays the header area as a vertical panel containing ThingGroup objects. The third panel is a main content area designed to display ThingGroup objects.

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

Constructor Summary
new sap.suite.ui.commons.ThreePanelThingViewer(sId?, mSettings?)Constructor for a new ThreePanelThingViewer.
Events borrowed from class sap.ui.ux3.ThingViewer
facetSelected
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.commons.ThreePanelThingViewer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ThreePanelThingViewer with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ThreePanelThingViewer.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ThreePanelThingViewer.
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.
selectDefaultFacet()Marks the first facet(navigation item) as selected if no facets selected and fires facetSelected event.
setLogo(sLogo)Setter for property logo.
setShowHeader(bShowHeader)Setter for property showHeader.
setSidebarWidth(sSidebarWidth)Setter for property sidebarWidth.
Methods borrowed from class sap.ui.ux3.ThingViewer
addFacet, addFacetContent, addHeaderContent, attachFacetSelected, destroyActionBar, destroyFacetContent, destroyFacets, destroyHeaderContent, detachFacetSelected, fireFacetSelected, getActionBar, getFacetContent, getFacets, getHeaderContent, getHeaderType, getHeight, getIcon, getSelectedFacet, getSubtitle, getTitle, getType, getWidth, indexOfFacet, indexOfFacetContent, indexOfHeaderContent, insertFacet, insertFacetContent, insertHeaderContent, removeAllFacetContent, removeAllFacets, removeAllHeaderContent, removeFacet, removeFacetContent, removeHeaderContent, setActionBar, setHeaderType, setHeight, setIcon, setSelectedFacet, setSubtitle, setTitle, setType, setWidth
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.suite.ui.commons.ThreePanelThingViewer(sId?, mSettings?)
Constructor for a new ThreePanelThingViewer.

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:

In addition, all settings applicable to the base type sap.ui.ux3.ThingViewer 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.ThreePanelThingViewer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.ThreePanelThingViewer 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.ThreePanelThingViewer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.commons.ThreePanelThingViewer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addMenuContent(oMenuContent): sap.suite.ui.commons.ThreePanelThingViewer
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.ThreePanelThingViewer}this to allow method chaining
destroyMenuContent(): sap.suite.ui.commons.ThreePanelThingViewer
Destroys all the menuContent in the aggregation named menuContent.
Returns:
{sap.suite.ui.commons.ThreePanelThingViewer}this to allow method chaining
getLogo(): sap.ui.core.URI
Getter for property logo. A URL of the source of an image known as key visual. This can be a company logo or other essential graphics.

Default value is empty/undefined

Returns:
{sap.ui.core.URI} the value of property logo
getMenuContent(): sap.ui.commons.Link[]
Getter for aggregation menuContent.
This aggregation allows you to add sap.ui.commons.Link items to the Action Menu. The menu appears as a popup when a user chooses a button in the top title section of the navigation panel.
Returns:
{sap.ui.commons.Link[]}
getShowHeader(): boolean
Getter for property showHeader. Shows or hides a middle panel named Header that contains general information.

Default value is empty/undefined

Returns:
{boolean} the value of property showHeader
getSidebarWidth(): sap.ui.core.CSSSize
Getter for property sidebarWidth. The width of the first panel that contains thing's title, icon, key visual and navigation bar. The default value is "244px".

Default value is 244px

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.ThreePanelThingViewer
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.ThreePanelThingViewer}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
selectDefaultFacet(): sap.suite.ui.commons.ThreePanelThingViewer
Marks the first facet(navigation item) as selected if no facets selected and fires facetSelected event.
Returns:
{sap.suite.ui.commons.ThreePanelThingViewer}
setLogo(sLogo): sap.suite.ui.commons.ThreePanelThingViewer
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.ThreePanelThingViewer}this to allow method chaining
setShowHeader(bShowHeader): sap.suite.ui.commons.ThreePanelThingViewer
Setter for property showHeader.

Default value is empty/undefined

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

Default value is 244px

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