////////////////////////////////////////////////////////////////////////////////
//
// ADOBE SYSTEMS INCORPORATED
// Copyright 2006-2007 Adobe Systems Incorporated
// All Rights Reserved.
//
// NOTICE: Adobe permits you to use, modify, and distribute this file
// in accordance with the terms of the license agreement accompanying it.
//
////////////////////////////////////////////////////////////////////////////////
package mx.events
{
import flash.events.Event;
/**
* The FlexEvent class represents the event object passed to
* the event listener for many Flex events.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class FlexEvent extends Event
{
include "../core/Version.as";
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* 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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.ADD_FOCUS_MANAGER constant defines the value of the
* type property of the event object for an addFocusManager event.
* This event is dispatched from an IFocusManagerContainer when its focusManager
* is assigned.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.CHANGE_END constant defines the value of the
* type property of the event object for a changeEnd event.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.CHANGE_START constant defines the value of the
* type property of the event object for a changeStart event.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.CHANGING constant defines the value of the
* type property of the event object for a changing event.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.CONTENT_CREATION_COMPLETE constant defines the value of the
* type property of the event object for a contentCreationComplete event.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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.
*
* @eventType flexEventEnterFrame
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const ENTER_FRAME:String = "flexEventEnterFrame";
/**
* 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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.FLEX_WINDOW_ACTIVATE constant defines the value of the
* type property of the event object for a flexWindowActivate
* event.
*
* Similar to the flash.events.AIREvent.WINDOW_ACTIVATE except it is dispatched
* in both Flash and AIR when a Flex window or popup is activated. This event is
* dispatched from the focusManager managing
* focus in that container.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.FLEX_WINDOW_DEACTIVATE constant defines the value of the
* type property of the event object for a flexWindowDeactivate
* event.
*
* Similar to the flash.events.AIREvent.FLEX_WINDOW_DEACTIVATE except it is dispatched
* in both Flash and AIR when a Flex Window or popup is deactivated. This event is
* dispatched from the focusManager managing
* focus in that container.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.MUTED_CHANGE constant defines the value of the
* type property of the event object for a mutedChange event.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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.
*
* @eventType flexEventRender
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const RENDER:String = "flexEventRender";
/**
* 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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
FlexEvent.SELECTION_CHANGE constant defines the value of the
* type property of the event object for a selectionChange event.
*
* The properties of the event object have the following values:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
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:
*| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |