sap.suite.ui.commons.UnifiedThingInspector.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.UnifiedThingInspector 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 |
Returns a metadata object for class sap.suite.ui.commons.UnifiedThingInspector.
Returns:
Adds some facet oFacet
to the aggregation named facets
.
Parameters:
Returns:
Adds some facetContent oFacetContent
to the aggregation named facetContent
.
Parameters:
Returns:
Adds some kpi oKpi
to the aggregation named kpis
.
Parameters:
Returns:
Adds some page oPage
to the aggregation named pages
.
Parameters:
Returns:
Attach event handler
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:
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:
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:
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:
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:
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:
Destroys all the facetContent in the aggregation named facetContent
.
Returns:
Destroys all the facets in the aggregation named facets
.
Returns:
Destroys all the kpis in the aggregation named kpis
.
Returns:
Destroys all the pages in the aggregation named pages
.
Returns:
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:
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:
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:
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:
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:
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:
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 |
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:
Fire event backAction to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
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:
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 |
Getter for aggregation facetContent
.
The content that appears on the detail page of the UnifiedThingInspector.
Returns:
Getter for aggregation facets
.
The list of the sap.suite.ui.commons.FacetOverview objects.
Returns:
Getter for property
height
. The height of the control.
Default value is 100%
Returns:
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:
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:
getName(): string
Getter for property
name
. The name of the thing.
Default value is empty/undefined
Returns:
{string} | the value of property name |
Getter for aggregation pages
.
Contains pages except for Master and Detail.
Returns:
Returns a currently selected facet.
Returns:
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:
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:
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:
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:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
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:
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:
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:
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:
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:
Navigates to the Detail page.
Parameters:
{object} | oAFacetData | Contains content for the detail page to which the control must navigate. |
Returns:
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:
The method that navigates to sap.m.Page.
Parameters:
{string} | sSId | The ID of sap.m.Page instance where the user navigates to. |
Returns:
Removes all the controls in the aggregation named facetContent
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named facets
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named kpis
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named pages
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes an facet from the aggregation named facets
.
Parameters:
Returns:
Removes an facetContent from the aggregation named facetContent
.
Parameters:
Returns:
Removes an kpi from the aggregation named kpis
.
Parameters:
Returns:
Removes an page from the aggregation named pages
.
Parameters:
Returns:
Setter for property
actionsVisible
.
Default value is false
Parameters:
{boolean} | bActionsVisible | new value for property actionsVisible |
Returns:
Setter for property
configurationVisible
.
Default value is true
Parameters:
{boolean} | bConfigurationVisible | new value for property configurationVisible |
Returns:
Setter for property
description
.
Default value is empty/undefined
Parameters:
{string} | sDescription | new value for property description |
Returns:
Setter for property
destroyPageOnBack
.
Default value is true
Parameters:
{boolean} | bDestroyPageOnBack | new value for property destroyPageOnBack |
Returns:
Setter for property
height
.
Default value is 100%
Parameters:
Returns:
Setter for property
icon
.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
name
.
Default value is empty/undefined
Parameters:
{string} | sName | new value for property name |
Returns:
Setter for property
title
.
Default value is empty/undefined
Parameters:
{string} | sTitle | new value for property title |
Returns:
Setter for property
transactionsVisible
.
Default value is false
Parameters:
{boolean} | bTransactionsVisible | new value for property transactionsVisible |
Returns:
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:
Adds some transaction oTransaction
to the aggregation named transactions
.
Parameters:
- 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:
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:
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:
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:
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:
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:
- 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:
- 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 |
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:
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:
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:
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) |
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:
Removes an transaction from the aggregation named transactions
.
Parameters:
- 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: