Packagemx.events
Classpublic class FlexEvent
InheritanceFlexEvent Inheritance flash.events.Event

The FlexEvent class represents the event object passed to the event listener for many Flex events.



Public Methods
 MethodDefined by
  
FlexEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
FlexEvent
Public Constants
 ConstantDefined by
  ADD : String = "add"
[static] The FlexEvent.ADD constant defines the value of the type property of the event object for an add event.
FlexEvent
  APPLICATION_COMPLETE : String = "applicationComplete"
[static] The FlexEvent.APPLICATION_COMPLETE constant defines the value of the type property of the event object for a applicationComplete event.
FlexEvent
  BUTTON_DOWN : String = "buttonDown"
[static] The FlexEvent.BUTTON_DOWN constant defines the value of the type property of the event object for a buttonDown event.
FlexEvent
  CREATION_COMPLETE : String = "creationComplete"
[static] The FlexEvent.CREATION_COMPLETE constant defines the value of the type property of the event object for a creationComplete event.
FlexEvent
  CURSOR_UPDATE : String = "cursorUpdate"
[static] The FlexEvent.CURSOR_UPDATE constant defines the value of the type property of the event object for a cursorUpdate event.
FlexEvent
  DATA_CHANGE : String = "dataChange"
[static] The FlexEvent.DATA_CHANGE constant defines the value of the type property of the event object for a dataChange event.
FlexEvent
  ENTER : String = "enter"
[static] The FlexEvent.ENTER constant defines the value of the type property of the event object for a enter event.
FlexEvent
  ENTER_FRAME : String = "flexEventEnterFrame"
[static] The FlexEvent.ENTER_FRAME constant defines the value of the type property of the event object for an Event.ENTER_FRAMER event.
FlexEvent
  ENTER_STATE : String = "enterState"
[static] The FlexEvent.ENTER_STATE constant defines the value of the type property of the event object for a enterState event.
FlexEvent
  EXIT_STATE : String = "exitState"
[static] The FlexEvent.EXIT_STATE constant defines the value of the type property of the event object for a exitState event.
FlexEvent
  HIDE : String = "hide"
[static] The FlexEvent.HIDE constant defines the value of the type property of the event object for a hide event.
FlexEvent
  IDLE : String = "idle"
[static] The FlexEvent.IDLE constant defines the value of the type property of the event object for a idle event.
FlexEvent
  INIT_COMPLETE : String = "initComplete"
[static] Dispatched when a Flex application finishes initialization.
FlexEvent
  INITIALIZE : String = "initialize"
[static] The FlexEvent.INITIALIZE constant defines the value of the type property of the event object for a initialize event.
FlexEvent
  INIT_PROGRESS : String = "initProgress"
[static] Dispatched when the Flex application completes an initialization phase, as defined by calls to the measure(), commitProperties(), or updateDisplayList() methods.
FlexEvent
  INVALID : String = "invalid"
[static] The FlexEvent.INVALID constant defines the value of the type property of the event object for a invalid event.
FlexEvent
  LOADING : String = "loading"
[static] The FlexEvent.LOADING constant defines the value of the type property of the event object for a loading event.
FlexEvent
  PREINITIALIZE : String = "preinitialize"
[static] The FlexEvent.PREINITIALIZE constant defines the value of the type property of the event object for a preinitialize event.
FlexEvent
  REMOVE : String = "remove"
[static] The FlexEvent.REMOVE constant defines the value of the type property of the event object for an remove event.
FlexEvent
  RENDER : String = "flexEventRender"
[static] The FlexEvent.RENDER constant defines the value of the type property of the event object for an Event.RENDER event.
FlexEvent
  REPEAT : String = "repeat"
[static] The FlexEvent.REPEAT constant defines the value of the type property of the event object for a repeat event.
FlexEvent
  REPEAT_END : String = "repeatEnd"
