Class sap.m.QuickViewBaseModule: sap/m/QuickViewBase

extends Control
known direct subclasses: QuickView, QuickViewCard

QuickViewBase class provides base functionality for QuickView and QuickViewCard. Do not use it directly.
Since: 1.28.11.
Constructor Summary
new sap.m.QuickViewBase(sId?, mSettings?)Constructor for a new QuickViewBase.
Event Summary
afterNavigate(oControlEvent)The event is fired when navigation between two pages has completed.
navigate(oControlEvent)The event is fired when navigation between two pages has been triggered.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.QuickViewBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.QuickViewBase with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.QuickViewBase.getMetadata()Returns a metadata object for class sap.m.QuickViewBase.
addPage(oPage)Adds some page to the aggregation pages.
attachAfterNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterNavigate event of this sap.m.QuickViewBase.
attachNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the navigate event of this sap.m.QuickViewBase.
bindPages(oBindingInfo)Binds aggregation pages to model data.
destroyPages()Destroys all the pages in the aggregation pages.
detachAfterNavigate(fnFunction, oListener)Detaches event handler fnFunction from the afterNavigate event of this sap.m.QuickViewBase.
detachNavigate(fnFunction, oListener)Detaches event handler fnFunction from the navigate event of this sap.m.QuickViewBase.
fireAfterNavigate(mParameters?)Fires event afterNavigate to attached listeners.
fireNavigate(mParameters?)Fires event navigate to attached listeners.
getPages()Gets content of aggregation pages.
indexOfPage(oPage)Checks for the provided sap.m.QuickViewPage in the aggregation pages.
insertPage(oPage, iIndex)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.
removePage(vPage)Removes a page from the aggregation pages.
unbindPages()Unbinds aggregation pages from model data.
Constructor Detail
new sap.m.QuickViewBase(sId?, mSettings?)

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

The supported settings are:

  • Aggregations

    • pages : sap.m.QuickViewPage[] (default)

  • Events

    • navigate : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • afterNavigate : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Event Detail
