Packagestarling.events
Classpublic class EventDispatcher
InheritanceEventDispatcher Inheritance Object
Subclasses DisplayObject

The EventDispatcher class is the base class for all classes that dispatch events. This is the Starling version of the Flash class with the same name.

The event mechanism is a key feature of Starling's architecture. Objects can communicate with each other through events. Compared the the Flash event system, Starling's event system was simplified. The main difference is that Starling events have no "Capture" phase. They are simply dispatched at the target and may optionally bubble up. They cannot move in the opposite direction.

As in the conventional Flash classes, display objects inherit from EventDispatcher and can thus dispatch events. Beware, though, that the Starling event classes are not compatible with Flash events: Starling display objects dispatch Starling events, which will bubble along Starling display objects - but they cannot dispatch Flash events or bubble along Flash display objects.

See also

Event
DisplayObject


Public Methods
 MethodDefined By
  
Creates an EventDispatcher.
EventDispatcher
  
addEventListener(type:String, listener:Function):void
Registers an event listener at a certain object.
EventDispatcher
  
dispatchEvent(event:Event):void
Dispatches an event to all objects that have registered for events of the same type.
EventDispatcher
  
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
  
removeEventListener(type:String, listener:Function):void
Removes an event listener from the object.
EventDispatcher
  
removeEventListeners(type:String = null):void
Removes all event listeners with a certain type, or all of them if type is null.
EventDispatcher
Constructor Detail
EventDispatcher()Constructor
public function EventDispatcher()

Creates an EventDispatcher.

Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function):void

Registers an event listener at a certain object.

Parameters

type:String
 
listener:Function

dispatchEvent()method 
public function dispatchEvent(event:Event):void

Dispatches an event to all objects that have registered for events of the same type.

Parameters

event:Event

hasEventListener()method 
public function hasEventListener(type:String):Boolean

Returns if there are listeners registered for a certain event type.

Parameters

type:String

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function):void

Removes an event listener from the object.

Parameters

type:String
 
listener:Function

removeEventListeners()method 
public function removeEventListeners(type:String = null):void

Removes all event listeners with a certain type, or all of them if type is null. Be careful when removing all event listeners: you never know who else was listening.

Parameters

type:String (default = null)