class sap.ui.integration.Extension

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/integration/Extension
Application Component: CA-UI5-CTR

Brings JavaScript capabilities for an sap.ui.integration.widgets.Card where custom logic can be implemented.


Constructor

Constructor for a new Extension.

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.integration.Extension(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new extension, generated automatically if no ID is given.

mSettings? object

Initial settings for the new extension.


Properties

Name Type Default Value Description
actions sap.ui.integration.CardMenuAction[]

The actions configuration.

Visibility: public
formatters object

The formatters, which can be used in the manifest.

Visibility: public

Events Overview

Event Description
action

Fired when an action is triggered in the card.

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

action

Fired when an action is triggered in the card.

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

The card the action is fired from.

actionConfig object

The action configuration.

actionSource sap.ui.core.Control

The action source.

parameters object

The parameters related to the triggered action.

type sap.ui.integration.CardActionType

The type of the action.


Methods Overview

Method Description
attachAction

Attaches event handler fnFunction to the action event of this sap.ui.integration.Extension.

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.integration.Extension itself.

Fired when an action is triggered in the card.

detachAction

Detaches event handler fnFunction from the action event of this sap.ui.integration.Extension.

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

sap.ui.integration.Extension.extend

Creates a new subclass of class sap.ui.integration.Extension 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.base.ManagedObject.extend.

fireAction

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

getActions

Gets current value of property actions.

The actions configuration.

Since 1.85 This property is replaced by the <code>actions</code> aggregation of the card;
getCard

Returns an interface to the card, which uses this extension.

getFormatters

Gets current value of property formatters.

The formatters, which can be used in the manifest.

sap.ui.integration.Extension.getMetadata

Returns a metadata object for class sap.ui.integration.Extension.

onCardReady

Called when the card is ready.

attachAction

Attaches event handler fnFunction to the action event of this sap.ui.integration.Extension.

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.integration.Extension itself.

Fired when an action is triggered in the card.

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.ui.integration.Extension itself

detachAction

Detaches event handler fnFunction from the action event of this sap.ui.integration.Extension.

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.ui.integration.Extension.extend

Creates a new subclass of class sap.ui.integration.Extension 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.base.ManagedObject.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

fireAction

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

card sap.ui.core.Control

The card the action is fired from.

actionConfig object

The action configuration.

actionSource sap.ui.core.Control

The action source.

parameters object

The parameters related to the triggered action.

type sap.ui.integration.CardActionType

The type of the action.

getActions

Gets current value of property actions.

The actions configuration.

Since 1.85 This property is replaced by the <code>actions</code> aggregation of the card;

getCard

Returns an interface to the card, which uses this extension.

getFormatters

Gets current value of property formatters.

The formatters, which can be used in the manifest.

sap.ui.integration.Extension.getMetadata

Returns a metadata object for class sap.ui.integration.Extension.

onCardReady

Called when the card is ready.