Class sap.ui.base.EventModule: sap/ui/base/Event

extends Object
implements Poolable

An Event object consisting of an id, a source and a map of parameters
Constructor Summary
new sap.ui.base.Event(sId, oSource, mParameters)Creates an event with the given sId, linked to the provided oSource and enriched with the mParameters.
Method Summary
sap.ui.base.Event.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.base.Event with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.base.Event.getMetadata()Returns a metadata object for class sap.ui.base.Event.
cancelBubble()Cancel bubbling of the event.
getId()Returns the id of the event.
getParameter(sName)Returns the value of the parameter with the given sName.
getParameters()Returns all parameter values of the event keyed by their names.
getSource()Returns the event provider on which the event was fired.
preventDefault()Prevent the default action of this event.
Methods borrowed from class sap.ui.base.Object
Constructor Detail
new sap.ui.base.Event(sId, oSource, mParameters)
Creates an event with the given sId, linked to the provided oSource and enriched with the mParameters.
Parameters:
stringsIdThe id of the event
sap.ui.base.EventProvideroSourceThe source of the event
objectmParametersA map of parameters for this event
Method Detail
sap.ui.base.Event.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.ui.base.Event.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.base.Event.
Returns:
sap.ui.base.MetadataMetadata object describing this class
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.

getId(): string
Returns the id of the event.
Returns:
stringThe id of the event
getParameter(sName): any
Returns the value of the parameter with the given sName.
Parameters:
stringsNameThe name of the parameter to return
Returns:
anyThe value for the named parameter
getParameters(): map
Returns all parameter values of the event keyed by their names.
Returns:
mapAll parameters of the event keyed by name
Returns the event provider on which the event was fired.
Returns:
sap.ui.base.EventProviderThe source of the event
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.