mx.events.StateChangeEvent (Flex™ 2 Language Reference)

	Property	Defined by
		bubbles : Boolean Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean 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 The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object The event target.	Event
		type : String 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
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the `toString()` method in your custom Event class.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether `preventDefault()` has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined by
		ACTIVATE : String = "activate" [static] Defines the value of the `type` property of an `activate` event object.	Event
		ADDED : String = "added" [static] Defines the value of the `type` property of an `added` event object.	Event
		CANCEL : String = "cancel" [static] Defines the value of the `type` property of a `cancel` event object.	Event
		CHANGE : String = "change" [static] Defines the value of the `type` property of a `change` event object.	Event
		CLOSE : String = "close" [static] Defines the value of the `type` property of a `close` event object.	Event
		COMPLETE : String = "complete" [static] Defines the value of the `type` property of a `complete` event object.	Event
		CONNECT : String = "connect" [static] Defines the value of the `type` property of a `connect` event object.	Event
		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
		DEACTIVATE : String = "deactivate" [static] Defines the value of the `type` property of a `deactivate` event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] Defines the value of the `type` property of an `enterFrame` event object.	Event
		ID3 : String = "id3" [static] Defines the value of the `type` property of an `id3` event object.	Event
		INIT : String = "init" [static] Defines the value of the `type` property of an `init` event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the `type` property of a `mouseLeave` event object.	Event
		OPEN : String = "open" [static] Defines the value of the `type` property of an `open` event object.	Event
		REMOVED : String = "removed" [static] Defines the value of the `type` property of a `removed` event object.	Event
		RENDER : String = "render" [static] Defines the value of the `type` property of a `render` event object.	Event
		RESIZE : String = "resize" [static] Defines the value of the `type` property of a `resize` event object.	Event
		SCROLL : String = "scroll" [static] Defines the value of the `type` property of a `scroll` event object.	Event
		SELECT : String = "select" [static] Defines the value of the `type` property of a `select` event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the `type` property of a `soundComplete` event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the `type` property of a `tabChildrenChange` event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the `type` property of a `tabEnabledChange` event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the `type` property of a `tabIndexChange` event object.	Event
		UNLOAD : String = "unload" [static] Defines the value of the `type` property of an `unload` event object.	Event

Property detail

newState

property

public var newState:String

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

oldState

property

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_CHANGE

constant

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:

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"

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

Current page: http://livedocs.adobe.com/flex/2/langref/mx/events/StateChangeEvent.html

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class StateChangeEvent	Properties \| Methods \| Constants

Package	mx.events
Class	public class StateChangeEvent
Inheritance	StateChangeEvent Event Object