IndexChangeEvent

Package	spark.events
Class	public class IndexChangeEvent
Inheritance	IndexChangeEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The IndexChangeEvent class represents events that are dispatched when an index changes in a Spark component.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

spark.components.supportClasses.ListBase
spark.components.List
spark.components.ButtonBar

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 : int The zero-based index after the change.	IndexChangeEvent
		oldIndex : int The zero-based index before the change.	IndexChangeEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		IndexChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldIndex:int = -1, newIndex:int = -1) Constructor.	IndexChangeEvent
		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

	Constant		Defined By
		CARET_CHANGE : String = "caretChange" [static] The IndexChangeEvent.CARET_CHANGE constant defines the value of the type property of the event object for a caretChange event, which indicates that the current item in focus is about to change.	IndexChangeEvent
		CHANGE : String = "change" [static] The IndexChangeEvent.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 a List-based control changes its selection.	IndexChangeEvent
		CHANGING : String = "changing" [static] The IndexChangeEvent.CHANGING constant defines the value of the type property of the event object for a changing event, which indicates that the current selection is about to change.	IndexChangeEvent

Property Detail

newIndex

property

public var newIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The zero-based index after the change. For change events it is the index of the current child.

oldIndex

property

public var oldIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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

Constructor Detail

IndexChangeEvent

()

Constructor

public function IndexChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldIndex:int = -1, newIndex:int = -1)

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

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.

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

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

Constant Detail

CARET_CHANGE

Constant

public static const CARET_CHANGE:String = "caretChange"

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The IndexChangeEvent.CARET_CHANGE constant defines the value of the type property of the event object for a caretChange event, which indicates that the current item in focus is about to change.

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`.
`newIndex`	The zero-based index of the selected item after the change.
`oldIndex`	The zero-based index of the selected item before the change.
`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`	IndexChangeEvent.CARET_CHANGE

CHANGE

Constant

public static const CHANGE:String = "change"

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The IndexChangeEvent.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 a List-based control changes its selection.

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`.
`newIndex`	The zero-based index after the change.
`oldIndex`	The zero-based index before the change.
`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`	IndexChangeEvent.CHANGE

CHANGING

Constant

public static const CHANGING:String = "changing"

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The IndexChangeEvent.CHANGING constant defines the value of the type property of the event object for a changing event, which indicates that the current selection is about to change.

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`.
`newIndex`	The zero-based index of the selected item after the change.
`oldIndex`	The zero-based index of the selected item before the change.
`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`	IndexChangeEvent.CHANGING

Legal Notices | Online Privacy Policy

IndexChangeEvent - AS3 Flex

Classes x

newIndex

oldIndex

IndexChangeEvent

CARET_CHANGE

CHANGE

CHANGING