mxEventObject

The mxEventObject is a wrapper for all properties of a single event.  Additionally, it also offers functions to consume the event and check if it was consumed as follows:

evt.consume();
INV: evt.isConsumed() == true
Summary
mxEventObjectThe mxEventObject is a wrapper for all properties of a single event.
Functions
mxEventObjectConstructs a new event object with the specified name.
Variables
nameHolds the name.
propertiesHolds the properties as an associative array.
consumedHolds the consumed state.
Functions
getNameReturns name.
getPropertiesReturns properties.
getPropertyReturns the property for the given key.
isConsumedReturns true if the event has been consumed.
consumeConsumes the event.

Functions

mxEventObject

function mxEventObject(name)

Constructs a new event object with the specified name.  An optional sequence of key, value pairs can be appended to define properties.

Example

new mxEventObject("eventName", key1, val1, .., keyN, valN)

Variables

name

mxEventObject.prototype.name

Holds the name.

properties

mxEventObject.prototype.properties

Holds the properties as an associative array.

consumed

mxEventObject.prototype.consumed

Holds the consumed state.  Default is false.

Functions

getName

mxEventObject.prototype.getName = function()

Returns name.

getProperties

mxEventObject.prototype.getProperties = function()

Returns properties.

getProperty

mxEventObject.prototype.getProperty = function(key)

Returns the property for the given key.

isConsumed

mxEventObject.prototype.isConsumed = function()

Returns true if the event has been consumed.

consume

mxEventObject.prototype.consume = function()

Consumes the event.

function mxEventObject(name)
Constructs a new event object with the specified name.
mxEventObject.prototype.name
Holds the name.
mxEventObject.prototype.properties
Holds the properties as an associative array.
mxEventObject.prototype.consumed
Holds the consumed state.
mxEventObject.prototype.getName = function()
Returns name.
mxEventObject.prototype.getProperties = function()
Returns properties.
mxEventObject.prototype.getProperty = function(key)
Returns the property for the given key.
mxEventObject.prototype.isConsumed = function()
Returns true if the event has been consumed.
mxEventObject.prototype.consume = function()
Consumes the event.
Close