flash.events.Event.as Maven / Gradle / Ivy
package flash.events {
/**
* The Event class is used as the base class for the creation of Event objects, which are passed as parameters to event listeners when an event occurs.
* The properties of the Event class carry basic information about an event, such as the event's type or whether the event's default behavior can be canceled. For many events, such as the events represented by the Event class constants, this basic information is sufficient. Other events, however, may require more detailed information. Events associated with a mouse click, for example, need to include additional information about the location of the click event and whether any keys were pressed during the click event. You can pass such additional information to event listeners by extending the Event class, which is what the MouseEvent class does. ActionScript 3.0 API defines several Event subclasses for common events that require additional information. Events associated with each of the Event subclasses are described in the documentation for each class.
* The methods of the Event class can be used in event listener functions to affect the behavior of the event object. Some events have an associated default behavior. For example, the doubleClick
event has an associated default behavior that highlights the word under the mouse pointer at the time of the event. Your event listener can cancel this behavior by calling the preventDefault()
method. You can also make the current event listener the last one to process an event by calling the stopPropagation()
or stopImmediatePropagation()
method.
* Other sources of information include:
*
* - A useful description about the timing of events, code execution, and rendering at runtime in Ted Patrick's blog entry: Flash Player Mental Model - The Elastic Racetrack.
* - A blog entry by Johannes Tacskovics about the timing of frame events, such as ENTER_FRAME, EXIT_FRAME: The MovieClip Lifecycle.
* - An article by Trevor McCauley about the order of ActionScript operations: Order of Operations in ActionScript.
* - A blog entry by Matt Przybylski on creating custom events: AS3: Custom Events.
*
* @see EventDispatcher
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf64a29-7fff.html About events
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf64a29-7ffe.html About the Event class
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf69084-7cdf.html Using events
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf69084-7ce1.html Manually dispatching events
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf69084-7cdb.html Event propagation
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf69084-7cda.html Event priorities
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf69084-7ce0.html Using event subclasses
* @see http://help.adobe.com/en_US/Flex/4.0/UsingSDK/WS2db454920e96a9e51e63e3d11c0bf64a29-7fdb.html About keyboard events
* @see http://help.adobe.com/en_US/as3/dev/WS5b3ccc516d4fbf351e63e3d118a9b90204-7e55.html Event objects
*
*/
public class Event {
/**
* Indicates whether an event is a bubbling event. If the event can bubble, this value is true
; otherwise it is false
.
* When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list hierarchy to the node just before the target node; the target phase, which comprises the target node; and the bubbling phase, which flows from the node subsequent to the target node back up the display list hierarchy.
* Some events, such as the activate
and unload
events, do not have a bubbling phase. The bubbles
property has a value of false
for events that do not have a bubbling phase.
*/
public native function get bubbles():Boolean;
/**
* Indicates whether the behavior associated with the event can be prevented. If the behavior can be canceled, this value is true
; otherwise it is false
.
* @see #preventDefault()
*
*/
public native function get cancelable():Boolean;
/**
* The object that is actively processing the Event object with an event listener. For example, if a user clicks an OK button, the current target could be the node containing that button or one of its ancestors that has registered an event listener for that event.
* @see http://help.adobe.com/en_US/as3/dev/WS5b3ccc516d4fbf351e63e3d118a9b90204-7e55.html Event objects
*
*/
public native function get currentTarget():Object;
/**
* The current phase in the event flow. This property can contain the following numeric values:
*
* - The capture phase (
EventPhase.CAPTURING_PHASE
).
* - The target phase (
EventPhase.AT_TARGET
).
* - The bubbling phase (
EventPhase.BUBBLING_PHASE
).
*/
public native function get eventPhase():uint;
/**
* The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.
* @see http://help.adobe.com/en_US/as3/dev/WS5b3ccc516d4fbf351e63e3d118a9b90204-7e55.html Event objects
*
*/
public native function get target():Object;
/**
* The type of event. The type is case-sensitive.
* @see http://help.adobe.com/en_US/as3/dev/WS5b3ccc516d4fbf351e63e3d118a9b90204-7e55.html Event objects
*
*/
public native function get type():String;
/**
* Creates an Event object to pass as a parameter to event listeners.
* @param type The type of the event, accessible as Event.type
.
* @param bubbles Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false
.
* @param cancelable Determines whether the Event object can be canceled. The default values is false
.
*
*/
public function Event(type:String, bubbles:Boolean = false, cancelable:Boolean = false) {
this['type'] = type;
this['bubbles'] = bubbles;
this['cancelable'] = cancelable;
}
/**
* Duplicates an instance of an Event subclass.
* Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call clone()
; the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call dispatchEvent(event)
from a handler that is handling event
.
* The new Event object includes all the properties of the original.
* When creating your own custom Event class, you must override the inherited Event.clone()
method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.
* In this example, PingEvent
is a subclass of Event
and therefore implements its own version of clone()
.
*
* class PingEvent extends Event {
* var URL:String;
*
* public override function clone():Event {
* return new PingEvent(type, bubbles, cancelable, URL);
* }
* }
*
* @return A new Event object that is identical to the original.
*
*/
public function clone():Event {
return new Event(type, bubbles, cancelable);
}
/**
* A utility function for implementing the toString()
method in custom ActionScript 3.0 Event classes. Overriding the toString()
method is recommended, but not required.
* class PingEvent extends Event {
var URL:String;
public override function toString():String {
return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL");
}
}
* @param className The name of your custom Event class. In the previous example, the className
parameter is PingEvent
.
* @param rest The properties of the Event class and the properties that you add in your custom Event class. In the previous example, the ...arguments
parameter includes type
, bubbles
, cancelable
, eventPhase
, and URL
.
*
* @return The name of your custom Event class and the String value of your ...arguments
parameter.
*
*/
public function formatToString(className:String, ...rest):String {
var sb:Array = ["[", className, " "];
for (var i:uint = 0; i < rest.length; ++i) {
sb.push(rest[i], "=", this[rest[i]], " ");
}
sb.push("]");
return sb.join("");
}
/**
* Checks whether the preventDefault()
method has been called on the event. If the preventDefault()
method has been called, returns true
; otherwise, returns false
.
* @return If preventDefault()
has been called, returns true
; otherwise, returns false
.
*
* @see #preventDefault()
*
*/
public function isDefaultPrevented():Boolean {
return defaultPrevented;
}
/**
* Cancels an event's default behavior if that behavior can be canceled.
* Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the TextEvent.TEXT_INPUT
event's default behavior can be canceled, you can use the preventDefault()
method to prevent the character from appearing.
* An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED
event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the preventDefault()
method has no effect on this default behavior.
* You can use the Event.cancelable
property to check whether you can prevent the default behavior associated with a particular event. If the value of Event.cancelable
is true
, then preventDefault()
can be used to cancel the event; otherwise, preventDefault()
has no effect.
* @see #isDefaultPrevented()
* @see #cancelable
*
*/
public function preventDefault():void {
if (cancelable) {
defaultPrevented = true;
}
}
/**
* Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the stopPropagation()
method doesn't take effect until all the event listeners in the current node finish processing.
* Note: This method does not cancel the behavior associated with this event; see preventDefault()
for that functionality.
* @see #stopPropagation()
* @see #preventDefault()
*
*/
public function stopImmediatePropagation():void {
immediatePropagationStopped = true;
}
/**
* Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node (currentTarget
). In contrast, the stopImmediatePropagation()
method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.
* Note: This method does not cancel the behavior associated with this event; see preventDefault()
for that functionality.
* @see #stopImmediatePropagation()
* @see #preventDefault()
*
*/
public function stopPropagation():void {
propagationStopped = true;
}
/**
* Returns a string containing all the properties of the Event object. The string is in the following format:
* [Event type=value bubbles=value cancelable=value]
* @return A string containing all the properties of the Event object.
*
*/
public function toString():String {
return formatToString("Event", "type", "bubbles", "cancelable");
}
/**
* The ACTIVATE
constant defines the value of the type
property of an activate
event object.
* Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.
* AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any DisplayObject instance with a listener registered for the activate
event.
* @see EventDispatcher#event:activate
* @see #DEACTIVATE
*
*/
public static const ACTIVATE:String = "activate";
/**
* The Event.ADDED
constant defines the value of the type
property of an added
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* true
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The DisplayObject instance being added to the display list. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.display.DisplayObject#event:added
* @see #ADDED_TO_STAGE
* @see #REMOVED
* @see #REMOVED_FROM_STAGE
*
*/
public static const ADDED:String = "added";
/**
* The Event.ADDED_TO_STAGE
constant defines the value of the type
property of an addedToStage
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The DisplayObject instance being added to the on stage display list, either directly or through the addition of a sub tree in which the DisplayObject instance is contained. If the DisplayObject instance is being directly added, the added
event occurs before this event.
* @see flash.display.DisplayObject#event:addedToStage
* @see #ADDED
* @see #REMOVED
* @see #REMOVED_FROM_STAGE
*
*/
public static const ADDED_TO_STAGE:String = "addedToStage";
/**
* The Event.CANCEL
constant defines the value of the type
property of a cancel
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* A reference to the object on which the operation is canceled.
* @see flash.net.FileReference#event:cancel
*
*/
public static const CANCEL:String = "cancel";
/**
* The Event.CHANGE
constant defines the value of the type
property of a change
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* true
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The object that has had its value modified. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.text.TextField#event:change
* @see TextEvent#TEXT_INPUT
*
*/
public static const CHANGE:String = "change";
/**
* The Event.CLEAR
constant defines the value of the type
property of a clear
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any InteractiveObject instance with a listener registered for the clear
event.
* Note: TextField objects do not dispatch clear
, copy
, cut
, paste
, or selectAll
events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. You cannot remove these commands from the context menu for TextField objects. For TextField objects, selecting these commands (or their keyboard equivalents) does not generate clear
, copy
, cut
, paste
, or selectAll
events. However, other classes that extend the InteractiveObject class, including components built using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.
* @see flash.display.InteractiveObject#event:clear
*
*/
public static const CLEAR:String = "clear";
/**
* The Event.CLOSE
constant defines the value of the type
property of a close
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The object whose connection has been closed.
* @see flash.net.Socket#event:close
* @see flash.net.XMLSocket#event:close
* @see flash.display.NativeWindow#event:close
*
*/
public static const CLOSE:String = "close";
/**
* The Event.COMPLETE
constant defines the value of the type
property of a complete
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The network object that has completed loading.
* @see flash.display.LoaderInfo#event:complete
* @see flash.html.HTMLLoader#event:complete
* @see flash.media.Sound#event:complete
* @see flash.net.FileReference#event:complete
* @see flash.net.URLLoader#event:complete
* @see flash.net.URLStream#event:complete
* @see http://help.adobe.com/en_US/as3/dev/WS5b3ccc516d4fbf351e63e3d118a9b90204-7cfd.html Loading external data
*
*/
public static const COMPLETE:String = "complete";
/**
* The Event.CONNECT
constant defines the value of the type
property of a connect
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The Socket or XMLSocket object that has established a network connection.
* @see flash.net.Socket#event:connect
* @see flash.net.XMLSocket#event:connect
*
*/
public static const CONNECT:String = "connect";
/**
* Defines the value of the type
property of a copy
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any InteractiveObject instance with a listener registered for the copy
event.
* Note: TextField objects do not dispatch clear
, copy
, cut
, paste
, or selectAll
events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. You cannot remove these commands from the context menu for TextField objects. For TextField objects, selecting these commands (or their keyboard equivalents) does not generate clear
, copy
, cut
, paste
, or selectAll
events. However, other classes that extend the InteractiveObject class, including components built using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.
* @see flash.display.InteractiveObject#event:copy
*
*/
public static const COPY:String = "copy";
/**
* Defines the value of the type
property of a cut
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any InteractiveObject instance with a listener registered for the cut
event.
* Note: TextField objects do not dispatch clear
, copy
, cut
, paste
, or selectAll
events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. You cannot remove these commands from the context menu for TextField objects. For TextField objects, selecting these commands (or their keyboard equivalents) does not generate clear
, copy
, cut
, paste
, or selectAll
events. However, other classes that extend the InteractiveObject class, including components built using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.
* @see flash.display.InteractiveObject#event:cut
*
*/
public static const CUT:String = "cut";
/**
* The Event.DEACTIVATE
constant defines the value of the type
property of a deactivate
event object.
* Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.
* AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any DisplayObject instance with a listener registered for the deactivate
event.
* @see EventDispatcher#event:deactivate
* @see #ACTIVATE
*
*/
public static const DEACTIVATE:String = "deactivate";
/**
* The Event.ENTER_FRAME
constant defines the value of the type
property of an enterFrame
event object.
* Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any DisplayObject instance with a listener registered for the enterFrame
event.
* @see flash.display.DisplayObject#event:enterFrame
*
*/
public static const ENTER_FRAME:String = "enterFrame";
/**
* The Event.EXIT_FRAME
constant defines the value of the type
property of an exitFrame
event object.
* Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any DisplayObject instance with a listener registered for the enterFrame
event.
* @see flash.display.DisplayObject#event:exitFrame
*
*/
public static const EXIT_FRAME:String = "exitFrame";
/**
* The Event.FRAME_CONSTRUCTED
constant defines the value of the type
property of an frameConstructed
event object.
* Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any DisplayObject instance with a listener registered for the frameConstructed
event.
* @see flash.display.DisplayObject#event:frameConstructed
*
*/
public static const FRAME_CONSTRUCTED:String = "frameConstructed";
/**
* The Event.FULL_SCREEN
constant defines the value of the type
property of a fullScreen
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The Stage object.
* @see flash.display.Stage#event:fullScreen
*
*/
public static const FULLSCREEN:String = "fullScreen";
/**
* The Event.ID3
constant defines the value of the type
property of an id3
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The Sound object loading the MP3 for which ID3 data is now available. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.media.Sound#event:id3
*
*/
public static const ID3:String = "id3";
/**
* The Event.INIT
constant defines the value of the type
property of an init
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The LoaderInfo object associated with the SWF file being loaded.
* @see flash.display.LoaderInfo#event:init
*
*/
public static const INIT:String = "init";
/**
* The Event.MOUSE_LEAVE
constant defines the value of the type
property of a mouseLeave
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The Stage object. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.display.Stage#event:mouseLeave
* @see MouseEvent
*
*/
public static const MOUSE_LEAVE:String = "mouseLeave";
/**
* The Event.OPEN
constant defines the value of the type
property of an open
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The network object that has opened a connection.
* @see flash.display.LoaderInfo#event:open
* @see flash.media.Sound#event:open
* @see flash.net.FileReference#event:open
* @see flash.net.URLLoader#event:open
* @see flash.net.URLStream#event:open
*
*/
public static const OPEN:String = "open";
/**
* The Event.PASTE
constant defines the value of the type
property of a paste
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any InteractiveObject instance with a listener registered for the paste
event.
* Note: TextField objects do not dispatch clear
, copy
, cut
, paste
, or selectAll
events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. You cannot remove these commands from the context menu for TextField objects. For TextField objects, selecting these commands (or their keyboard equivalents) does not generate clear
, copy
, cut
, paste
, or selectAll
events. However, other classes that extend the InteractiveObject class, including components built using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.
* @see flash.display.InteractiveObject#event:paste
*
*/
public static const PASTE:String = "paste";
/**
* The Event.REMOVED
constant defines the value of the type
property of a removed
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* true
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The DisplayObject instance to be removed from the display list. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.display.DisplayObject#event:removed
* @see #ADDED
* @see #ADDED_TO_STAGE
* @see #REMOVED_FROM_STAGE
*
*/
public static const REMOVED:String = "removed";
/**
* The Event.REMOVED_FROM_STAGE
constant defines the value of the type
property of a removedFromStage
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The DisplayObject instance being removed from the on stage display list, either directly or through the removal of a sub tree in which the DisplayObject instance is contained. If the DisplayObject instance is being directly removed, the removed
event occurs before this event.
* @see flash.display.DisplayObject#event:removedFromStage
* @see #ADDED
* @see #REMOVED
* @see #ADDED_TO_STAGE
*
*/
public static const REMOVED_FROM_STAGE:String = "removedFromStage";
/**
* The Event.RENDER
constant defines the value of the type
property of a render
event object.
* Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; the default behavior cannot be canceled.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any DisplayObject instance with a listener registered for the render
event.
* @see flash.display.DisplayObject#event:render
* @see flash.display.Stage#invalidate()
*
*/
public static const RENDER:String = "render";
/**
* The Event.RESIZE
constant defines the value of the type
property of a resize
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The Stage object.
* @see flash.display.Stage#event:resize
*
*/
public static const RESIZE:String = "resize";
/**
* The Event.SCROLL
constant defines the value of the type
property of a scroll
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The TextField object that has been scrolled. The target
property is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.text.TextField#event:scroll
* @see flash.html.HTMLLoader#event:scroll
*
*/
public static const SCROLL:String = "scroll";
/**
* The Event.SELECT
constant defines the value of the type
property of a select
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The object on which an item has been selected.
* @see flash.net.FileReference#event:select
* @see flash.display.NativeMenu#event:select
* @see flash.display.NativeMenuItem#event:select
*
*/
public static const SELECT:String = "select";
/**
* The Event.SELECT_ALL
constant defines the value of the type
property of a selectAll
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* Any InteractiveObject instance with a listener registered for the selectAll
event.
* Note: TextField objects do not dispatch clear
, copy
, cut
, paste
, or selectAll
events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. You cannot remove these commands from the context menu for TextField objects. For TextField objects, selecting these commands (or their keyboard equivalents) does not generate clear
, copy
, cut
, paste
, or selectAll
events. However, other classes that extend the InteractiveObject class, including components built using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.
* @see flash.display.InteractiveObject#event:selectAll
*
*/
public static const SELECT_ALL:String = "selectAll";
/**
* The Event.SOUND_COMPLETE
constant defines the value of the type
property of a soundComplete
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The SoundChannel object in which a sound has finished playing.
* @see flash.media.SoundChannel#event:soundComplete
*
*/
public static const SOUND_COMPLETE:String = "soundComplete";
/**
* The Event.TAB_CHILDREN_CHANGE
constant defines the value of the type
property of a tabChildrenChange
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* true
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The object whose tabChildren flag has changed. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.display.InteractiveObject#event:tabChildrenChange
*
*/
public static const TAB_CHILDREN_CHANGE:String = "tabChildrenChange";
/**
* The Event.TAB_ENABLED_CHANGE
constant defines the value of the type
property of a tabEnabledChange
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* true
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The InteractiveObject whose tabEnabled flag has changed. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.display.InteractiveObject#event:tabEnabledChange
*
*/
public static const TAB_ENABLED_CHANGE:String = "tabEnabledChange";
/**
* The Event.TAB_INDEX_CHANGE
constant defines the value of the type
property of a tabIndexChange
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* true
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The object whose tabIndex has changed. The target
is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.display.InteractiveObject#event:tabIndexChange
*
*/
public static const TAB_INDEX_CHANGE:String = "tabIndexChange";
/**
* The Event.TEXT_INTERACTION_MODE_CHANGE
constant defines the value of the type
property of a interaction mode
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The TextField object whose interaction mode property is changed. For example on Android, one can change the interaction mode to SELECTION via context menu. The target
property is not always the object in the display list that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
* @see flash.text.TextField#event:textInteractionModeChange
*
*/
public static const TEXT_INTERACTION_MODE_CHANGE:String = "textInteractionModeChange";
/**
* The Event.UNLOAD
constant defines the value of the type
property of an unload
event object.
* This event has the following properties:
*
* Property Value
*
* bubbles
* false
*
* cancelable
* false
; there is no default behavior to cancel.
*
* currentTarget
* The object that is actively processing the Event object with an event listener.
*
* target
* The LoaderInfo object associated with the SWF file being unloaded or replaced.
* @see flash.display.LoaderInfo#event:unload
*
*/
public static const UNLOAD:String = "unload";
// ************************** Jangaroo part **************************
/**
* @private
*/
public function isPropagationStopped():Boolean {
return propagationStopped;
}
/**
* @private
*/
public function isImmediatePropagationStopped():Boolean {
return immediatePropagationStopped;
}
/**
* @private
*/
internal function withTarget(target:Object):Event {
var event:Event = this.target ? clone() : this;
event['target'] = target;
return event;
}
internal function withCurrentTarget(currentTarget:Object):Event {
this['currentTarget'] = currentTarget;
return this;
}
private var defaultPrevented:Boolean = false;
private var propagationStopped:Boolean;
private var immediatePropagationStopped:Boolean;
}
}