Packagespark.events
Classpublic class IndexChangeEvent
InheritanceIndexChangeEvent Inheritance flash.events.Event

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.

See also

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

Public Properties
 PropertyDefined By
  newIndex : int
The zero-based index after the change.
IndexChangeEvent
  oldIndex : int
The zero-based index before the change.
IndexChangeEvent
Public Methods
 MethodDefined By
  
IndexChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldIndex:int = -1, newIndex:int = -1)
Constructor.
IndexChangeEvent
Public Constants
 ConstantDefined 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
newIndexproperty
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.

oldIndexproperty 
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_CHANGEConstant
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
newIndexThe zero-based index of the selected item after the change.
oldIndexThe zero-based index of the selected item before the change.
targetThe 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.
TypeIndexChangeEvent.CARET_CHANGE

CHANGEConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
newIndexThe zero-based index after the change.
oldIndexThe zero-based index before the change.
targetThe 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.
TypeIndexChangeEvent.CHANGE

CHANGINGConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
newIndexThe zero-based index of the selected item after the change.
oldIndexThe zero-based index of the selected item before the change.
targetThe 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.
TypeIndexChangeEvent.CHANGING





Mon Dec 24 2012, 01:18 PM +11:00