| Package | mx.events |
| Class | public class StateChangeEvent |
| Inheritance | StateChangeEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
currentState property of a component changes.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| 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 | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
StateChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldState:String = null, newState:String = null)
Constructor. | StateChangeEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
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.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
oldState:String (default = null) | |
newState:String (default = null) |
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 |
Mon Apr 10 2017, 12:28 PM -07:00