GODPAPER | All Packages | All Classes | Index | Frames No Frames |
Event

Package | starling.events
Class | public class Event
Inheritance | Event Object
Subclasses | DragDropEvent, 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

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | Event(type:String, bubbles:Boolean = false, data:Object = null) Creates an event object that can be passed to listeners. | Event
|  | stopImmediatePropagation():void Prevents any other listeners from receiving the event. | Event
|  | stopPropagation():void 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

| Constant | Defined 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
|  | FLATTEN : String = flatten [static] Event type for a display object that is being flattened. | Event
|  | OPEN : String = open [static] An event type to be utilized in custom events. | 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
|  | 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

bubbles | property

`bubbles:Boolean` [read-only]

Indicates if event will bubble.

Implementation
`public function get bubbles():Boolean`

currentTarget | property |

`currentTarget:EventDispatcher` [read-only]

The object the event is currently bubbling at.

Implementation
`public function get currentTarget():EventDispatcher`

data | property |

`data:Object` [read-only]

Arbitrary data that is attached to the event.

Implementation
`public function get data():Object`

target | property |

`target:EventDispatcher` [read-only]

The object that dispatched the event.

Implementation
`public function get target():EventDispatcher`

type | property |

`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

ADDED | Constant

`public static const ADDED:String = added`

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

ADDED_TO_STAGE | Constant |

`public static const ADDED_TO_STAGE:String = addedToStage`

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

CANCEL | Constant |

`public static const CANCEL:String = cancel`

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

CHANGE | Constant |

`public static const CHANGE:String = change`

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

CLOSE | Constant |

`public static const CLOSE:String = close`

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

COMPLETE | Constant |

`public static const COMPLETE:String = complete`

Event type that may be used whenever something finishes.

CONTEXT3D_CREATE | Constant |

`public static const CONTEXT3D_CREATE:String = context3DCreate`

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

ENTER_FRAME | Constant |

`public static const ENTER_FRAME:String = enterFrame`

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

FLATTEN | Constant |

`public static const FLATTEN:String = flatten`

Event type for a display object that is being flattened.

OPEN | Constant |

`public static const OPEN:String = open`

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

REMOVE_FROM_JUGGLER | Constant |

`public static const REMOVE_FROM_JUGGLER:String = removeFromJuggler`

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

REMOVED | Constant |

`public static const REMOVED:String = removed`

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

REMOVED_FROM_STAGE | Constant |

`public static const REMOVED_FROM_STAGE:String = removedFromStage`

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

RESIZE | Constant |

`public static const RESIZE:String = resize`

Event type for a resized Flash Player.

ROOT_CREATED | Constant |

`public static const ROOT_CREATED:String = rootCreated`

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

SCROLL | Constant |

`public static const SCROLL:String = scroll`

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

SELECT | Constant |

`public static const SELECT:String = select`

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

TEXTURES_RESTORED | Constant |

`public static const TEXTURES_RESTORED:String = texturesRestored`

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

TRIGGERED | Constant |

`public static const TRIGGERED:String = triggered`

Event type for a triggered button.

Thu Jan 16 2014, 01:11 PM +08:00