| Package | mx.states |
| Class | public class State |
| Inheritance | State  EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
overrides property specifies a set of child classes
to add or remove from the base view state, and properties, styles, and event
handlers to set when the view state is in effect.
You use the State class in the states property
of Flex components.
You can only specify a states property at the root of an
application or a custom control, not on child controls.
You enable a view state by setting a component's
currentState property.
Show MXML Syntax
Hide MXML SyntaxThe <mx:State> tag has the following attributes:
<mx:State Properties basedOn="null" name="null" overrides="null" />
Default MXML Propertyoverrides
More examples
Example: Creating a simple view state
Create and apply view states
Defining view state groups
Example: Controlling layout using view states groups
Learn more
Related API Elements
mx.states.RemoveChild
mx.states.SetEventHandler
mx.states.SetProperty
mx.states.SetStyle
mx.states.Transition
| Property | Defined By | ||
|---|---|---|---|
| basedOn : String
The name of the view state upon which this view state is based, or
null if this view state is not based on a named view state. | State | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| name : String
The name of the view state. | State | ||
| overrides : Array
The overrides for this view state, as an Array of objects that implement
the IOverride interface. | State | ||
| stateGroups : Array
The state groups that this view state belongs to as an array of String. | State | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | State | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched after a view state has been entered. | State | |||
| Dispatched just before a view state is exited. | State | |||
basedOn | property |
public var basedOn:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of the view state upon which this view state is based, or
null if this view state is not based on a named view state.
If this value is null, the view state is based on a root
state that consists of the properties, styles, event handlers, and
children that you define for a component without using a State class.
The default value is null.
name | property |
public var name:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of the view state. State names must be unique for a given component. This property must be set.
overrides | property |
public var overrides:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The overrides for this view state, as an Array of objects that implement the IOverride interface. These overrides are applied in order when the state is entered, and removed in reverse order when the state is exited.
The following Flex classes implement the IOverride interface and let you define the view state characteristics:
- AddChild
- RemoveChild
- SetEventHandler
- SetProperty
- SetStyle
The overrides property is the default property of the
State class. You can omit the <mx:overrides> tag
and its child <mx:Array>tag if you use MXML tag
syntax to define the overrides.
stateGroups | property |
public var stateGroups:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The state groups that this view state belongs to as an array of String.
State | () | Constructor |
enterState | Event |
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.ENTER_STATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched after a view state has been entered.
TheFlexEvent.ENTER_STATE constant defines the value of the
type property of the event object for a enterState event.
This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.
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. |
exitState | Event |
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.EXIT_STATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched just before a view state is exited. This event is dispatched before the changes to the default view state have been removed.
TheFlexEvent.EXIT_STATE constant defines the value of the
type property of the event object for a exitState event.
This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.
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. |
Mon Apr 10 2017, 12:28 PM -07:00