class sap.ui.base.Event

Control sample: sap.ui.base.Event
Visiblity: public
UX Guidelines:
Implements: sap.ui.base.Poolable
Available since: N/A
Module: sap/ui/base/Event
Application Component: CA-UI5-COR

An Event object consisting of an ID, a source and a map of parameters. Implements sap.ui.base.Poolable and therefore an event object in the event handler will be reset by sap.ui.base.ObjectPool after the event handler is done.


Constructor

Creates an event with the given sId, linked to the provided oSource and enriched with the mParameters.

new sap.ui.base.Event(sId, oSource, oParameters)
Param Type Default Value Description
sId string

The ID of the event

oSource sap.ui.base.EventProvider

Source of the event

oParameters object

Parameters for this event


Methods Overview

Method Description
cancelBubble

Cancel bubbling of the event.

Note: This function only has an effect if the bubbling of the event is supported by the event source.

sap.ui.base.Event.extend

Creates a new subclass of class sap.ui.base.Event 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.Object.extend.

getId

Returns the id of the event.

sap.ui.base.Event.getMetadata

Returns a metadata object for class sap.ui.base.Event.

getParameter

Returns the value of the parameter with the given name.

getParameters

Returns an object with all parameter values of the event.

getSource

Returns the event provider on which the event was fired.

init

Init this event with its data.

The init method is called by an object pool when the object is (re-)activated for a new caller.

When no oParameters are given, an empty object is used instead.

References:

  • sap.ui.base.Poolable.prototype#init

preventDefault

Prevent the default action of this event.

Note: This function only has an effect if preventing the default action of the event is supported by the event source.

reset

Reset event data, needed for pooling.

References:

  • sap.ui.base.Poolable.prototype#reset

cancelBubble

Cancel bubbling of the event.

Note: This function only has an effect if the bubbling of the event is supported by the event source.

sap.ui.base.Event.extend

Creates a new subclass of class sap.ui.base.Event 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.Object.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

getId

Returns the id of the event.

sap.ui.base.Event.getMetadata

Returns a metadata object for class sap.ui.base.Event.

getParameter

Returns the value of the parameter with the given name.

Param Type DefaultValue Description
sName string

Name of the parameter to return

getParameters

Returns an object with all parameter values of the event.

getSource

Returns the event provider on which the event was fired.

init

Init this event with its data.

The init method is called by an object pool when the object is (re-)activated for a new caller.

When no oParameters are given, an empty object is used instead.

References:

Param Type DefaultValue Description
sId string

ID of the event

oSource sap.ui.base.EventProvider

Source of the event

oParameters object

The event parameters

preventDefault

Prevent the default action of this event.

Note: This function only has an effect if preventing the default action of the event is supported by the event source.

reset

Reset event data, needed for pooling.

References: