| Package | sekati.events |
| Class | public final class ApplicationEventDispatcher |
var e : FormEvent ( FormEvent.USER_SUBMIT, {name:"sekati", phone:"+1.555.555.5555" confirm:true} ); // FormEvent inherits from sekati.events.ApplicationEvent.
ApplicationEventDispatcher.$.dispatchEvent ( e );
See also
| Property | Defined by | ||
|---|---|---|---|
| $ : ApplicationEventDispatcher
[static][read-only]
Shorthand singleton accessor getter
| ApplicationEventDispatcher | ||
| Method | Defined by | ||
|---|---|---|---|
|
ApplicationEventDispatcher($:SingletonEnforcer = null, target:IEventDispatcher = null)
ApplicationEventDispatcher Singleton Constructor
| ApplicationEventDispatcher | ||
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an
ApplicationEvent listener with the ApplicationEventDispatcher singleton so that the listener receives notification of that
ApplicationEvent (or ApplicationEvent descendent). | ApplicationEventDispatcher | ||
|
dispatchEvent(event:ApplicationEvent):Boolean
Dispatches an
ApplicationEvent into the event flow. | ApplicationEventDispatcher | ||
|
[static]
Singleton Accessor
| ApplicationEventDispatcher | ||
|
hasEventListener(type:String):Boolean
Checks whether the
ApplicationEventDispatcher has any listeners registered for a specific type of event. | ApplicationEventDispatcher | ||
|
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the
ApplicationEventDispatcher singleton. | ApplicationEventDispatcher | ||
|
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this
ApplicationEventDispatcher for the specified event type. | ApplicationEventDispatcher | ||
| $ | property |
$:ApplicationEventDispatcher [read-only]Shorthand singleton accessor getter
Implementation public static function get $():ApplicationEventDispatcher
| ApplicationEventDispatcher | () | constructor |
public function ApplicationEventDispatcher($:SingletonEnforcer = null, target:IEventDispatcher = null)ApplicationEventDispatcher Singleton Constructor
Parameters$:SingletonEnforcer (default = null) |
|
target:IEventDispatcher (default = null) |
| addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an ApplicationEvent listener with the ApplicationEventDispatcher singleton so that the listener receives notification of that
ApplicationEvent (or ApplicationEvent descendent).
When you no longer need an event listener, remove it by calling ApplicationEventDispatcher.$.removeEventListener() otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.
type:String — The type (name) of event.
|
|
listener:Function — The listener function that processes the event. This function must accept an ApplicationEvent object as its only parameter and must return nothing,
|
|
useCapture:Boolean (default = false) |
|
priority:int (default = 0) |
|
useWeakReference:Boolean (default = true) |
| dispatchEvent | () | method |
public function dispatchEvent(event:ApplicationEvent):Boolean
Dispatches an ApplicationEvent into the event flow. The event target is the ApplicationEventDispatcher singleton upon which dispatchEvent() is called.
event:ApplicationEvent — The ApplicationEvent (or ApplicationEvent descendent) object dispatched into the event flow.
|
Boolean — Boolean A value of true unless preventDefault() is called on the event, in which case it returns false.
|
| getInstance | () | method |
public static function getInstance():ApplicationEventDispatcherSingleton Accessor
ReturnsApplicationEventDispatcher —
ApplicationEventDispatcher
|
| hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Checks whether the ApplicationEventDispatcher has any listeners registered for a specific type of event. This allows you to determine where ApplicationEventDispatcher
has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs,
whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
type:String — The type of event.
|
Boolean — Boolean A value of true if a listener of the specified type is registered; otherwise false.
|
See also
| removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the ApplicationEventDispatcher singleton. If there is no matching listener registered with the ApplicationEventDispatcher a call to this method has no effect.
type:String — The type of ApplicationEvent (or ApplicationEvent descendent).
|
|
listener:Function — The listener object to remove.
|
|
useCapture:Boolean (default = false) |
| willTrigger | () | method |
public function willTrigger(type:String):Boolean
Checks whether an event listener is registered with this ApplicationEventDispatcher for the specified event type. This method returns true if an event listener is
triggered during any phase of the event flow when an event of the specified type is dispatched to the ApplicationEventDispatcher.
type:String — The type of event.
|
Boolean — Boolean A value of true if a listener of the specified type will be triggered; otherwise false.
|
See also