class sap.m.QuickViewPage

Control sample: sap.m.QuickViewPage
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/QuickViewPage
Application Component: CA-UI5-CTR

QuickViewPage consists of a page header, an avatar, an object name with short description, and an object information divided in groups. The control uses the sap.m.SimpleForm control to display information.


Constructor

Constructor for a new QuickViewPage.

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.m.QuickViewPage(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


Properties

Name Type Default Value Description
crossAppNavCallback object

Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.

Visibility: public
description string empty string

Specifies the text displayed under the header of the content section.

Visibility: public
fallbackIcon sap.ui.core.URI

Defines the fallback icon displayed in case of wrong image src or loading issues.

Note: Accepted values are only icons from the SAP icon font.

Since: 1.69.

Visibility: public
header string empty string

Specifies the text displayed in the header of the control.

Visibility: public
icon string empty string

Specifies the URL of the icon or image displayed under the header of the page.

Visibility: public
pageId string empty string

Page id

Visibility: public
title string empty string

Specifies the text displayed in the header of the content section of the control.

Visibility: public
titleUrl string empty string

Specifies the URL which opens when the title or the avatar is clicked. Note: If the avatar has press listeners this URL is not opened automatically.

Visibility: public

Aggregations

Default Aggregation: groups

Name Cardinality Type Description
avatar 0..1 sap.m.Avatar

Specifies the avatar displayed under the header of the page. Note: To achieve the recommended design and behavior don't use the displaySize, customDisplaySize, customFontSize properties and detailBox aggregation of sap.m.Avatar.

Since: 1.92.

groups (default) 0..n sap.m.QuickViewGroup

QuickViewGroup consists of a title (optional) and an entity of group elements.


Methods Overview

Method Description
addGroup

Adds some group to the aggregation groups.

bindAvatar

Binds aggregation avatar to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

bindGroups

Binds aggregation groups to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

destroyAvatar

Destroys the avatar in the aggregation avatar.

destroyGroups

Destroys all the groups in the aggregation groups.

sap.m.QuickViewPage.extend

Creates a new subclass of class sap.m.QuickViewPage 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.core.Control.extend.

getAvatar

Gets content of aggregation avatar.

Specifies the avatar displayed under the header of the page. Note: To achieve the recommended design and behavior don't use the displaySize, customDisplaySize, customFontSize properties and detailBox aggregation of sap.m.Avatar.

getCrossAppNavCallback

Gets current value of property crossAppNavCallback.

Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.

getDescription

Gets current value of property description.

Specifies the text displayed under the header of the content section.

Default value is empty string.

getFallbackIcon

Gets current value of property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src or loading issues.

Note: Accepted values are only icons from the SAP icon font.

Since 1.92 Use the <code>avatar</code> aggregation and use its property <code>fallbackIcon</code> instead.
getGroups

Gets content of aggregation groups.

QuickViewGroup consists of a title (optional) and an entity of group elements.

getHeader

Gets current value of property header.

Specifies the text displayed in the header of the control.

Default value is empty string.

getIcon

Gets current value of property icon.

Specifies the URL of the icon or image displayed under the header of the page.

Default value is empty string.

Since 1.92 Use the <code>avatar</code> aggregation instead.
sap.m.QuickViewPage.getMetadata

Returns a metadata object for class sap.m.QuickViewPage.

getPageId

Gets current value of property pageId.

Page id

Default value is empty string.

getTitle

Gets current value of property title.

Specifies the text displayed in the header of the content section of the control.

Default value is empty string.

getTitleUrl

Gets current value of property titleUrl.

Specifies the URL which opens when the title or the avatar is clicked. Note: If the avatar has press listeners this URL is not opened automatically.

Default value is empty string.

indexOfGroup

Checks for the provided sap.m.QuickViewGroup in the aggregation groups. and returns its index if found or -1 otherwise.

insertGroup

Inserts a group into the aggregation groups.

removeAllGroups

Removes all the controls from the aggregation groups.

Additionally, it unregisters them from the hosting UIArea.

removeGroup

Removes a group from the aggregation groups.

setAvatar

Sets the aggregated avatar.

setCrossAppNavCallback

Sets a new value for property crossAppNavCallback.

Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.

When called with a value of null or undefined, the default value of the property will be restored.

setDescription

Sets a new value for property description.

Specifies the text displayed under the header of the content section.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setFallbackIcon

Sets a new value for property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src or loading issues.

Note: Accepted values are only icons from the SAP icon font.

When called with a value of null or undefined, the default value of the property will be restored.

Since 1.92 Use the <code>avatar</code> aggregation and use its property <code>fallbackIcon</code> instead.
setHeader

Sets a new value for property header.

Specifies the text displayed in the header of the control.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setIcon

Sets a new value for property icon.

Specifies the URL of the icon or image displayed under the header of the page.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Since 1.92 Use the <code>avatar</code> aggregation instead.
setPageId

Sets a new value for property pageId.

Page id

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setTitle

Sets a new value for property title.

Specifies the text displayed in the header of the content section of the control.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setTitleUrl

Sets a new value for property titleUrl.

Specifies the URL which opens when the title or the avatar is clicked. Note: If the avatar has press listeners this URL is not opened automatically.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

unbindAvatar

Unbinds aggregation avatar from model data.

unbindGroups

Unbinds aggregation groups from model data.

addGroup

Adds some group to the aggregation groups.

Param Type DefaultValue Description
oGroup sap.m.QuickViewGroup

The group to add; if empty, nothing is inserted

bindAvatar

Binds aggregation avatar to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

bindGroups

Binds aggregation groups to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyAvatar

Destroys the avatar in the aggregation avatar.

destroyGroups

Destroys all the groups in the aggregation groups.

sap.m.QuickViewPage.extend

Creates a new subclass of class sap.m.QuickViewPage 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.core.Control.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

getAvatar

Gets content of aggregation avatar.

Specifies the avatar displayed under the header of the page. Note: To achieve the recommended design and behavior don't use the displaySize, customDisplaySize, customFontSize properties and detailBox aggregation of sap.m.Avatar.

getCrossAppNavCallback

Gets current value of property crossAppNavCallback.

Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.

getDescription

Gets current value of property description.

Specifies the text displayed under the header of the content section.

Default value is empty string.

getFallbackIcon

Gets current value of property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src or loading issues.

Note: Accepted values are only icons from the SAP icon font.

Since 1.92 Use the <code>avatar</code> aggregation and use its property <code>fallbackIcon</code> instead.

getGroups

Gets content of aggregation groups.

QuickViewGroup consists of a title (optional) and an entity of group elements.

getHeader

Gets current value of property header.

Specifies the text displayed in the header of the control.

Default value is empty string.

getIcon

Gets current value of property icon.

Specifies the URL of the icon or image displayed under the header of the page.

Default value is empty string.

Since 1.92 Use the <code>avatar</code> aggregation instead.

sap.m.QuickViewPage.getMetadata

Returns a metadata object for class sap.m.QuickViewPage.

getPageId

Gets current value of property pageId.

Page id

Default value is empty string.

getTitle

Gets current value of property title.

Specifies the text displayed in the header of the content section of the control.

Default value is empty string.

getTitleUrl

Gets current value of property titleUrl.

Specifies the URL which opens when the title or the avatar is clicked. Note: If the avatar has press listeners this URL is not opened automatically.

Default value is empty string.

indexOfGroup

Checks for the provided sap.m.QuickViewGroup in the aggregation groups. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oGroup sap.m.QuickViewGroup

The group whose index is looked for

insertGroup

Inserts a group into the aggregation groups.

Param Type DefaultValue Description
oGroup sap.m.QuickViewGroup

The group to insert; if empty, nothing is inserted

iIndex int

The 0-based index the group should be inserted at; for a negative value of iIndex, the group is inserted at position 0; for a value greater than the current size of the aggregation, the group is inserted at the last position

removeAllGroups

Removes all the controls from the aggregation groups.

Additionally, it unregisters them from the hosting UIArea.

removeGroup

Removes a group from the aggregation groups.

Param Type DefaultValue Description
vGroup int string sap.m.QuickViewGroup

The group to remove or its index or id

setAvatar

Sets the aggregated avatar.

Param Type DefaultValue Description
oAvatar sap.m.Avatar

The avatar to set

setCrossAppNavCallback

Sets a new value for property crossAppNavCallback.

Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oCrossAppNavCallback object

New value for property crossAppNavCallback

setDescription

Sets a new value for property description.

Specifies the text displayed under the header of the content section.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sDescription string ""

New value for property description

setFallbackIcon

Sets a new value for property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src or loading issues.

Note: Accepted values are only icons from the SAP icon font.

When called with a value of null or undefined, the default value of the property will be restored.

Since 1.92 Use the <code>avatar</code> aggregation and use its property <code>fallbackIcon</code> instead.
Param Type DefaultValue Description
sFallbackIcon sap.ui.core.URI

New value for property fallbackIcon

setHeader

Sets a new value for property header.

Specifies the text displayed in the header of the control.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sHeader string ""

New value for property header

setIcon

Sets a new value for property icon.

Specifies the URL of the icon or image displayed under the header of the page.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Since 1.92 Use the <code>avatar</code> aggregation instead.
Param Type DefaultValue Description
sIcon string ""

New value for property icon

setPageId

Sets a new value for property pageId.

Page id

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sPageId string ""

New value for property pageId

setTitle

Sets a new value for property title.

Specifies the text displayed in the header of the content section of the control.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sTitle string ""

New value for property title

setTitleUrl

Sets a new value for property titleUrl.

Specifies the URL which opens when the title or the avatar is clicked. Note: If the avatar has press listeners this URL is not opened automatically.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sTitleUrl string ""

New value for property titleUrl

unbindAvatar

Unbinds aggregation avatar from model data.

unbindGroups

Unbinds aggregation groups from model data.