QuickView is a small popup with a short overview of a Thing. QuickView is shown when a user holds the mouse pointer over a related screen element.
Constructor for a new QuickView.
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.QuickView(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 | Thing name shown in the header of the QuickView Visibility: public |
|
firstTitleHref | string | URI to Thing Inspector 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 |
icon | sap.ui.core.URI | URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal). Visibility: public |
|
openActionEnabled | boolean | true | Open Thing action enabled/disabled. If disabled the action will be invisible. Visibility: public |
secondTitle | string | Optional short text shown under the firstTitle Visibility: public |
|
showActionBar | boolean | true | Show Action Bar Visibility: public |
type | string | Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView. Visibility: public |
|
updateActionEnabled | boolean | true | Update action enabled/disabled. If disabled the action will be invisible. Visibility: public |
width | sap.ui.core.CSSSize | Control width as common CSS-size (px or % as unit, for example). 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. In any case, ActionBar is displayed only when the showActionBar property is set to true. |
actions | 0..n | sap.ui.ux3.ThingAction |
Actions of a Thing |
content | 0..n | sap.ui.core.Element |
Body content of the QuickView |
Event | Description |
---|---|
actionSelected |
Action is selected in Action Bar |
feedSubmit |
Fired when a new feed entry is submitted. |
navigate |
Event is fired when a user clicks on the firstTitle link. Call the preventDefault method of the event object to cancel browser navigation. Listeners may prevent the default action of this event by calling the |
Action is selected in Action Bar
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 |
newState | string |
New State of the selected action. Only filled if the respective action maintains a state property, for example 'FollowUp' or 'Favorite' |
Method | Description |
---|---|
addAction |
Adds some action to the aggregation actions. |
addContent |
Adds some content to the aggregation content. |
attachActionSelected |
Attaches event handler When called, the context of the event handler (its Action is selected in Action Bar |
attachFeedSubmit |
Attaches event handler When called, the context of the event handler (its Fired when a new feed entry is submitted. |
attachNavigate |
Attaches event handler When called, the context of the event handler (its Event is fired when a user clicks on the firstTitle link. Call the preventDefault method of the event object to cancel browser navigation. |
destroyActionBar |
Destroys the actionBar in the aggregation actionBar. |
destroyActions |
Destroys all the actions in the aggregation actions. |
destroyContent |
Destroys all the content in the aggregation content. |
detachActionSelected |
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. |
detachNavigate |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.ux3.QuickView.extend |
Creates a new subclass of class sap.ui.ux3.QuickView with name
|
fireActionSelected |
Fires event actionSelected to attached listeners. |
fireFeedSubmit |
Fires event feedSubmit to attached listeners. |
fireNavigate |
Fires event navigate to attached listeners. Listeners may prevent the default action of this event by calling the |
getActionBar |
Gets content of aggregation actionBar. ActionBar. If no actionBar is set a default ActionBar will be created. In any case, ActionBar is displayed only when the showActionBar property is set to true. |
getActions |
Gets content of aggregation actions. Actions of a Thing |
getContent |
Gets content of aggregation content. Body content of the QuickView |
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. Thing name shown in the header of the QuickView |
getFirstTitleHref |
Gets current value of property firstTitleHref. URI to Thing Inspector |
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 |
getIcon |
Gets current value of property icon. URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal). |
sap.ui.ux3.QuickView.getMetadata |
Returns a metadata object for class sap.ui.ux3.QuickView. |
getOpenActionEnabled |
Gets current value of property openActionEnabled. Open Thing action enabled/disabled. If disabled the action will be invisible. Default value is |
getSecondTitle |
Gets current value of property secondTitle. Optional short text shown under the firstTitle |
getShowActionBar |
Gets current value of property showActionBar. Show Action Bar Default value is |
getType |
Gets current value of property type. Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView. |
getUpdateActionEnabled |
Gets current value of property updateActionEnabled. Update action enabled/disabled. If disabled the action will be invisible. Default value is |
getWidth |
Gets current value of property width. Control width as common CSS-size (px or % as unit, for example). |
indexOfAction |
Checks for the provided |
indexOfContent |
Checks for the provided |
insertAction |
Inserts a action into the aggregation actions. |
insertContent |
Inserts a content into the aggregation content. |
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. |
removeAllContent |
Removes all the controls from the aggregation content. Additionally, it unregisters them from the hosting UIArea. |
removeContent |
Removes a content from the aggregation content. |
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. Thing name shown in the header of the QuickView When called with a value of |
setFirstTitleHref |
Sets a new value for property firstTitleHref. URI to Thing Inspector 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 |
setIcon |
Sets a new value for property icon. URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal). When called with a value of |
setOpenActionEnabled |
Sets a new value for property openActionEnabled. Open Thing action enabled/disabled. If disabled the action will be invisible. When called with a value of Default value is |
setSecondTitle |
Sets a new value for property secondTitle. Optional short text shown under the firstTitle When called with a value of |
setShowActionBar |
Sets a new value for property showActionBar. Show Action Bar When called with a value of Default value is |
setType |
Sets a new value for property type. Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView. 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 |
setWidth |
Sets a new value for property width. Control width as common CSS-size (px or % as unit, for example). When called with a value of |
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 content to the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Element |
The content to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the actionSelected event of this sap.ui.ux3.QuickView
.
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.QuickView
itself.
Action is selected in Action Bar
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.QuickView
.
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.QuickView
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.QuickView
.
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.QuickView
.
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.QuickView 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.commons.CalloutBase.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 |
|
newState | string |
New State of the selected action. Only filled if the respective action maintains a state property, for example 'FollowUp' or 'Favorite' |
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. In any case, ActionBar is displayed only when the showActionBar property is set to true.
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 firstTitle.
Thing name shown in the header of the QuickView
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 icon.
URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal).
Gets current value of property openActionEnabled.
Open Thing action enabled/disabled. If disabled the action will be invisible.
Default value is true
.
Gets current value of property secondTitle.
Optional short text shown under the firstTitle
Gets current value of property type.
Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView.
Gets current value of property updateActionEnabled.
Update action enabled/disabled. If disabled the action will be invisible.
Default value is true
.
Gets current value of property width.
Control width as common CSS-size (px or % as unit, for example).
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.core.Element
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Element |
The content 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 content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Element |
The content 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 content.
Additionally, it unregisters them from the hosting UIArea.
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.core.Element |
The content 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.
Thing name shown in the header of the QuickView
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 firstTitleHref.
URI to Thing Inspector
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFirstTitleHref | 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 icon.
URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal).
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 openActionEnabled.
Open Thing 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 |
---|---|---|---|
bOpenActionEnabled | boolean | true |
New value for property |
Sets a new value for property secondTitle.
Optional short text shown under the firstTitle
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 a new value for property showActionBar.
Show Action Bar
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 |
---|---|---|---|
bShowActionBar | boolean | true |
New value for property |
Sets a new value for property type.
Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView.
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 |
Sets a new value for property width.
Control width as common CSS-size (px or % as unit, for example).
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sWidth | sap.ui.core.CSSSize |
New value for property |