[static] The FlexEvent.REPEAT_END constant defines the value of the type property of the event object for a repeatEnd event.
FlexEvent
  REPEAT_START : String = "repeatStart"
[static] The FlexEvent.REPEAT_START constant defines the value of the type property of the event object for a repeatStart event.
FlexEvent
  SHOW : String = "show"
[static] The FlexEvent.SHOW constant defines the value of the type property of the event object for a show event.
FlexEvent
  TRANSFORM_CHANGE : String = "transformChange"
[static] The FlexEvent.TRANSFORM_CHANGE constant defines the value of the type property of the event object for a transformChange event.
FlexEvent
  UPDATE_COMPLETE : String = "updateComplete"
[static] The FlexEvent.UPDATE_COMPLETE constant defines the value of the type property of the event object for a updateComplete event.
FlexEvent
  URL_CHANGED : String = "urlChanged"
[static] The FlexEvent.URL_CHANGED constant defines the value of the type property of the event object for a urlChanged event.
FlexEvent
  VALID : String = "valid"
[static] The FlexEvent.VALID constant defines the value of the type property of the event object for a valid event.
FlexEvent
  VALUE_COMMIT : String = "valueCommit"
[static] The FlexEvent.VALUE_COMMIT constant defines the value of the type property of the event object for a valueCommit event.
FlexEvent
Constructor detail
FlexEvent()constructor
public function FlexEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
Constant detail
ADDconstant
public static const ADD:String = "add"

The FlexEvent.ADD constant defines the value of the type property of the event object for an add event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
APPLICATION_COMPLETEconstant 
public static const APPLICATION_COMPLETE:String = "applicationComplete"

The FlexEvent.APPLICATION_COMPLETE constant defines the value of the type property of the event object for a applicationComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
BUTTON_DOWNconstant 
public static const BUTTON_DOWN:String = "buttonDown"

The FlexEvent.BUTTON_DOWN constant defines the value of the type property of the event object for a buttonDown event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
CREATION_COMPLETEconstant 
public static const CREATION_COMPLETE:String = "creationComplete"

The FlexEvent.CREATION_COMPLETE constant defines the value of the type property of the event object for a creationComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
CURSOR_UPDATEconstant 
public static const CURSOR_UPDATE:String = "cursorUpdate"

The FlexEvent.CURSOR_UPDATE constant defines the value of the type property of the event object for a cursorUpdate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
DATA_CHANGEconstant 
public static const DATA_CHANGE:String = "dataChange"

The FlexEvent.DATA_CHANGE constant defines the value of the type property of the event object for a dataChange event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
ENTERconstant 
public static const ENTER:String = "enter"

The FlexEvent.ENTER constant defines the value of the type property of the event object for a enter event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
ENTER_FRAMEconstant 
public static const ENTER_FRAME:String = "flexEventEnterFrame"

The FlexEvent.ENTER_FRAME constant defines the value of the type property of the event object for an Event.ENTER_FRAMER event. Adding a listener to ENTER_FRAME on the SystemManager will add a listener for the Event.ENTER_FRAME event on the stage, if access if allowed, or the SystemManager if access the the stage is not allowed. The listener should expect to receive Event.ENTER_FRAME events.

ENTER_STATEconstant 
public static const ENTER_STATE:String = "enterState"

The FlexEvent.ENTER_STATE constant defines the value of the type property of the event object for a enterState event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
EXIT_STATEconstant 
public static const EXIT_STATE:String = "exitState"

The FlexEvent.EXIT_STATE constant defines the value of the type property of the event object for a exitState event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
HIDEconstant 
public static const HIDE:String = "hide"

The FlexEvent.HIDE constant defines the value of the type property of the event object for a hide event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
IDLEconstant 
public static const IDLE:String = "idle"

The FlexEvent.IDLE constant defines the value of the type property of the event object for a idle event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
INIT_COMPLETEconstant 
public static const INIT_COMPLETE:String = "initComplete"

Dispatched when a Flex application finishes initialization. You use this event when creating a custom download progress bar.

