Class sap.suite.ui.commons.UnifiedThingInspectorModule: sap/suite/ui/commons/UnifiedThingInspector
This control provides an ability to display a thing (for example, object factsheet) on the desktop, tablet, and phone devices in a Fiori style.
Deprecated API:Since version 1.32. Deprecated. Object page should be used instead.
sClassName
and enriches it with the information contained in oClassInfo
.oFacetContent
to the aggregation named facetContent
.fnFunction
to the 'actionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
to the 'afterNavigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
to the 'backAction' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
to the 'configurationButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
to the 'navigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
to the 'transactionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
from the 'actionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
from the 'afterNavigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
from the 'backAction' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
from the 'configurationButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
from the 'navigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.fnFunction
from the 'transactionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.sap.suite.ui.commons.FacetOverview
in the aggregation named facets
and returns its index if found or -1 otherwise.sap.ui.core.Control
in the aggregation named facetContent
and returns its index if found or -1 otherwise.sap.suite.ui.commons.KpiTile
in the aggregation named kpis
and returns its index if found or -1 otherwise.sap.ui.core.Control
in the aggregation named pages
and returns its index if found or -1 otherwise.facetContent
.oTransaction
to the aggregation named transactions
.sap.m.Button
in the aggregation named actions
and returns its index if found or -1 otherwise.sap.ui.core.Control
in the aggregation named transactions
and returns its index if found or -1 otherwise.transactions
. 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
- height : sap.ui.core.CSSSize (default: '100%')
- title : string
- name : string
- description : string
- icon : sap.ui.core.URI
- transactionsVisible : boolean (default: false)
- actionsVisible : boolean (default: false)
- destroyPageOnBack : boolean (default: true)
- configurationVisible : boolean (default: true)
- Aggregations
- facets : sap.suite.ui.commons.FacetOverview[]
- facetContent : sap.ui.core.Control[]
- kpis : sap.suite.ui.commons.KpiTile[]
- transactions : sap.ui.core.Control[]
- actions : sap.m.Button[]
- pages : sap.ui.core.Control[]
- Associations
- Events
- backAction : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- transactionsButtonPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- actionsButtonPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- configurationButtonPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- navigate : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterNavigate : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
{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.
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.caller | The object that initiated the event. |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{sap.ui.core.Control} | oControlEvent.getParameters.from | The page that had been shown before navigation. |
{string} | oControlEvent.getParameters.fromId | The ID of the page that had been shown before navigation. |
{sap.ui.core.Control} | oControlEvent.getParameters.to | The page that is now shown after navigation. |
{string} | oControlEvent.getParameters.toId | The ID of the page that is now shown after navigation. |
{boolean} | oControlEvent.getParameters.firstTime | Whether the "to" page (more precisely: a control with the ID of the page that has been navigated to) had not been shown/navigated to before. |
{boolean} | oControlEvent.getParameters.isTo | Whether was a forward navigation, triggered by "to()". |
{boolean} | oControlEvent.getParameters.isBack | Whether this was a back navigation, triggered by "back()". |
{boolean} | oControlEvent.getParameters.isBackToTop | Whether this was a navigation to the root page, triggered by "backToTop()". |
{boolean} | oControlEvent.getParameters.isBackToPage | Whether this was a navigation to the root page, triggered by "backToTop()". |
{string} | oControlEvent.getParameters.direction | How the navigation was triggered, possible values are: "to", "back", and "backToTop". |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.caller | The object that initiated the event. |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{sap.ui.core.Control} | oControlEvent.getParameters.from | The page that was shown before the current navigation. |
{string} | oControlEvent.getParameters.fromId | The ID of the page that was shown before the current navigation. |
{sap.ui.core.Control} | oControlEvent.getParameters.to | The page that will be shown after the current navigation. |
{string} | oControlEvent.getParameters.toId | The ID of the page that will be shown after the current navigation. |
{boolean} | oControlEvent.getParameters.firstTime | Whether the "to" page (more precisely: a control with the ID of the page that is currently navigated to) has not been shown/navigated to before. |
{boolean} | oControlEvent.getParameters.isTo | Whether this is a forward navigation, triggered by "to()". |
{boolean} | oControlEvent.getParameters.isBack | Whether this is a back navigation, triggered by "back()". |
{boolean} | oControlEvent.getParameters.isBackToTop | Whether this is a navigation to the root page, triggered by "backToTop()". |
{boolean} | oControlEvent.getParameters.isBackToPage | Whether this was a navigation to the root page, triggered by "backToTop()". |
{string} | oControlEvent.getParameters.direction | How the navigation was triggered, possible values are: "to", "back", and "backToTop". |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.caller | The object that initiated the event. |
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of informations as described in Element.extend.
{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. |
{function} | the created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
oFacet
to the aggregation named facets
. {sap.suite.ui.commons.FacetOverview} | oFacet | the facet to add; if empty, nothing is inserted |
{sap.suite.ui.commons.UnifiedThingInspector} | this to allow method chaining |
oFacetContent
to the aggregation named facetContent
. {sap.ui.core.Control} | oFacetContent | the facetContent to add; if empty, nothing is inserted |
{sap.suite.ui.commons.UnifiedThingInspector} | this to allow method chaining |
oKpi
to the aggregation named kpis
. {sap.suite.ui.commons.KpiTile} | oKpi | the kpi to add; if empty, nothing is inserted |
{sap.suite.ui.commons.UnifiedThingInspector} | this to allow method chaining |
oPage
to the aggregation named pages
. {sap.ui.core.Control} | oPage | the page to add; if empty, nothing is inserted |
{sap.suite.ui.commons.UnifiedThingInspector} | this to allow method chaining |
fnFunction
to the 'actionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.. When called, the context of the event handler (its
this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.UnifiedThingInspector
.
itself. The event is fired when the user chooses the Actions button.
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.UnifiedThingInspector .itself. |
Returns:
{sap.suite.ui.commons.UnifiedThingInspector} | this to allow method chaining |
attachAfterNavigate(oData?, fnFunction, oListener?): sap.suite.ui.commons.UnifiedThingInspector Attach event handler fnFunction
to the 'afterNavigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.
. When called, the context of the event handler (its this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.UnifiedThingInspector
.
itself. The event is fired when navigation between two pages has completed. In case of animated transitions this event is fired with some delay after the "navigate" event. This event is propogated from the inner NavContainer. The event can also return internal Master and Detail pages.
Parameters:
{object} oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event. {function} fnFunction The function to call, when the event occurs. {object} oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.UnifiedThingInspector
.
itself.
Returns:
{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
attachBackAction(oData?, fnFunction, oListener?): sap.suite.ui.commons.UnifiedThingInspector Attach event handler fnFunction
to the 'backAction' event of this sap.suite.ui.commons.UnifiedThingInspector
.
. When called, the context of the event handler (its this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.UnifiedThingInspector
.
itself. The event is fired when the user chooses the Back button.
Parameters:
{object} oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event. {function} fnFunction The function to call, when the event occurs. {object} oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.UnifiedThingInspector
.
itself.
Returns:
{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
attachConfigurationButtonPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.UnifiedThingInspector Attach event handler fnFunction
to the 'configurationButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.
. When called, the context of the event handler (its this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.UnifiedThingInspector
.
itself. The event is fired when the user chooses the Configuration button.
Parameters:
{object} oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event. {function} fnFunction The function to call, when the event occurs. {object} oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.UnifiedThingInspector
.
itself.
Returns:
{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
attachNavigate(oData?, fnFunction, oListener?): sap.suite.ui.commons.UnifiedThingInspector Attach event handler fnFunction
to the 'navigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.
. When called, the context of the event handler (its this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.UnifiedThingInspector
.
itself. The event is fired when navigation between two pages has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation. This event is propogated from the inner NavContainer. The event can also return internal Master and Detail pages.
Parameters:
{object} oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event. {function} fnFunction The function to call, when the event occurs. {object} oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.UnifiedThingInspector
.
itself.
Returns:
{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
attachTransactionsButtonPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.UnifiedThingInspector Attach event handler fnFunction
to the 'transactionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.
. When called, the context of the event handler (its this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.UnifiedThingInspector
.
itself. The event is fired when the user chooses the Transactions button.
Parameters:
{object} oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event. {function} fnFunction The function to call, when the event occurs. {object} oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.UnifiedThingInspector
.
itself.
Returns:
{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
destroyFacetContent(): sap.suite.ui.commons.UnifiedThingInspector Destroys all the facetContent in the aggregation named facetContent
. Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
destroyFacets(): sap.suite.ui.commons.UnifiedThingInspector Destroys all the facets in the aggregation named facets
. Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
destroyKpis(): sap.suite.ui.commons.UnifiedThingInspector Destroys all the kpis in the aggregation named kpis
. Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
destroyPages(): sap.suite.ui.commons.UnifiedThingInspector Destroys all the pages in the aggregation named pages
. Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
detachActionsButtonPress(fnFunction, oListener): sap.suite.ui.commons.UnifiedThingInspector Detach event handler fnFunction
from the 'actionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
detachAfterNavigate(fnFunction, oListener): sap.suite.ui.commons.UnifiedThingInspector Detach event handler fnFunction
from the 'afterNavigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
detachBackAction(fnFunction, oListener): sap.suite.ui.commons.UnifiedThingInspector Detach event handler fnFunction
from the 'backAction' event of this sap.suite.ui.commons.UnifiedThingInspector
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
detachConfigurationButtonPress(fnFunction, oListener): sap.suite.ui.commons.UnifiedThingInspector Detach event handler fnFunction
from the 'configurationButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
detachNavigate(fnFunction, oListener): sap.suite.ui.commons.UnifiedThingInspector Detach event handler fnFunction
from the 'navigate' event of this sap.suite.ui.commons.UnifiedThingInspector
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
detachTransactionsButtonPress(fnFunction, oListener): sap.suite.ui.commons.UnifiedThingInspector Detach event handler fnFunction
from the 'transactionsButtonPress' event of this sap.suite.ui.commons.UnifiedThingInspector
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
fireActionsButtonPress(mArguments?): boolean Fire event actionsButtonPress to attached listeners. Listeners may prevent the default action of this event using the preventDefault-method on the event object.
Expects following event parameters:
- 'caller' of type
object
The object that initiated the event.
Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{boolean} whether to prevent the default action
fireAfterNavigate(mArguments?): sap.suite.ui.commons.UnifiedThingInspector Fire event afterNavigate to attached listeners. Expects following event parameters:
- 'from' of type
sap.ui.core.Control
The page that had been shown before navigation. - 'fromId' of type
string
The ID of the page that had been shown before navigation. - 'to' of type
sap.ui.core.Control
The page that is now shown after navigation. - 'toId' of type
string
The ID of the page that is now shown after navigation. - 'firstTime' of type
boolean
Whether the "to" page (more precisely: a control with the ID of the page that has been navigated to) had not been shown/navigated to before. - 'isTo' of type
boolean
Whether was a forward navigation, triggered by "to()". - 'isBack' of type
boolean
Whether this was a back navigation, triggered by "back()". - 'isBackToTop' of type
boolean
Whether this was a navigation to the root page, triggered by "backToTop()". - 'isBackToPage' of type
boolean
Whether this was a navigation to the root page, triggered by "backToTop()". - 'direction' of type
string
How the navigation was triggered, possible values are: "to", "back", and "backToTop".
Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
fireBackAction(mArguments?): sap.suite.ui.commons.UnifiedThingInspector Fire event backAction to attached listeners. Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
fireConfigurationButtonPress(mArguments?): sap.suite.ui.commons.UnifiedThingInspector Fire event configurationButtonPress to attached listeners. Expects following event parameters:
- 'caller' of type
object
The object that initiated the event.
Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
fireNavigate(mArguments?): boolean Fire event navigate to attached listeners. Listeners may prevent the default action of this event using the preventDefault-method on the event object.
Expects following event parameters:
- 'from' of type
sap.ui.core.Control
The page that was shown before the current navigation. - 'fromId' of type
string
The ID of the page that was shown before the current navigation. - 'to' of type
sap.ui.core.Control
The page that will be shown after the current navigation. - 'toId' of type
string
The ID of the page that will be shown after the current navigation. - 'firstTime' of type
boolean
Whether the "to" page (more precisely: a control with the ID of the page that is currently navigated to) has not been shown/navigated to before. - 'isTo' of type
boolean
Whether this is a forward navigation, triggered by "to()". - 'isBack' of type
boolean
Whether this is a back navigation, triggered by "back()". - 'isBackToTop' of type
boolean
Whether this is a navigation to the root page, triggered by "backToTop()". - 'isBackToPage' of type
boolean
Whether this was a navigation to the root page, triggered by "backToTop()". - 'direction' of type
string
How the navigation was triggered, possible values are: "to", "back", and "backToTop".
Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{boolean} whether to prevent the default action
fireTransactionsButtonPress(mArguments?): boolean Fire event transactionsButtonPress to attached listeners. Listeners may prevent the default action of this event using the preventDefault-method on the event object.
Expects following event parameters:
- 'caller' of type
object
The object that initiated the event.
Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{boolean} whether to prevent the default action
getActionsVisible(): boolean Getter for property actionsVisible
. If set to true, the Actions button appears. Default value is false
Returns:{boolean} the value of property actionsVisible
getConfigurationVisible(): boolean Getter for property configurationVisible
. If set to true, the Configuration button appears. Default value is true
Returns:{boolean} the value of property configurationVisible
getDescription(): string Getter for property description
. The description of the thing. Default value is empty/undefined
Returns:{string} the value of property description
getDestroyPageOnBack(): boolean Getter for property destroyPageOnBack
. If set to true, destroys a page when the user chooses the Back button to leave this page. Default value is true
Returns:{boolean} the value of property destroyPageOnBack
getFacetContent(): sap.ui.core.Control[] Getter for aggregation facetContent
.
The content that appears on the detail page of the UnifiedThingInspector. Returns:{sap.ui.core.Control[]}
getFacets(): sap.suite.ui.commons.FacetOverview[] Getter for aggregation facets
.
The list of the sap.suite.ui.commons.FacetOverview objects. Returns:{sap.suite.ui.commons.FacetOverview[]}
getHeight(): sap.ui.core.CSSSize Getter for property height
. The height of the control. Default value is 100%
Returns:{sap.ui.core.CSSSize} the value of property height
getIcon(): sap.ui.core.URI Getter for property icon
. The icon to be displayed as a graphical element within the header. This can be an image or an icon from the icon font. Default value is empty/undefined
Returns:{sap.ui.core.URI} the value of property icon
getKpis(): sap.suite.ui.commons.KpiTile[] Getter for aggregation kpis
.
A set of the KPI tiles to be shown in the header. Currently only 3 tiles from the list are displayed on the desktop and tablet. On the phone, all tiles are displayed in a swipeable container. Returns:{sap.suite.ui.commons.KpiTile[]}
getName(): string Getter for property name
. The name of the thing. Default value is empty/undefined
Returns:{string} the value of property name
getPages(): sap.ui.core.Control[] Getter for aggregation pages
.
Contains pages except for Master and Detail. Returns:{sap.ui.core.Control[]}
getSelectedFacet(): sap.suite.ui.commons.FacetOverview Returns a currently selected facet. Returns:{sap.suite.ui.commons.FacetOverview}
getTitle(): string Getter for property title
. The title of the thing. Default value is empty/undefined
Returns:{string} the value of property title
getTransactionsVisible(): boolean Getter for property transactionsVisible
. If set to true, the Transaction button appears. Default value is false
Returns:{boolean} the value of property transactionsVisible
indexOfFacet(oFacet): int Checks for the provided sap.suite.ui.commons.FacetOverview
in the aggregation named facets
and returns its index if found or -1 otherwise. Parameters:{sap.suite.ui.commons.FacetOverview} oFacet the facet whose index is looked for.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfFacetContent(oFacetContent): int Checks for the provided sap.ui.core.Control
in the aggregation named facetContent
and returns its index if found or -1 otherwise. Parameters:{sap.ui.core.Control} oFacetContent the facetContent whose index is looked for.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfKpi(oKpi): int Checks for the provided sap.suite.ui.commons.KpiTile
in the aggregation named kpis
and returns its index if found or -1 otherwise. Parameters:{sap.suite.ui.commons.KpiTile} oKpi the kpi whose index is looked for.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfPage(oPage): int Checks for the provided sap.ui.core.Control
in the aggregation named pages
and returns its index if found or -1 otherwise. Parameters:{sap.ui.core.Control} oPage the page whose index is looked for.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertFacet(oFacet, iIndex): sap.suite.ui.commons.UnifiedThingInspector Inserts a facet into the aggregation named facets
. Parameters:{sap.suite.ui.commons.FacetOverview} oFacet the facet to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the facet should be inserted at; for a negative value of iIndex
, the facet is inserted at position 0; for a value greater than the current size of the aggregation, the facet is inserted at the last position
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
insertFacetContent(oFacetContent, iIndex): sap.suite.ui.commons.UnifiedThingInspector Inserts a facetContent into the aggregation named facetContent
. Parameters:{sap.ui.core.Control} oFacetContent the facetContent to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the facetContent should be inserted at; for a negative value of iIndex
, the facetContent is inserted at position 0; for a value greater than the current size of the aggregation, the facetContent is inserted at the last position
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
insertKpi(oKpi, iIndex): sap.suite.ui.commons.UnifiedThingInspector Inserts a kpi into the aggregation named kpis
. Parameters:{sap.suite.ui.commons.KpiTile} oKpi the kpi to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the kpi should be inserted at; for a negative value of iIndex
, the kpi is inserted at position 0; for a value greater than the current size of the aggregation, the kpi is inserted at the last position
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
insertPage(oPage, iIndex): sap.suite.ui.commons.UnifiedThingInspector Inserts a page into the aggregation named pages
. Parameters:{sap.ui.core.Control} oPage the page to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the page should be inserted at; for a negative value of iIndex
, the page is inserted at position 0; for a value greater than the current size of the aggregation, the page is inserted at the last position
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
navigateToDetail(): sap.suite.ui.commons.UnifiedThingInspector The control that shows the Detail page that is already set. This method can be used instead of navigateToDetailWithContent when the content is already set by addFacetContent. Returns:{sap.suite.ui.commons.UnifiedThingInspector}
navigateToDetailWithContent(oAFacetData): sap.suite.ui.commons.UnifiedThingInspector Navigates to the Detail page. Parameters:{object} oAFacetData Contains content for the detail page to which the control must navigate.
Returns:{sap.suite.ui.commons.UnifiedThingInspector}
navigateToPage(oOPage, bAddDefaultFooter): sap.suite.ui.commons.UnifiedThingInspector The method that adds any sap.m.Page to the aggregated NavContainer. Parameters:{sap.m.Page} oOPage The sap.m.Page instance that is added to NavContainer of UnifiedThingInspector. {boolean} bAddDefaultFooter If set to true, the default page footer is added from UnifiedThingInspector.
Returns:{sap.suite.ui.commons.UnifiedThingInspector}
navigateToPageId(sSId): sap.suite.ui.commons.UnifiedThingInspector The method that navigates to sap.m.Page. Parameters:{string} sSId The ID of sap.m.Page instance where the user navigates to.
Returns:{sap.suite.ui.commons.UnifiedThingInspector}
removeAllFacetContent(): sap.ui.core.Control[] Removes all the controls in the aggregation named facetContent
.
Additionally unregisters them from the hosting UIArea. Returns:{sap.ui.core.Control[]} an array of the removed elements (might be empty)
removeAllFacets(): sap.suite.ui.commons.FacetOverview[] Removes all the controls in the aggregation named facets
.
Additionally unregisters them from the hosting UIArea. Returns:{sap.suite.ui.commons.FacetOverview[]} an array of the removed elements (might be empty)
removeAllKpis(): sap.suite.ui.commons.KpiTile[] Removes all the controls in the aggregation named kpis
.
Additionally unregisters them from the hosting UIArea. Returns:{sap.suite.ui.commons.KpiTile[]} an array of the removed elements (might be empty)
removeAllPages(): sap.ui.core.Control[] Removes all the controls in the aggregation named pages
.
Additionally unregisters them from the hosting UIArea. Returns:{sap.ui.core.Control[]} an array of the removed elements (might be empty)
removeFacet(vFacet): sap.suite.ui.commons.FacetOverview Removes an facet from the aggregation named facets
. Parameters:{int|string|sap.suite.ui.commons.FacetOverview} vFacet the facet to remove or its index or id
Returns:{sap.suite.ui.commons.FacetOverview} the removed facet or null
removeFacetContent(vFacetContent): sap.ui.core.Control Removes an facetContent from the aggregation named facetContent
. Parameters:{int|string|sap.ui.core.Control} vFacetContent the facetContent to remove or its index or id
Returns:{sap.ui.core.Control} the removed facetContent or null
removeKpi(vKpi): sap.suite.ui.commons.KpiTile Removes an kpi from the aggregation named kpis
. Parameters:{int|string|sap.suite.ui.commons.KpiTile} vKpi the kpi to remove or its index or id
Returns:{sap.suite.ui.commons.KpiTile} the removed kpi or null
removePage(vPage): sap.ui.core.Control Removes an page from the aggregation named pages
. Parameters:{int|string|sap.ui.core.Control} vPage the page to remove or its index or id
Returns:{sap.ui.core.Control} the removed page or null
setActionsVisible(bActionsVisible): sap.suite.ui.commons.UnifiedThingInspector Setter for property actionsVisible
. Default value is false
Parameters:{boolean} bActionsVisible new value for property actionsVisible
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setConfigurationVisible(bConfigurationVisible): sap.suite.ui.commons.UnifiedThingInspector Setter for property configurationVisible
. Default value is true
Parameters:{boolean} bConfigurationVisible new value for property configurationVisible
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setDescription(sDescription): sap.suite.ui.commons.UnifiedThingInspector Setter for property description
. Default value is empty/undefined
Parameters:{string} sDescription new value for property description
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setDestroyPageOnBack(bDestroyPageOnBack): sap.suite.ui.commons.UnifiedThingInspector Setter for property destroyPageOnBack
. Default value is true
Parameters:{boolean} bDestroyPageOnBack new value for property destroyPageOnBack
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setHeight(sHeight): sap.suite.ui.commons.UnifiedThingInspector Setter for property height
. Default value is 100%
Parameters:{sap.ui.core.CSSSize} sHeight new value for property height
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setIcon(sIcon): sap.suite.ui.commons.UnifiedThingInspector Setter for property icon
. Default value is empty/undefined
Parameters:{sap.ui.core.URI} sIcon new value for property icon
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setName(sName): sap.suite.ui.commons.UnifiedThingInspector Setter for property name
. Default value is empty/undefined
Parameters:{string} sName new value for property name
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setTitle(sTitle): sap.suite.ui.commons.UnifiedThingInspector Setter for property title
. Default value is empty/undefined
Parameters:{string} sTitle new value for property title
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
setTransactionsVisible(bTransactionsVisible): sap.suite.ui.commons.UnifiedThingInspector Setter for property transactionsVisible
. Default value is false
Parameters:{boolean} bTransactionsVisible new value for property transactionsVisible
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
addAction(oAction): sap.suite.ui.commons.UnifiedThingInspector Adds some action oAction
to the aggregation named actions
. Parameters:{sap.m.Button} oAction the action to add; if empty, nothing is inserted
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
addTransaction(oTransaction): sap.suite.ui.commons.UnifiedThingInspector Adds some transaction oTransaction
to the aggregation named transactions
. Parameters:{sap.ui.core.Control} oTransaction the transaction to add; if empty, nothing is inserted
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
destroyActions(): sap.suite.ui.commons.UnifiedThingInspector Destroys all the actions in the aggregation named actions
. - Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
destroyTransactions(): sap.suite.ui.commons.UnifiedThingInspector Destroys all the transactions in the aggregation named transactions
. - Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
getActions(): sap.m.Button[] Getter for aggregation actions
.
Action sheet controls. - Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{sap.m.Button[]}
getTransactions(): sap.ui.core.Control[] Getter for aggregation transactions
.
Menu items for transaction popup. - Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{sap.ui.core.Control[]}
indexOfAction(oAction): int Checks for the provided sap.m.Button
in the aggregation named actions
and returns its index if found or -1 otherwise. Parameters:{sap.m.Button} oAction the action whose index is looked for.
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfTransaction(oTransaction): int Checks for the provided sap.ui.core.Control
in the aggregation named transactions
and returns its index if found or -1 otherwise. Parameters:{sap.ui.core.Control} oTransaction the transaction whose index is looked for.
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertAction(oAction, iIndex): sap.suite.ui.commons.UnifiedThingInspector Inserts a action into the aggregation named actions
. Parameters:{sap.m.Button} oAction the action to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
insertTransaction(oTransaction, iIndex): sap.suite.ui.commons.UnifiedThingInspector Inserts a transaction into the aggregation named transactions
. Parameters:{sap.ui.core.Control} oTransaction the transaction to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the transaction should be inserted at; for a negative value of iIndex
, the transaction is inserted at position 0; for a value greater than the current size of the aggregation, the transaction is inserted at the last position
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{sap.suite.ui.commons.UnifiedThingInspector} this
to allow method chaining
removeAction(vAction): sap.m.Button Removes an action from the aggregation named actions
. Parameters:{int|string|sap.m.Button} vAction the action to remove or its index or id
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{sap.m.Button} the removed action or null
removeAllActions(): sap.m.Button[] Removes all the controls in the aggregation named actions
.
Additionally unregisters them from the hosting UIArea. - Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the actionsButtonPress event handler instead.
Returns:{sap.m.Button[]} an array of the removed elements (might be empty)
removeAllTransactions(): sap.ui.core.Control[] Removes all the controls in the aggregation named transactions
.
Additionally unregisters them from the hosting UIArea. - Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{sap.ui.core.Control[]} an array of the removed elements (might be empty)
removeTransaction(vTransaction): sap.ui.core.Control Removes an transaction from the aggregation named transactions
. Parameters:{int|string|sap.ui.core.Control} vTransaction the transaction to remove or its index or id
- Deprecated:
- Since version 1.18.2. Deprecated due to the incorrect work with data binding. Open the popup in the transactionsButtonPress event handler instead.
Returns:{sap.ui.core.Control} the removed transaction or null