class sap.m.QuickViewBase

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

QuickViewBase class provides base functionality for QuickView and QuickViewCard. Do not use it directly.


Constructor

Constructor for a new QuickViewBase.

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.QuickViewBase(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


Aggregations

Default Aggregation: pages

Name Cardinality Type Description
pages (default) 0..n sap.m.QuickViewPage

Displays a page header, object icon or image, object name with short description, and object information divided in groups


Events Overview

Event Description
afterNavigate

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.

navigate

The event is fired when navigation between two pages has been triggered. The transition (if any) to the new page has not started yet.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object.

afterNavigate

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.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
from sap.ui.core.Control

Determines the page, which has been displayed before navigation.

fromId string

Determines the ID of the page, which has been displayed before navigation.

to sap.ui.core.Control

Determines the page, which is now displayed after navigation.

toId string

Determines the ID of the page, which is now displayed after navigation.

firstTime boolean

Determines whether the "to" page (a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.

isTo boolean

Determines whether this was a forward navigation.

isBack boolean

Determines whether this was a back navigation.

isBackToTop boolean

Determines whether this was a navigation to the root page.

isBackToPage boolean

Determines whether this was a navigation to a specific page.

direction string

Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

isTopPage boolean

Determines whether this is a navigation to the top page.

navOrigin sap.ui.core.Control

Determines which link initiated the navigation.

navigate

The event is fired when navigation between two pages has been triggered. The transition (if any) to the new page has not started yet.

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
from sap.ui.core.Control

The page which was displayed before the current navigation.

fromId string

The ID of the page which was displayed before the current navigation.

to sap.ui.core.Control

The page which will be displayed after the current navigation.

toId string

The ID of the page which will be displayed after the current navigation.

firstTime boolean

Determines whether the "to" page (a control with the ID of the page which is currently navigated to) has not been displayed/navigated to before.

isTo boolean

Determines whether this is a forward navigation.

isBack boolean

Determines whether this is a back navigation.

isBackToTop boolean

Determines whether this is a navigation to the root page.

isBackToPage boolean

Determines whether this was a navigation to a specific page.

direction string

Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

navOrigin sap.ui.core.Control

Determines which link initiated the navigation.


Methods Overview

Method Description
addPage

Adds some page to the aggregation pages.

attachAfterNavigate

Attaches event handler fnFunction to the afterNavigate event of this sap.m.QuickViewBase.

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.m.QuickViewBase 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.

attachNavigate

Attaches event handler fnFunction to the navigate event of this sap.m.QuickViewBase.

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.m.QuickViewBase 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.

bindPages

Binds aggregation pages to model data.

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

destroyPages

Destroys all the pages in the aggregation pages.

detachAfterNavigate

Detaches event handler fnFunction from the afterNavigate event of this sap.m.QuickViewBase.

The passed function and listener object must match the ones used for event registration.

detachNavigate

Detaches event handler fnFunction from the navigate event of this sap.m.QuickViewBase.

The passed function and listener object must match the ones used for event registration.

sap.m.QuickViewBase.extend

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

fireAfterNavigate

Fires event afterNavigate to attached listeners.

fireNavigate

Fires event navigate 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.

sap.m.QuickViewBase.getMetadata

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

getPages

Gets content of aggregation pages.

Displays a page header, object icon or image, object name with short description, and object information divided in groups

indexOfPage

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

insertPage

Inserts a page into the aggregation pages.

navigateBack

Navigates to the previous page if there is such.

removeAllPages

Removes all the controls from the aggregation pages.

Additionally, it unregisters them from the hosting UIArea.

removePage

Removes a page from the aggregation pages.

unbindPages

Unbinds aggregation pages from model data.

addPage

Adds some page to the aggregation pages.

Param Type DefaultValue Description
oPage sap.m.QuickViewPage

The page to add; if empty, nothing is inserted

attachAfterNavigate

Attaches event handler fnFunction to the afterNavigate event of this sap.m.QuickViewBase.

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.m.QuickViewBase 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.

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 sap.m.QuickViewBase itself

attachNavigate

Attaches event handler fnFunction to the navigate event of this sap.m.QuickViewBase.

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.m.QuickViewBase 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.

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 sap.m.QuickViewBase itself

bindPages

Binds aggregation pages 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

destroyPages

Destroys all the pages in the aggregation pages.

detachAfterNavigate

Detaches event handler fnFunction from the afterNavigate event of this sap.m.QuickViewBase.

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

detachNavigate

Detaches event handler fnFunction from the navigate event of this sap.m.QuickViewBase.

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

sap.m.QuickViewBase.extend

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

fireAfterNavigate

Fires event afterNavigate to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

from sap.ui.core.Control

Determines the page, which has been displayed before navigation.

fromId string

Determines the ID of the page, which has been displayed before navigation.

to sap.ui.core.Control

Determines the page, which is now displayed after navigation.

toId string

Determines the ID of the page, which is now displayed after navigation.

firstTime boolean

Determines whether the "to" page (a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.

isTo boolean

Determines whether this was a forward navigation.

isBack boolean

Determines whether this was a back navigation.

isBackToTop boolean

Determines whether this was a navigation to the root page.

isBackToPage boolean

Determines whether this was a navigation to a specific page.

direction string

Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

isTopPage boolean

Determines whether this is a navigation to the top page.

navOrigin sap.ui.core.Control

Determines which link initiated the navigation.

fireNavigate

Fires event navigate 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

from sap.ui.core.Control

The page which was displayed before the current navigation.

fromId string

The ID of the page which was displayed before the current navigation.

to sap.ui.core.Control

The page which will be displayed after the current navigation.

toId string

The ID of the page which will be displayed after the current navigation.

firstTime boolean

Determines whether the "to" page (a control with the ID of the page which is currently navigated to) has not been displayed/navigated to before.

isTo boolean

Determines whether this is a forward navigation.

isBack boolean

Determines whether this is a back navigation.

isBackToTop boolean

Determines whether this is a navigation to the root page.

isBackToPage boolean

Determines whether this was a navigation to a specific page.

direction string

Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

navOrigin sap.ui.core.Control

Determines which link initiated the navigation.

sap.m.QuickViewBase.getMetadata

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

getPages

Gets content of aggregation pages.

Displays a page header, object icon or image, object name with short description, and object information divided in groups

indexOfPage

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

Param Type DefaultValue Description
oPage sap.m.QuickViewPage

The page whose index is looked for

insertPage

Inserts a page into the aggregation pages.

Param Type DefaultValue Description
oPage sap.m.QuickViewPage

The page to insert; if empty, nothing is inserted

iIndex int

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

navigateBack

Navigates to the previous page if there is such.

removeAllPages

Removes all the controls from the aggregation pages.

Additionally, it unregisters them from the hosting UIArea.

removePage

Removes a page from the aggregation pages.

Param Type DefaultValue Description
vPage int string sap.m.QuickViewPage

The page to remove or its index or id

unbindPages

Unbinds aggregation pages from model data.