class Event

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:

The Event.ADDED constant defines the value of the type property of an added event object. This event has the following properties:

The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object. This event has the following properties:

The Event.CANCEL constant defines the value of the type property of a cancel event object. This event has the following properties:

The Event.CHANGE constant defines the value of the type property of a change event object. This event has the following properties:

The Event.CLEAR constant defines the value of the type property of a clear event object. This event has the following properties:

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.

The Event.CLOSE constant defines the value of the type property of a close event object. This event has the following properties:

The Event.CLOSING constant defines the value of the type property of a closing event object. This event has the following properties:

The Event.COMPLETE constant defines the value of the type property of a complete event object. This event has the following properties:

The Event.CONNECT constant defines the value of the type property of a connect event object. This event has the following properties:

The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object. This event is raised only by Stage3D objects in response to either a call to Stage3D.requestContext3D or in response to an OS triggered reset of the Context3D bound to the Stage3D object. Inspect the Stage3D.context3D property to get the newly created Context3D object.

Defines the value of the type property of a copy event object. This event has the following properties:

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.

Defines the value of the type property of a cut event object. This event has the following properties:

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.

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:

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:

The Event.EXITING constant defines the value of the type property of an exiting event object.

This event has the following properties:

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:

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:

The Event.FRAME_LABEL constant defines the value of the type property of a frameLabel event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to FrameLabel objects.

This event has the following properties:

The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. This event has the following properties:

The Event.ID3 constant defines the value of the type property of an id3 event object. This event has the following properties:

The Event.INIT constant defines the value of the type property of an init event object. This event has the following properties:

The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. This event has the following properties:

The Event.OPEN constant defines the value of the type property of an open event object. This event has the following properties:

The Event.PASTE constant defines the value of the type property of a paste event object. This event has the following properties:

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.

The Event.REMOVED constant defines the value of the type property of a removed event object. This event has the following properties:

The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object. This event has the following properties:

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:

The Event.RESIZE constant defines the value of the type property of a resize event object. This event has the following properties:

The Event.SCROLL constant defines the value of the type property of a scroll event object. This event has the following properties:

The Event.SELECT constant defines the value of the type property of a select event object. This event has the following properties:

The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. This event has the following properties:

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.

The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. This event has the following properties:

The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. This event has the following properties:

The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object. This event has the following properties:

The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object. This event has the following properties:

The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. This event is dispatched by Texture and CubeTexture objects to signal the completion of an asynchronous upload. Request an asynchronous upload by using the uploadCompressedTextureFromByteArray() method on Texture or CubeTexture. This event neither bubbles nor is cancelable.

The Event.UNLOAD constant defines the value of the type property of an unload event object. This event has the following properties:

Creates an Event object to pass as a parameter to event listeners.

Parameters:

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.

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.

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.

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).

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.

The type of event. The type is case-sensitive.

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().

Returns:

A utility function for implementing the toString() method in custom OpenFL Event classes. Overriding the toString() method is recommended, but not required.

class PingEvent extends Event {
	var URL:String;

	public function new() {
		super();
	}

	public override function toString():String {
		return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL");
	}
}

Parameters:

Returns:

Checks whether the preventDefault() method has been called on the event. If the preventDefault() method has been called, returns true; otherwise, returns false.

Returns:

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.

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.

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.

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_]

Returns: