mx.events.IndexChangedEvent - Adobe® Flex® 4 Language Reference (Flex 4)

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The IndexChangedEvent class represents events that are dispatched when an index changes. This event can indicate that the index value of a child of a container changed, the displayed child of a navigator container such as an Accordion or ViewStack changed, or the order of column headers in a DataGrid control changed.

See also

mx.core.Container

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
		newIndex : Number The zero-based index after the change.	IndexChangedEvent
		oldIndex : Number The zero-based index before the change.	IndexChangedEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		relatedObject : DisplayObject The child object whose index changed, or the object associated with the new index.	IndexChangedEvent
		target : Object [read-only] The event target.	Event
		triggerEvent : Event The event that triggered this event.	IndexChangedEvent
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		IndexChangedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, relatedObject:DisplayObject = null, oldIndex:Number = -1, newIndex:Number = -1, triggerEvent:Event = null) Constructor.	IndexChangedEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method 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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		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] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The IndexChangedEvent.CHANGE constant defines the value of the type property of the event object for a change event, which indicates that an index has changed, such as when and Accordion control changes the displayed panel or a ViewStack changes views.	IndexChangedEvent
		CHILD_INDEX_CHANGE : String = "childIndexChange" [static] The IndexChangedEvent.CHILD_INDEX_CHANGE constant defines the value of the type property of the event object for a childIndexChange event, which indicates that a component's index among a container's children has changed.	IndexChangedEvent
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HEADER_SHIFT : String = "headerShift" [static] The IndexChangedEvent.HEADER_SHIFT constant defines the value of the type property of the event object for a headerShift event, which indicates that a header has changed its index, as when a user drags a DataGrid column to a new position.	IndexChangedEvent
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

Property Detail

newIndex

property

public var newIndex:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The zero-based index after the change. For change events it is the index of the current child. For childIndexChange events, it is the new index of the child. For headerShift events, it is the new index of the header.

oldIndex

property

public var oldIndex:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The zero-based index before the change. For change events it is the index of the previous child. For childIndexChange events, it is the previous index of the child. For headerShift events, it is the previous index of the header.

relatedObject

property

public var relatedObject:DisplayObject

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The child object whose index changed, or the object associated with the new index. This property is not set for header changes.

triggerEvent

property

public var triggerEvent:Event

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The event that triggered this event. Indicates whether this event was caused by a mouse or keyboard interaction. The value is null when a container dispatches a childIndexChanged event.

Constructor Detail

IndexChangedEvent

()

Constructor

public function IndexChangedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, relatedObject:DisplayObject = null, oldIndex:Number = -1, newIndex:Number = -1, triggerEvent:Event = 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.

	`relatedObject:DisplayObject` (default = `null`) — The child object associated with the index change.

	`oldIndex:Number` (default = `-1`) — The zero-based index before the change.

	`newIndex:Number` (default = `-1`) — The zero-based index after the change.

	`triggerEvent:Event` (default = `null`) — The event that triggered this event.

Constant Detail

CHANGE

Constant

public static const CHANGE:String = "change"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The IndexChangedEvent.CHANGE constant defines the value of the type property of the event object for a change event, which indicates that an index has changed, such as when and Accordion control changes the displayed panel or a ViewStack changes views.

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`.
`inputType`	Indicates whether this event was caused by a mouse or keyboard interaction.
`newIndex`	The zero-based index after the change.
`oldIndex`	The zero-based index before the change.
`relatedObject`	Contains a reference to the child object that corresponds to the new index.
`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.
`TriggerEvent`	The event that triggered this event.
`Type`	IndexChangedEvent.CHANGE

CHILD_INDEX_CHANGE

Constant

public static const CHILD_INDEX_CHANGE:String = "childIndexChange"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The IndexChangedEvent.CHILD_INDEX_CHANGE constant defines the value of the type property of the event object for a childIndexChange event, which indicates that a component's index among a container's children has changed.

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`.
`inputType`	Indicates whether this event was caused by a mouse or keyboard interaction.
`newIndex`	The zero-based index of the child after the change.
`oldIndex`	The zero-based index of the child before the change.
`relatedObject`	Contains a reference to the child object whose index changed.
`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.
`TriggerEvent`	null
`Type`	IndexChangedEvent.CHILD_INDEX_CHANGE

HEADER_SHIFT

Constant

public static const HEADER_SHIFT:String = "headerShift"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The IndexChangedEvent.HEADER_SHIFT constant defines the value of the type property of the event object for a headerShift event, which indicates that a header has changed its index, as when a user drags a DataGrid column to a new position.

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`.
`inputType`	Indicates whether this event was caused by a mouse or keyboard interaction.
`newIndex`	The zero-based index of the header after the change.
`oldIndex`	The zero-based index of the header before the change.
`relatedObject`	null
`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.
`TriggerEvent`	The event that triggered this event.
`Type`	IndexChangedEvent.HEADER_SHIFT