The type of the data field on this event. If not given, will set the type
to undefined (no data field)
A union type of the possible string literals that are possibilities for the
type property. If not set, will default to string (allows for all strings)
The event type
The data to attach to the event
see AbstractEvent
see AbstractEvent
see AbstractEvent
If true, the event will also go through a bubbling phase. See EventDispatcher.dispatchEvent for more information on the event phases.
Indicates if preventDefault can be called on this event. This will prevent the 'default
action' of the event from being executed. It is up to the EventDispatcher instance that dispatches the
event to stop the default action from executing when the dispatchEvent
method returns false
Will be updated by EventDispatcher during the dispatch of an event to the target that
listeners are currently being called on. After completion of an event dispatch this value
will be reset to null.
true if cancelable is true and preventDefault has been called on this event.
The current event phase of this event. During event dispatch, this value will be either CAPTURING_PHASE, AT_TARGET or BUBBLING_PHASE. If this event is not currently being dispatched this will be set to NONE.
Will be updated by EventDispatcher when dispatchEvent is called with this event. The value will be set to the EventDispatcher instance that dispatched the event.
Indicates the time this event is dispatched in the number of milliseconds elapsed since
1 January 1970 00:00:00 UTC. This value will only be set if the setTimestamp parameter in the constructor
is set to true. Otherwise, this value will be 0.
Calls the given event handler, and returns an enum value that indicates if stopPropagation or stopImmediatePropagation have been called on this event during the execution of that handler.
The event handler to execute
An enum value, see CallListenerResult
May only be called when the cancelable property of an event is set to true. Indicates to the
instance that dispatched the event that the default action for the event should not be executed.
When called during the dispatch of an event, will prevent any other event listener from being called for this event.
When called during the dispatch of an event, will prevent any targets further in the event chain from being processed. All listeners on the current target will still be executed.
Generated using TypeDoc
Base class for classes generated by createEventClass. Thin abstraction of AbstractEvent that adds an additional typed
datafield to events.