QuickViewPage

extends Control

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

Since: 1.28.11.

Constructor Summary

new sap.m.QuickViewPage(sId?, mSettings?)Constructor for a new QuickViewPage.

Events borrowed from class sap.ui.core.Control

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.m.QuickViewPage.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.QuickViewPage with name sClassName and enriches it with the information contained in oClassInfo.

sap.m.QuickViewPage.getMetadata()Returns a metadata object for class sap.m.QuickViewPage.

addGroup(oGroup)Adds some group to the aggregation groups.

bindGroups(oBindingInfo)Binds aggregation groups to model data.

destroyGroups()Destroys all the groups in the aggregation groups.

getCrossAppNavCallback()Gets current value of property crossAppNavCallback.

getDescription()Gets current value of property description.

getGroups()Gets content of aggregation groups.

getHeader()Gets current value of property header.

getIcon()Gets current value of property icon.

getPageId()Gets current value of property pageId.

getTitle()Gets current value of property title.

getTitleUrl()Gets current value of property titleUrl.

indexOfGroup(oGroup)Checks for the provided sap.m.QuickViewGroup in the aggregation groups.

insertGroup(oGroup, iIndex)Inserts a group into the aggregation groups.

removeAllGroups()Removes all the controls from the aggregation groups.

removeGroup(vGroup)Removes a group from the aggregation groups.

setCrossAppNavCallback(oCrossAppNavCallback)Sets a new value for property crossAppNavCallback.

setDescription(sDescription)Sets a new value for property description.

setHeader(sHeader)Sets a new value for property header.

setIcon(sIcon)Sets a new value for property icon.

setPageId(sPageId)Sets a new value for property pageId.

setTitle(sTitle)Sets a new value for property title.

setTitleUrl(sTitleUrl)Sets a new value for property titleUrl.

unbindGroups()Unbinds aggregation groups from model data.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.m.QuickViewPage(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

Properties
- pageId : string (default: )
- header : string (default: )
- title : string (default: )
- titleUrl : string (default: )
- crossAppNavCallback : object
- description : string (default: )
- icon : string (default: )
Aggregations
- groups : sap.m.QuickViewGroup[] (default)

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:

{string}	sId?	ID for the new control, generated automatically if no ID is given
{object}	mSettings?	Initial settings for the new control

Method Detail

sap.m.QuickViewPage.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.m.QuickViewPage.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addGroup(oGroup): sap.m.QuickViewPage

Adds some group to the aggregation groups.

Parameters:

{sap.m.QuickViewGroup}

oGroup

the group to add; if empty, nothing is inserted

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

bindGroups(oBindingInfo): sap.m.QuickViewPage

Binds aggregation groups to model data.

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

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

destroyGroups(): sap.m.QuickViewPage

Destroys all the groups in the aggregation groups.

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

getCrossAppNavCallback(): object

Gets current value of property crossAppNavCallback.

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

Returns:

{object} Value of property crossAppNavCallback

getDescription(): string

Gets current value of property description.

Specifies the text displayed under the header of the content section

Default value is .

Returns:

{string} Value of property description

getGroups(): sap.m.QuickViewGroup[]

Gets content of aggregation groups.

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

Returns:

{sap.m.QuickViewGroup[]}

getHeader(): string

Gets current value of property header.

Specifies the text displayed in the header of the control.

Default value is .

Returns:

{string} Value of property header

getIcon(): string

Gets current value of property icon.

Specifies the URL of the icon displayed under the header of the page

Default value is .

Returns:

{string} Value of property icon

getPageId(): string

Gets current value of property pageId.

Page id

Default value is .

Returns:

{string} Value of property pageId

getTitle(): string

Gets current value of property title.

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

Default value is .

Returns:

{string} Value of property title

getTitleUrl(): string

Gets current value of property titleUrl.

Specifies the URL which opens when the title or the thumbnail is clicked.

Default value is .

Returns:

{string} Value of property titleUrl

indexOfGroup(oGroup): int

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

Parameters:

{sap.m.QuickViewGroup}

oGroup

The group whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertGroup(oGroup, iIndex): sap.m.QuickViewPage

Inserts a group into the aggregation groups.

Parameters:

{sap.m.QuickViewGroup}	oGroup	the group to insert; if empty, nothing is inserted
{int}	iIndex	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

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

removeAllGroups(): sap.m.QuickViewGroup[]

Removes all the controls from the aggregation groups.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.m.QuickViewGroup[]}

An array of the removed elements (might be empty)

removeGroup(vGroup): sap.m.QuickViewGroup

Removes a group from the aggregation groups.

Parameters:

{int|string|sap.m.QuickViewGroup}

vGroup

The groupto remove or its index or id

Returns:

{sap.m.QuickViewGroup} The removed group or null

setCrossAppNavCallback(oCrossAppNavCallback): sap.m.QuickViewPage

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.

Parameters:

{object} oCrossAppNavCallback New value for property crossAppNavCallback

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

setDescription(sDescription): sap.m.QuickViewPage

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 .

Parameters:

{string} sDescription New value for property description

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

setHeader(sHeader): sap.m.QuickViewPage

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 .

Parameters:

{string} sHeader New value for property header

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

setIcon(sIcon): sap.m.QuickViewPage

Sets a new value for property icon.

Specifies the URL of the icon 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 .

Parameters:

{string} sIcon New value for property icon

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

setPageId(sPageId): sap.m.QuickViewPage

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 .

Parameters:

{string} sPageId New value for property pageId

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

setTitle(sTitle): sap.m.QuickViewPage

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 .

Parameters:

{string} sTitle New value for property title

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

setTitleUrl(sTitleUrl): sap.m.QuickViewPage

Sets a new value for property titleUrl.

Specifies the URL which opens when the title or the thumbnail is clicked.

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

Default value is .

Parameters:

{string} sTitleUrl New value for property titleUrl

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining

unbindGroups(): sap.m.QuickViewPage

Unbinds aggregation groups from model data.

Returns:

{sap.m.QuickViewPage} Reference to this in order to allow method chaining