Packagestarling.events
Classpublic class Event
InheritanceEvent Inheritance Object
Subclasses EnterFrameEvent, KeyboardEvent, ResizeEvent, TouchEvent

Event objects are passed as parameters to event listeners when an event occurs. This is Starling's version of the Flash Event class.

EventDispatchers create instances of this class and send them to registered listeners. An event object contains information that characterizes an event, most importantly the event type and if the event bubbles. The target of an event is the object that dispatched it.

For some event types, this information is sufficient; other events may need additional information to be carried to the listener. In that case, you can subclass "Event" and add properties with all the information you require. The "EnterFrameEvent" is an example for this practice; it adds a property about the time that has passed since the last frame.

Furthermore, the event class contains methods that can stop the event from being processed by other listeners - either completely or at the next bubble stage.

See also

EventDispatcher


Public Properties
 PropertyDefined By
  bubbles : Boolean
[read-only] Indicates if event will bubble.
Event
  currentTarget : EventDispatcher
[read-only] The object the event is currently bubbling at.
Event
  target : EventDispatcher
[read-only] The object that dispatched the event.
Event
  type : String
[read-only] A string that identifies the event.
Event
Public Methods
 MethodDefined By
  
Event(type:String, bubbles:Boolean = false)
Creates an event object that can be passed to listeners.
Event
  
Prevents any other listeners from receiving the event.
Event
  
Prevents listeners at the next bubble stage from receiving the event.
Event
  
toString():String
Returns a description of the event, containing type and bubble information.
Event
Public Constants
 ConstantDefined By
  ADDED : String = added
[static] Event type for a display object that is added to a parent.
Event
  ADDED_TO_STAGE : String = addedToStage
[static] Event type for a display object that is added to the stage
Event
  ENTER_FRAME : String = enterFrame
[static] Event type for a display object that is entering a new frame.
Event
  FLATTEN : String = flatten
[static] Event type for a display object that is being flattened.
Event
  MOVIE_COMPLETED : String = movieCompleted
[static] Event type for a movie that has reached the last frame.
Event
  REMOVED : String = removed
[static] Event type for a display object that is removed from its parent.
Event
  REMOVED_FROM_STAGE : String = removedFromStage
[static] Event type for a display object that is removed from the stage.
Event
  RESIZE : String = resize
[static] Event type for a resized Flash Player.
Event
  TRIGGERED : String = triggered
[static] Event type for a triggered button.
Event
Property Detail
bubblesproperty
bubbles:Boolean  [read-only]

Indicates if event will bubble.


Implementation
    public function get bubbles():Boolean
currentTargetproperty 
currentTarget:EventDispatcher  [read-only]

The object the event is currently bubbling at.


Implementation
    public function get currentTarget():EventDispatcher
targetproperty 
target:EventDispatcher  [read-only]

The object that dispatched the event.


Implementation
    public function get target():EventDispatcher
typeproperty 
type:String  [read-only]

A string that identifies the event.


Implementation
    public function get type():String
Constructor Detail
Event()Constructor
public function Event(type:String, bubbles:Boolean = false)

Creates an event object that can be passed to listeners.

Parameters
type:String
 
bubbles:Boolean (default = false)
Method Detail
stopImmediatePropagation()method
public function stopImmediatePropagation():void

Prevents any other listeners from receiving the event.

stopPropagation()method 
public function stopPropagation():void

Prevents listeners at the next bubble stage from receiving the event.

toString()method 
public function toString():String

Returns a description of the event, containing type and bubble information.

Returns
String
Constant Detail
ADDEDConstant
public static const ADDED:String = added

Event type for a display object that is added to a parent.

ADDED_TO_STAGEConstant 
public static const ADDED_TO_STAGE:String = addedToStage

Event type for a display object that is added to the stage

ENTER_FRAMEConstant 
public static const ENTER_FRAME:String = enterFrame

Event type for a display object that is entering a new frame.

FLATTENConstant 
public static const FLATTEN:String = flatten

Event type for a display object that is being flattened.

MOVIE_COMPLETEDConstant 
public static const MOVIE_COMPLETED:String = movieCompleted

Event type for a movie that has reached the last frame.

REMOVEDConstant 
public static const REMOVED:String = removed

Event type for a display object that is removed from its parent.

REMOVED_FROM_STAGEConstant 
public static const REMOVED_FROM_STAGE:String = removedFromStage

Event type for a display object that is removed from the stage.

RESIZEConstant 
public static const RESIZE:String = resize

Event type for a resized Flash Player.

TRIGGEREDConstant 
public static const TRIGGERED:String = triggered

Event type for a triggered button.