mxEventSource
Base class for objects that dispatch named events. To create a subclass that inherits from mxEventSource, the following code is used.
function MyClass() { };
MyClass.prototype = new mxEventSource();
MyClass.prototype.constructor = MyClass;
Known Subclasses
mxGraphModel, mxGraph, mxGraphView, mxEditor, mxCellOverlay, mxToolbar, mxWindow
mxEventSource
| function mxEventSource( | eventSource | ) |
|
Constructs a new event source.
eventListeners
| mxEventSource.prototype.eventListeners |
Holds the event names and associated listeners in an array. The array contains the event name followed by the respective listener for each registered listener.
eventsEnabled
| mxEventSource.prototype.eventsEnabled |
Specifies if events can be fired. Default is true.
eventSource
| mxEventSource.prototype.eventSource |
Optional source for events. Default is null.
isEventsEnabled
| mxEventSource.prototype.isEventsEnabled = function() |
Returns eventsEnabled.
setEventsEnabled
| mxEventSource.prototype.setEventsEnabled = function( | value | ) |
|
Sets eventsEnabled.
getEventSource
| mxEventSource.prototype.getEventSource = function() |
Returns eventSource.
setEventSource
| mxEventSource.prototype.setEventSource = function( | value | ) |
|
Sets eventSource.
addListener
| mxEventSource.prototype.addListener = function( | name, | | funct | ) |
|
Binds the specified function to the given event name. If no event name is given, then the listener is registered for all events.
The parameters of the listener are the sender and an mxEventObject.
removeListener
| mxEventSource.prototype.removeListener = function( | funct | ) |
|
Removes all occurrences of the given listener from eventListeners.
fireEvent
| mxEventSource.prototype.fireEvent = function( | evt, | | sender | ) |
|
Dispatches the given event to the listeners which are registered for the event. The sender argument is optional. The current execution scope (“this”) is used for the listener invocation (see mxUtils.bind).
Example
fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN))
Parameters
| evt | mxEventObject that represents the event. |
| sender | Optional sender to be passed to the listener. Default value is the return value of getEventSource. |