mxEventObject

Base class for all events.

Summary

mxEventObject	Base class for all events.
Variables
name	Holds the name of the event.
properties	Holds the event properties in an associative array that maps from string (key) to object (value).
consumed	Holds the consumed state of the event.
Functions
mxEventObject	Constructs a new event for the given name and properties.
getName	Returns name.
getProperties	Returns properties.
getProperty	Returns the property value for the given key.
isConsumed	Returns true if the event has been consumed.
consume	Consumes the event.

Variables

name

var $name

Holds the name of the event.

properties

var $properties

Holds the event properties in an associative array that maps from string (key) to object (value).

consumed

var $consumed

Holds the consumed state of the event. Default is false.

Functions

mxEventObject

function mxEventObject( $name )

Constructs a new event for the given name and properties. The optional properties are specified using a sequence of keys and values, eg. new mxEventObject($name, $key1, $value1, $key2, $value2, .., $keyN, $valueN)

getName

function getName()

Returns name.

getProperties

function getProperties()

Returns properties.

getProperty

function getProperty( $key )

Returns the property value for the given key.

isConsumed

function isConsumed()

Returns true if the event has been consumed.

consume

function consume()

Consumes the event.