package starling.events {
/**
 *  Event objects are passed as parameters to event listeners when an event occurs.  
 *  *  This is Starling's version of the Flash Event class. 
 *  *
 *  *  <p>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.</p>
 *  * 
 *  *  <p>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.</p>
 *  * 
 *  *  <p>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.</p>
 *  * 
 *  *  @see EventDispatcher
 *  
 * @externs
 */
public class Event {
	/**
	 *  Creates an event object that can be passed to listeners. 
	 */
	public function Event(type:String, bubbles:Boolean = undefined, data:* = undefined) {}
	/**
	 *  Event type for a display object that is added to a parent. 
	 */
	public static const ADDED:String = "added";
	/**
	 *  Event type for a display object that is added to the stage 
	 */
	public static const ADDED_TO_STAGE:String = "addedToStage";
	/**
	 *  Event type for a display object that is entering a new frame. 
	 */
	public static const ENTER_FRAME:String = "enterFrame";
	/**
	 *  Event type for a display object that is removed from its parent. 
	 */
	public static const REMOVED:String = "removed";
	/**
	 *  Event type for a display object that is removed from the stage. 
	 */
	public static const REMOVED_FROM_STAGE:String = "removedFromStage";
	/**
	 *  Event type for a triggered button. 
	 */
	public static const TRIGGERED:String = "triggered";
	/**
	 *  Event type for a resized Flash Player. 
	 */
	public static const RESIZE:String = "resize";
	/**
	 *  Event type that may be used whenever something finishes. 
	 */
	public static const COMPLETE:String = "complete";
	/**
	 *  Event type for a (re)created stage3D rendering context. 
	 */
	public static const CONTEXT3D_CREATE:String = "context3DCreate";
	/**
	 *  Event type that is dispatched by the Starling instance directly before rendering. 
	 */
	public static const RENDER:String = "render";
	/**
	 *  Event type that is dispatched by the Starling instance after rendering. 
	 */
	public static const RENDER_COMPLETE:String = "renderComplete";
	/**
	 *  Event type for a frame that is skipped because the display list did not change.
	 * 	 *  Dispatched instead of the <code>RENDER</code> event. 
	 */
	public static const SKIP_FRAME:String = "skipFrame";
	/**
	 *  Event type that indicates that the root DisplayObject has been created. 
	 */
	public static const ROOT_CREATED:String = "rootCreated";
	/**
	 *  Event type for an animated object that requests to be removed from the juggler. 
	 */
	public static const REMOVE_FROM_JUGGLER:String = "removeFromJuggler";
	/**
	 *  Event type for an animated object that is removed from its juggler. 
	 */
	public static const REMOVED_FROM_JUGGLER:String = "removedFromJuggler";
	/**
	 *  Event type that is dispatched by the AssetManager after a context loss. 
	 */
	public static const TEXTURES_RESTORED:String = "texturesRestored";
	/**
	 *  Event type that is dispatched by the AssetManager when a file/url cannot be loaded. 
	 */
	public static const IO_ERROR:String = "ioError";
	/**
	 *  Event type that is dispatched by the AssetManager when a file/url cannot be loaded. 
	 */
	public static const SECURITY_ERROR:String = "securityError";
	/**
	 *  Event type that is dispatched by the AssetManager when an xml or json file couldn't
	 *      * be parsed. 
	 */
	public static const PARSE_ERROR:String = "parseError";
	/**
	 *  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. 
	 */
	public static const FATAL_ERROR:String = "fatalError";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const CHANGE:String = "change";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const CANCEL:String = "cancel";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const SCROLL:String = "scroll";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const OPEN:String = "open";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const CLOSE:String = "close";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const SELECT:String = "select";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const READY:String = "ready";
	/**
	 *  An event type to be utilized in custom events. Not used by Starling right now. 
	 */
	public static const UPDATE:String = "update";
	/**
	 *  Prevents listeners at the next bubble stage from receiving the event. 
	 */
	public function stopPropagation():void {}
	/**
	 *  Prevents any other listeners from receiving the event. 
	 */
	public function stopImmediatePropagation():void {}
	/**
	 *  Returns a description of the event, containing type and bubble information. 
	 */
	public function toString():String { return null; }
	/**
	 *  Indicates if event will bubble. 
	 */
	public var bubbles:Boolean;
	/**
	 *  The object that dispatched the event. 
	 */
	public var target:starling.events.EventDispatcher;
	/**
	 *  The object the event is currently bubbling at. 
	 */
	public var currentTarget:starling.events.EventDispatcher;
	/**
	 *  A string that identifies the event. 
	 */
	public var type:String;
	/**
	 *  Arbitrary data that is attached to the event. 
	 */
	public var data:*;
}
}