Packagemx.events
Classpublic class StateChangeEvent
InheritanceStateChangeEvent Inheritance flash.events.Event

The StateChangeEvent class represents an event that is dispatched when the currentState property of a component changes.

See also

mx.core.UIComponent
mx.states.State


Public Properties
 PropertyDefined by
  newState : String
The name of the view state that the component is entering.
StateChangeEvent
  oldState : String
The name of the view state that the component is exiting.
StateChangeEvent
Public Methods
 MethodDefined by
  
StateChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldState:String = null, newState:String = null)
Constructor.
StateChangeEvent
Public Constants
 ConstantDefined by
  CURRENT_STATE_CHANGE : String = "currentStateChange"
[static] The StateChangeEvent.CURRENT_STATE_CHANGE constant defines the value of the type property of the event that is dispatched when the view state has changed.
StateChangeEvent
  CURRENT_STATE_CHANGING : String = "currentStateChanging"
[static] The StateChangeEvent.CURRENT_STATE_CHANGING constant defines the value of the type property of the event that is dispatched when the view state is about to change.
StateChangeEvent
Property detail
newStateproperty
public var newState:String

The name of the view state that the component is entering.

oldStateproperty 
public var oldState:String

The name of the view state that the component is exiting.

Constructor detail
StateChangeEvent()constructor
public function StateChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldState:String = null, newState:String = null)

Constructor. Normally called by a Flex control and not used in application code.

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.
 
oldState:String (default = null) — The name of the view state the component is exiting.
 
newState:String (default = null) — The name of the view state the component is entering.
Constant detail
CURRENT_STATE_CHANGEconstant
public static const CURRENT_STATE_CHANGE:String = "currentStateChange"

The StateChangeEvent.CURRENT_STATE_CHANGE constant defines the value of the type property of the event that is dispatched when the view state has changed. The value of this constant is "currentStateChange".

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.
newStateThe name of the view state that was entered.
oldStateThe name of the view state that was exited.
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.
typeStateChangeEvent.CURRENT_STATE_CHANGE
CURRENT_STATE_CHANGINGconstant 
public static const CURRENT_STATE_CHANGING:String = "currentStateChanging"

The StateChangeEvent.CURRENT_STATE_CHANGING constant defines the value of the type property of the event that is dispatched when the view state is about to change. The value of this constant is "currentStateChanging".

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.
newStateThe name of the view state that is being entered.
oldStateThe name of the view state that is being exited.
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.
typeStateChangeEvent.CURRENT_STATE_CHANGING