This event is always dispatched once by the Preloader class, and is the last event that the Preloader dispatches. When this event is dispatched, the event listener should dispatch an Event.COMPLETE event.

A download progress bar must dispatch a complete event after it has received an init_complete event. The complete event informs the Preloader that the download progress bar has completed all operations and can be dismissed.

A download progress bar can perform additional tasks, such as playing an animation, after receiving an init_complete event, and before dispatching the complete event. Dispatching the complete event should be the last action of the download progress bar.

The FlexEvent.INIT_COMPLETE constant defines the value of the type property of the event object for a initComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

INITIALIZEconstant 
public static const INITIALIZE:String = "initialize"

The FlexEvent.INITIALIZE constant defines the value of the type property of the event object for a initialize event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
INIT_PROGRESSconstant 
public static const INIT_PROGRESS:String = "initProgress"

Dispatched when the Flex application completes an initialization phase, as defined by calls to the measure(), commitProperties(), or updateDisplayList() methods. This event describes the progress of the application in the initialization phase. You use this event when creating a custom download progress bar.

The FlexEvent.INIT_PROGRESS constant defines the value of the type property of the event object for a initProgress event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

INVALIDconstant 
public static const INVALID:String = "invalid"

The FlexEvent.INVALID constant defines the value of the type property of the event object for a invalid event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
LOADINGconstant 
public static const LOADING:String = "loading"

The FlexEvent.LOADING constant defines the value of the type property of the event object for a loading event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.modules.ModuleLoader
PREINITIALIZEconstant 
public static const PREINITIALIZE:String = "preinitialize"

The FlexEvent.PREINITIALIZE constant defines the value of the type property of the event object for a preinitialize event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
REMOVEconstant 
public static const REMOVE:String = "remove"

The FlexEvent.REMOVE constant defines the value of the type property of the event object for an remove event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
RENDERconstant 
public static const RENDER:String = "flexEventRender"

The FlexEvent.RENDER constant defines the value of the type property of the event object for an Event.RENDER event. Adding a listener on the SystemManager will add a listener for FlexEvent.RENDER events on the stage or the SystemManager if the application does not have access to the stage. The listener will also generate an Event.RENDER event. The listener function should expect to receive Event.RENDER events.

REPEATconstant 
public static const REPEAT:String = "repeat"

The FlexEvent.REPEAT constant defines the value of the type property of the event object for a repeat event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
REPEAT_ENDconstant 
public static const REPEAT_END:String = "repeatEnd"

The FlexEvent.REPEAT_END constant defines the value of the type property of the event object for a repeatEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
REPEAT_STARTconstant 
public static const REPEAT_START:String = "repeatStart"

The FlexEvent.REPEAT_START constant defines the value of the type property of the event object for a repeatStart event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
SHOWconstant 
public static const SHOW:String = "show"

The FlexEvent.SHOW constant defines the value of the type property of the event object for a show event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TRANSFORM_CHANGEconstant 
public static const TRANSFORM_CHANGE:String = "transformChange"

The FlexEvent.TRANSFORM_CHANGE constant defines the value of the type property of the event object for a transformChange event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
UPDATE_COMPLETEconstant 
public static const UPDATE_COMPLETE:String = "updateComplete"

The FlexEvent.UPDATE_COMPLETE constant defines the value of the type property of the event object for a updateComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
URL_CHANGEDconstant 
public static const URL_CHANGED:String = "urlChanged"

The FlexEvent.URL_CHANGED constant defines the value of the type property of the event object for a urlChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.modules.ModuleLoader
VALIDconstant 
public static const VALID:String = "valid"

The FlexEvent.VALID constant defines the value of the type property of the event object for a valid event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
VALUE_COMMITconstant 
public static const VALUE_COMMIT:String = "valueCommit"

The FlexEvent.VALUE_COMMIT constant defines the value of the type property of the event object for a valueCommit event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.