afterNavigate(oControlEvent)
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.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.fromDetermines the page, which has been displayed before navigation.
stringoControlEvent.getParameters.fromIdDetermines the ID of the page, which has been displayed before navigation.
sap.ui.core.ControloControlEvent.getParameters.toDetermines the page, which is now displayed after navigation.
stringoControlEvent.getParameters.toIdDetermines the ID of the page, which is now displayed after navigation.
booleanoControlEvent.getParameters.firstTimeDetermines whether the "to" page (a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.
booleanoControlEvent.getParameters.isToDetermines whether this was a forward navigation.
booleanoControlEvent.getParameters.isBackDetermines whether this was a back navigation.
booleanoControlEvent.getParameters.isBackToTopDetermines whether this was a navigation to the root page.
booleanoControlEvent.getParameters.isBackToPageDetermines whether this was a navigation to a specific page.
stringoControlEvent.getParameters.directionDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
booleanoControlEvent.getParameters.isTopPageDetermines whether this is a navigation to the top page.
sap.ui.core.ControloControlEvent.getParameters.navOriginDetermines which link initiated the navigation.
navigate(oControlEvent)
The event is fired when navigation between two pages has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.fromThe page which was displayed before the current navigation.
stringoControlEvent.getParameters.fromIdThe ID of the page which was displayed before the current navigation.
sap.ui.core.ControloControlEvent.getParameters.toThe page which will be displayed after the current navigation.
stringoControlEvent.getParameters.toIdThe ID of the page which will be displayed after the current navigation.
booleanoControlEvent.getParameters.firstTimeDetermines whether the "to" page (a control with the ID of the page which is currently navigated to) has not been displayed/navigated to before.
booleanoControlEvent.getParameters.isToDetermines whether this is a forward navigation.
booleanoControlEvent.getParameters.isBackDetermines whether this is a back navigation.
booleanoControlEvent.getParameters.isBackToTopDetermines whether this is a navigation to the root page.
booleanoControlEvent.getParameters.isBackToPageDetermines whether this was a navigation to a specific page.
stringoControlEvent.getParameters.directionDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
sap.ui.core.ControloControlEvent.getParameters.navOriginDetermines which link initiated the navigation.
Method Detail
sap.m.QuickViewBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.QuickViewBase.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.QuickViewBase.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addPage(oPage): sap.m.QuickViewBase
Adds some page to the aggregation pages.
Parameters:
sap.m.QuickViewPageoPagethe page to add; if empty, nothing is inserted
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
attachAfterNavigate(oData?, fnFunction, oListener?): sap.m.QuickViewBase

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.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.QuickViewBase itself
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
attachNavigate(oData?, fnFunction, oListener?): sap.m.QuickViewBase

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. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.QuickViewBase itself
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
bindPages(oBindingInfo): sap.m.QuickViewBase

Binds aggregation pages to model data.

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

Parameters:
objectoBindingInfoThe binding information
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
destroyPages(): sap.m.QuickViewBase
Destroys all the pages in the aggregation pages.
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
detachAfterNavigate(fnFunction, oListener): sap.m.QuickViewBase

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
detachNavigate(fnFunction, oListener): sap.m.QuickViewBase

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
fireAfterNavigate(mParameters?): sap.m.QuickViewBase
Fires event afterNavigate to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.from?Determines the page, which has been displayed before navigation.
stringmParameters.fromId?Determines the ID of the page, which has been displayed before navigation.
sap.ui.core.ControlmParameters.to?Determines the page, which is now displayed after navigation.
stringmParameters.toId?Determines the ID of the page, which is now displayed after navigation.
booleanmParameters.firstTime?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.
booleanmParameters.isTo?Determines whether this was a forward navigation.
booleanmParameters.isBack?Determines whether this was a back navigation.
booleanmParameters.isBackToTop?Determines whether this was a navigation to the root page.
booleanmParameters.isBackToPage?Determines whether this was a navigation to a specific page.
stringmParameters.direction?Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
booleanmParameters.isTopPage?Determines whether this is a navigation to the top page.
sap.ui.core.ControlmParameters.navOrigin?Determines which link initiated the navigation.
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
fireNavigate(mParameters?): boolean

Fires event navigate to attached listeners.

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

Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.from?The page which was displayed before the current navigation.
stringmParameters.fromId?The ID of the page which was displayed before the current navigation.
sap.ui.core.ControlmParameters.to?The page which will be displayed after the current navigation.
stringmParameters.toId?The ID of the page which will be displayed after the current navigation.
booleanmParameters.firstTime?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.
booleanmParameters.isTo?Determines whether this is a forward navigation.
booleanmParameters.isBack?Determines whether this is a back navigation.
booleanmParameters.isBackToTop?Determines whether this is a navigation to the root page.
booleanmParameters.isBackToPage?Determines whether this was a navigation to a specific page.
stringmParameters.direction?Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
sap.ui.core.ControlmParameters.navOrigin?Determines which link initiated the navigation.
Returns:
booleanWhether or not to prevent the default action
getPages(): sap.m.QuickViewPage[]

Gets content of aggregation pages.

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

Returns:
sap.m.QuickViewPage[]
indexOfPage(oPage): int
Checks for the provided sap.m.QuickViewPage in the aggregation pages. and returns its index if found or -1 otherwise.
Parameters:
sap.m.QuickViewPageoPageThe page whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertPage(oPage, iIndex): sap.m.QuickViewBase
Inserts a page into the aggregation pages.
Parameters:
sap.m.QuickViewPageoPagethe page to insert; if empty, nothing is inserted
intiIndexthe 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
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining
removeAllPages(): sap.m.QuickViewPage[]

Removes all the controls from the aggregation pages.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.QuickViewPage[]An array of the removed elements (might be empty)
removePage(vPage): sap.m.QuickViewPage
Removes a page from the aggregation pages.
Parameters:
int|string|sap.m.QuickViewPagevPageThe page to remove or its index or id
Returns:
sap.m.QuickViewPageThe removed page or null
unbindPages(): sap.m.QuickViewBase
Unbinds aggregation pages from model data.
Returns:
sap.m.QuickViewBaseReference to this in order to allow method chaining