Thing Inspector
Constructor for a new ThingInspector.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.ux3.ThingInspector(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
favoriteActionEnabled | boolean | true | Favorite action enabled/disabled. If disabled the action will be invisible. Visibility: public |
favoriteState | boolean | false | State Of favorite Action Visibility: public |
firstTitle | string | First Line of the Thing Inspector Title Visibility: public |
|
flagActionEnabled | boolean | true | Flag action enabled/disabled. If disabled the action will be invisible. Visibility: public |
flagState | boolean | false | State of Flag Action Visibility: public |
followActionEnabled | boolean | true | Follow action enabled/disabled. If disabled the action will be invisible. Visibility: public |
followState | sap.ui.ux3.FollowActionState | Default | Follow State of a Thing Visibility: public |
headerType | sap.ui.ux3.ThingViewerHeaderType | Standard | Defines which header type should be used. |
icon | sap.ui.core.URI | Thing Icon Url Visibility: public |
|
secondTitle | string | Second Line of the Thing Inspector Title Visibility: public |
|
type | string | Thing type Visibility: public |
|
updateActionEnabled | boolean | true | Update action enabled/disabled. If disabled the action will be invisible. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
actionBar | 0..1 | sap.ui.ux3.ActionBar |
ActionBar. If no actionBar is set a default ActionBar will be created. |
actions | 0..n | sap.ui.ux3.ThingAction |
Actions of a Thing |
facetContent | 0..n | sap.ui.ux3.ThingGroup |
ThingGroups for content of the selected facet |
facets | 0..n | sap.ui.ux3.NavigationItem |
Thing Inspector facets |
headerContent | 0..n | sap.ui.ux3.ThingGroup |
ThingGroups for the header content |
thingViewer | 0..1 | sap.ui.ux3.ThingViewer |
The ThingViewer managed by this ThingInspector |
Name | Cardinality | Type | Description |
---|---|---|---|
selectedFacet | 0..1 | sap.ui.ux3.NavigationItem |
The Facet that is currently selected. |
Event | Description |
---|---|
actionSelected |
Further thing related Action selected |
facetSelected |
Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected. Listeners may prevent the default action of this event by calling the |
feedSubmit |
Fired when a new feed entry is submitted. |
Further thing related Action selected
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
id | string |
Id of selected ThingAction |
action | sap.ui.ux3.ThingAction |
Selected ThingAction |
Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected.
Listeners may prevent the default action of this event by calling the preventDefault
method on the event object.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
id | string |
Id of selected NavigationItem |
item | sap.ui.ux3.NavigationItem |
The selected NavigationItem |
key | string |
Key of selected NavigationItem |
Method | Description |
---|---|
addAction |
Adds some action to the aggregation actions. |
addFacet |
Adds some facet to the aggregation facets. |
addFacetContent |
Adds some facetContent to the aggregation facetContent. |
addHeaderContent |
Adds some headerContent to the aggregation headerContent. |
attachActionSelected |
Attaches event handler When called, the context of the event handler (its Further thing related Action selected |
attachFacetSelected |
Attaches event handler When called, the context of the event handler (its Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected. |
attachFeedSubmit |
Attaches event handler When called, the context of the event handler (its Fired when a new feed entry is submitted. |
destroyActionBar |
Destroys the actionBar in the aggregation actionBar. |
destroyActions |
Destroys all the actions in the aggregation actions. |
destroyFacetContent |
Destroys all the facetContent in the aggregation facetContent. |
destroyFacets |
Destroys all the facets in the aggregation facets. |
destroyHeaderContent |
Destroys all the headerContent in the aggregation headerContent. |
detachActionSelected |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachFacetSelected |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachFeedSubmit |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.ux3.ThingInspector.extend |
Creates a new subclass of class sap.ui.ux3.ThingInspector with name
|
fireActionSelected |
Fires event actionSelected to attached listeners. |
fireFacetSelected |
Fires event facetSelected to attached listeners. Listeners may prevent the default action of this event by calling the |
fireFeedSubmit |
Fires event feedSubmit to attached listeners. |
getActionBar |
Gets content of aggregation actionBar. ActionBar. If no actionBar is set a default ActionBar will be created. |
getActions |
Gets content of aggregation actions. Actions of a Thing |
getFacetContent |
Gets content of aggregation facetContent. ThingGroups for content of the selected facet |
getFacets |
Gets content of aggregation facets. Thing Inspector facets |
getFavoriteActionEnabled |
Gets current value of property favoriteActionEnabled. Favorite action enabled/disabled. If disabled the action will be invisible. Default value is |
getFavoriteState |
Gets current value of property favoriteState. State Of favorite Action Default value is |
getFirstTitle |
Gets current value of property firstTitle. First Line of the Thing Inspector Title |
getFlagActionEnabled |
Gets current value of property flagActionEnabled. Flag action enabled/disabled. If disabled the action will be invisible. Default value is |
getFlagState |
Gets current value of property flagState. State of Flag Action Default value is |
getFollowActionEnabled |
Gets current value of property followActionEnabled. Follow action enabled/disabled. If disabled the action will be invisible. Default value is |
getFollowState |
Gets current value of property followState. Follow State of a Thing Default value is |
getHeaderContent |
Gets content of aggregation headerContent. ThingGroups for the header content |
getHeaderType |
Gets current value of property headerType. Defines which header type should be used. Default value is |
getIcon |
Gets current value of property icon. Thing Icon Url |
sap.ui.ux3.ThingInspector.getMetadata |
Returns a metadata object for class sap.ui.ux3.ThingInspector. |
getSecondTitle |
Gets current value of property secondTitle. Second Line of the Thing Inspector Title |
getSelectedFacet |
ID of the element which is the current target of the association selectedFacet, or |
getType |
Gets current value of property type. Thing type |
getUpdateActionEnabled |
Gets current value of property updateActionEnabled. Update action enabled/disabled. If disabled the action will be invisible. Default value is |
indexOfAction |
Checks for the provided |
indexOfFacet |
Checks for the provided |
indexOfFacetContent |
Checks for the provided |
indexOfHeaderContent |
Checks for the provided |
insertAction |
Inserts a action into the aggregation actions. |
insertFacet |
Inserts a facet into the aggregation facets. |
insertFacetContent |
Inserts a facetContent into the aggregation facetContent. |
insertHeaderContent |
Inserts a headerContent into the aggregation headerContent. |
open |
Opens this instance of ThingIspector |
removeAction |
Removes a action from the aggregation actions. |
removeAllActions |
Removes all the controls from the aggregation actions. Additionally, it unregisters them from the hosting UIArea. |
removeAllFacetContent |
Removes all the controls from the aggregation facetContent. Additionally, it unregisters them from the hosting UIArea. |
removeAllFacets |
Removes all the controls from the aggregation facets. Additionally, it unregisters them from the hosting UIArea. |
removeAllHeaderContent |
Removes all the controls from the aggregation headerContent. Additionally, it unregisters them from the hosting UIArea. |
removeFacet |
Removes a facet from the aggregation facets. |
removeFacetContent |
Removes a facetContent from the aggregation facetContent. |
removeHeaderContent |
Removes a headerContent from the aggregation headerContent. |
setActionBar |
Sets the aggregated actionBar. |
setFavoriteActionEnabled |
Sets a new value for property favoriteActionEnabled. Favorite action enabled/disabled. If disabled the action will be invisible. When called with a value of Default value is |
setFavoriteState |
Sets a new value for property favoriteState. State Of favorite Action When called with a value of Default value is |
setFirstTitle |
Sets a new value for property firstTitle. First Line of the Thing Inspector Title When called with a value of |
setFlagActionEnabled |
Sets a new value for property flagActionEnabled. Flag action enabled/disabled. If disabled the action will be invisible. When called with a value of Default value is |
setFlagState |
Sets a new value for property flagState. State of Flag Action When called with a value of Default value is |
setFollowActionEnabled |
Sets a new value for property followActionEnabled. Follow action enabled/disabled. If disabled the action will be invisible. When called with a value of Default value is |
setFollowState |
Sets a new value for property followState. Follow State of a Thing When called with a value of Default value is |
setHeaderType |
Sets a new value for property headerType. Defines which header type should be used. When called with a value of Default value is |
setIcon |
Sets a new value for property icon. Thing Icon Url When called with a value of |
setSecondTitle |
Sets a new value for property secondTitle. Second Line of the Thing Inspector Title When called with a value of |
setSelectedFacet |
Sets the associated selectedFacet. |
setType |
Sets a new value for property type. Thing type When called with a value of |
setUpdateActionEnabled |
Sets a new value for property updateActionEnabled. Update action enabled/disabled. If disabled the action will be invisible. When called with a value of Default value is |
Adds some action to the aggregation actions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAction | sap.ui.ux3.ThingAction |
The action to add; if empty, nothing is inserted |
Adds some facet to the aggregation facets.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFacet | sap.ui.ux3.NavigationItem |
The facet to add; if empty, nothing is inserted |
Adds some facetContent to the aggregation facetContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFacetContent | sap.ui.ux3.ThingGroup |
The facetContent to add; if empty, nothing is inserted |
Adds some headerContent to the aggregation headerContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContent | sap.ui.ux3.ThingGroup |
The headerContent to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the actionSelected event of this sap.ui.ux3.ThingInspector
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
Further thing related Action selected
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the facetSelected event of this sap.ui.ux3.ThingInspector
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the feedSubmit event of this sap.ui.ux3.ThingInspector
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
Fired when a new feed entry is submitted.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the actionSelected event of this sap.ui.ux3.ThingInspector
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the facetSelected event of this sap.ui.ux3.ThingInspector
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the feedSubmit event of this sap.ui.ux3.ThingInspector
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.ux3.ThingInspector with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.ux3.Overlay.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event actionSelected to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
id | string |
Id of selected ThingAction |
|
action | sap.ui.ux3.ThingAction |
Selected ThingAction |
Fires event facetSelected to attached listeners.
Listeners may prevent the default action of this event by calling the preventDefault
method on the event object. The return value of this method indicates whether the default action should be executed.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
id | string |
Id of selected NavigationItem |
|
item | sap.ui.ux3.NavigationItem |
The selected NavigationItem |
|
key | string |
Key of selected NavigationItem |
Fires event feedSubmit to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
text | string |
Feed text |
Gets content of aggregation actionBar.
ActionBar. If no actionBar is set a default ActionBar will be created.
Gets content of aggregation facetContent.
ThingGroups for content of the selected facet
Gets current value of property favoriteActionEnabled.
Favorite action enabled/disabled. If disabled the action will be invisible.
Default value is true
.
Gets current value of property favoriteState.
State Of favorite Action
Default value is false
.
Gets current value of property flagActionEnabled.
Flag action enabled/disabled. If disabled the action will be invisible.
Default value is true
.
Gets current value of property followActionEnabled.
Follow action enabled/disabled. If disabled the action will be invisible.
Default value is true
.
Gets current value of property followState.
Follow State of a Thing
Default value is Default
.
Gets current value of property headerType.
Defines which header type should be used.
Default value is Standard
.
Returns a metadata object for class sap.ui.ux3.ThingInspector.
ID of the element which is the current target of the association selectedFacet, or null
.
Gets current value of property updateActionEnabled.
Update action enabled/disabled. If disabled the action will be invisible.
Default value is true
.
Checks for the provided sap.ui.ux3.ThingAction
in the aggregation actions. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAction | sap.ui.ux3.ThingAction |
The action whose index is looked for |
Checks for the provided sap.ui.ux3.NavigationItem
in the aggregation facets. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFacet | sap.ui.ux3.NavigationItem |
The facet whose index is looked for |
Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation facetContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFacetContent | sap.ui.ux3.ThingGroup |
The facetContent whose index is looked for |
Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation headerContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContent | sap.ui.ux3.ThingGroup |
The headerContent whose index is looked for |
Inserts a action into the aggregation actions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAction | sap.ui.ux3.ThingAction |
The action to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a facet into the aggregation facets.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFacet | sap.ui.ux3.NavigationItem |
The facet to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a facetContent into the aggregation facetContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFacetContent | sap.ui.ux3.ThingGroup |
The facetContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a headerContent into the aggregation headerContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContent | sap.ui.ux3.ThingGroup |
The headerContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes a action from the aggregation actions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAction | int string sap.ui.ux3.ThingAction |
The action to remove or its index or id |
Removes all the controls from the aggregation actions.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation facetContent.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation facets.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation headerContent.
Additionally, it unregisters them from the hosting UIArea.
Removes a facet from the aggregation facets.
Param | Type | DefaultValue | Description |
---|---|---|---|
vFacet | int string sap.ui.ux3.NavigationItem |
The facet to remove or its index or id |
Removes a facetContent from the aggregation facetContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vFacetContent | int string sap.ui.ux3.ThingGroup |
The facetContent to remove or its index or id |
Removes a headerContent from the aggregation headerContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vHeaderContent | int string sap.ui.ux3.ThingGroup |
The headerContent to remove or its index or id |
Sets the aggregated actionBar.
Param | Type | DefaultValue | Description |
---|---|---|---|
oActionBar | sap.ui.ux3.ActionBar |
The actionBar to set |
Sets a new value for property favoriteActionEnabled.
Favorite action enabled/disabled. If disabled the action will be invisible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFavoriteActionEnabled | boolean | true |
New value for property |
Sets a new value for property favoriteState.
State Of favorite Action
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFavoriteState | boolean | false |
New value for property |
Sets a new value for property firstTitle.
First Line of the Thing Inspector Title
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFirstTitle | string |
New value for property |
Sets a new value for property flagActionEnabled.
Flag action enabled/disabled. If disabled the action will be invisible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFlagActionEnabled | boolean | true |
New value for property |
Sets a new value for property flagState.
State of Flag Action
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFlagState | boolean | false |
New value for property |
Sets a new value for property followActionEnabled.
Follow action enabled/disabled. If disabled the action will be invisible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFollowActionEnabled | boolean | true |
New value for property |
Sets a new value for property followState.
Follow State of a Thing
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Default
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFollowState | sap.ui.ux3.FollowActionState | Default |
New value for property |
Sets a new value for property headerType.
Defines which header type should be used.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Standard
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHeaderType | sap.ui.ux3.ThingViewerHeaderType | Standard |
New value for property |
Sets a new value for property icon.
Thing Icon Url
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI |
New value for property |
Sets a new value for property secondTitle.
Second Line of the Thing Inspector Title
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSecondTitle | string |
New value for property |
Sets the associated selectedFacet.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectedFacet | sap.ui.core.ID sap.ui.ux3.NavigationItem |
ID of an element which becomes the new target of this selectedFacet association; alternatively, an element instance may be given |
Sets a new value for property type.
Thing type
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sType | string |
New value for property |
Sets a new value for property updateActionEnabled.
Update action enabled/disabled. If disabled the action will be invisible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bUpdateActionEnabled | boolean | true |
New value for property |