| Function |
Defined By |
|
EventDispatcher()
|
[Constructor] EventDispatcher
|
Creates new EventDispatcher instance.
|
|
|
addEventListener(type, callback)
|
EventDispatcher
|
Registers an event lister function to be called when an event occurs.
| |
type : String
String representing the event type.
|
| |
callback : Function
Function to be called when the event occurs.
|
|
|
|
dispatchEvent(event)
|
EventDispatcher
|
Dispatches an event to be processed by registered event listeners. The Event's target is the
EventDispatcher which called dispatchEvent. The Event will be cloned prior to passing to callback functions
to ensure the callback cannot modify the Event data or properties. You can check if the event was canceled
by calling the Event's getIsCanceled after dispatching it. Re-dispatching the same event will re-set its canceled state to false.
| |
event : DispatcherEvent
The DispatcherEvent class or subclass to be dispatched.
|
|
|
|
hasEventListener(type, callback)
|
EventDispatcher
|
Checks if an event listener has been registered with this EventDispatcher
| |
type : String
String representing the event type.
|
| |
callback : Function
Function callback to be called when the event occurs. This may be null to check if the EventDispatcher has any events registered for the provided type.
|
| |
returns : boolean
Returns true if the EventDispatcher has the provided callback registered for the provided type, or any callback for the provided type if the callback parameter is null. Otherwise, returns false.
|
|
|
|
removeEventListener(type, callback)
|
EventDispatcher
|
Removes a callback from the EventDispatcher
| |
type : String
String representing the event type.
|
| |
callback : Function
Function callback to be removed.
|
| |
returns : boolean
Returns true if the callback was successfully removed, otherwise false such as if the function callback was not previously registered.
|
|
|
| Function |
Defined By |
|
EventDispatcher()
|
[Constructor] EventDispatcher
|
Creates new EventDispatcher instance.
|
|
|
addEventListener(type, callback)
|
EventDispatcher
|
Registers an event lister function to be called when an event occurs.
| |
type : String
String representing the event type.
|
| |
callback : Function
Function to be called when the event occurs.
|
|
|
|
dispatchEvent(event)
|
EventDispatcher
|
Dispatches an event to be processed by registered event listeners. The Event's target is the
EventDispatcher which called dispatchEvent. The Event will be cloned prior to passing to callback functions
to ensure the callback cannot modify the Event data or properties. You can check if the event was canceled
by calling the Event's getIsCanceled after dispatching it. Re-dispatching the same event will re-set its canceled state to false.
| |
event : DispatcherEvent
The DispatcherEvent class or subclass to be dispatched.
|
|
|
|
hasEventListener(type, callback)
|
EventDispatcher
|
Checks if an event listener has been registered with this EventDispatcher
| |
type : String
String representing the event type.
|
| |
callback : Function
Function callback to be called when the event occurs. This may be null to check if the EventDispatcher has any events registered for the provided type.
|
| |
returns : boolean
Returns true if the EventDispatcher has the provided callback registered for the provided type, or any callback for the provided type if the callback parameter is null. Otherwise, returns false.
|
|
|
|
removeEventListener(type, callback)
|
EventDispatcher
|
Removes a callback from the EventDispatcher
| |
type : String
String representing the event type.
|
| |
callback : Function
Function callback to be removed.
|
| |
returns : boolean
Returns true if the callback was successfully removed, otherwise false such as if the function callback was not previously registered.
|
|
|