Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
StateChangeEvent

Package | mx.events
Class | public class StateChangeEvent
Inheritance | StateChangeEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | StateChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldState:String = null, newState:String = null) Constructor. | StateChangeEvent

Public Constants

| Constant | Defined 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

newState | property

`public var newState:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

oldState | property |

`public var oldState:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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_CHANGE | Constant

`public static const CURRENT_STATE_CHANGE:String = currentStateChange`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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:

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`.
`newState` | The name of the view state that was entered.
`oldState` | The name of the view state that was exited.
`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.
`type` | StateChangeEvent.CURRENT_STATE_CHANGE

CURRENT_STATE_CHANGING | Constant |

`public static const CURRENT_STATE_CHANGING:String = currentStateChanging`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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:

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`.
`newState` | The name of the view state that is being entered.
`oldState` | The name of the view state that is being exited.
`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.
`type` | StateChangeEvent.CURRENT_STATE_CHANGING

Wed Nov 15 2017, 09:50 AM +01:00