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
  data : Object
[read-only] Arbitrary data that is attached to the event.
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, data:Object = null)
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
  CANCEL : String = cancel
[static] An event type to be utilized in custom events.
Event
  CHANGE : String = change
[static] An event type to be utilized in custom events.
Event
  CLOSE : String = close
[static] An event type to be utilized in custom events.
Event
  COMPLETE : String = complete
[static] Event type that may be used whenever something finishes.
Event
  CONTEXT3D_CREATE : String = context3DCreate
[static] Event type for a (re)created stage3D rendering context.
Event
  ENTER_FRAME : String = enterFrame
[static] Event type for a display object that is entering a new frame.
Event
  FATAL_ERROR : String = fatalError
[static] Event type that is dispatched by the Starling instance when it encounters a problem from which it cannot recover, e.g.
Event
  FLATTEN : String = flatten
[static] Event type for a display object that is being flattened.
Event
  IO_ERROR : String = ioError
[static] Event type that is dispatched by the AssetManager when a file/url cannot be loaded.
Event
  OPEN : String = open
[static] An event type to be utilized in custom events.
Event
  PARSE_ERROR : String = parseError
[static] Event type that is dispatched by the AssetManager when an xml or json file couldn't be parsed.
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
  REMOVE_FROM_JUGGLER : String = removeFromJuggler
[static] Event type for an animated object that requests to be removed from the juggler.
Event
  RESIZE : String = resize
[static] Event type for a resized Flash Player.
Event
  ROOT_CREATED : String = rootCreated
[static] Event type that indicates that the root DisplayObject has been created.
Event
  SCROLL : String = scroll
[static] An event type to be utilized in custom events.
Event
  SECURITY_ERROR : String = securityError
[static] Event type that is dispatched by the AssetManager when a file/url cannot be loaded.
Event
  SELECT : String = select
[static] An event type to be utilized in custom events.
Event
  TEXTURES_RESTORED : String = texturesRestored
[static] Event type that is dispatched by the AssetManager after a context loss.
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
dataproperty 
data:Object  [read-only]

Arbitrary data that is attached to the event.


Implementation
    public function get data():Object
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, data:Object = null)

Creates an event object that can be passed to listeners.

Parameters
type:String
 
bubbles:Boolean (default = false)
 
data:Object (default = null)
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

CANCELConstant 
public static const CANCEL:String = cancel

An event type to be utilized in custom events. Not used by Starling right now.

CHANGEConstant 
public static const CHANGE:String = change

An event type to be utilized in custom events. Not used by Starling right now.

CLOSEConstant 
public static const CLOSE:String = close

An event type to be utilized in custom events. Not used by Starling right now.

COMPLETEConstant 
public static const COMPLETE:String = complete

Event type that may be used whenever something finishes.

CONTEXT3D_CREATEConstant 
public static const CONTEXT3D_CREATE:String = context3DCreate

Event type for a (re)created stage3D rendering context.

ENTER_FRAMEConstant 
public static const ENTER_FRAME:String = enterFrame

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

FATAL_ERRORConstant 
public static const FATAL_ERROR:String = fatalError

Event type that is dispatched by the Starling instance when it encounters a problem from which it cannot recover, e.g. a lost device context.

FLATTENConstant 
public static const FLATTEN:String = flatten

Event type for a display object that is being flattened.

IO_ERRORConstant 
public static const IO_ERROR:String = ioError

Event type that is dispatched by the AssetManager when a file/url cannot be loaded.

OPENConstant 
public static const OPEN:String = open

An event type to be utilized in custom events. Not used by Starling right now.

PARSE_ERRORConstant 
public static const PARSE_ERROR:String = parseError

Event type that is dispatched by the AssetManager when an xml or json file couldn't be parsed.

REMOVE_FROM_JUGGLERConstant 
public static const REMOVE_FROM_JUGGLER:String = removeFromJuggler

Event type for an animated object that requests to be removed from the juggler.

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.

ROOT_CREATEDConstant 
public static const ROOT_CREATED:String = rootCreated

Event type that indicates that the root DisplayObject has been created.

SCROLLConstant 
public static const SCROLL:String = scroll

An event type to be utilized in custom events. Not used by Starling right now.

SECURITY_ERRORConstant 
public static const SECURITY_ERROR:String = securityError

Event type that is dispatched by the AssetManager when a file/url cannot be loaded.

SELECTConstant 
public static const SELECT:String = select

An event type to be utilized in custom events. Not used by Starling right now.

TEXTURES_RESTOREDConstant 
public static const TEXTURES_RESTORED:String = texturesRestored

Event type that is dispatched by the AssetManager after a context loss.

TRIGGEREDConstant 
public static const TRIGGERED:String = triggered

Event type for a triggered button.