Packagemx.events
Classpublic class IndexChangedEvent
InheritanceIndexChangedEvent Inheritance Event Inheritance Object

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
 PropertyDefined by
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
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
 Inheritedprototype : 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
 Inheritedtarget : Object
The event target.
Event
  triggerEvent : Event
The event that triggered this event.
IndexChangedEvent
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
IndexChangedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, relatedObject:DisplayObject = null, oldIndex:Number = -1, newIndex:Number = -1, triggerEvent:Event = null)
Constructor.
IndexChangedEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedCANCEL : String = "cancel"
[static] 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
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame 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
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
newIndexproperty
public var newIndex:Number

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.

oldIndexproperty 
public var oldIndex:Number

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.

relatedObjectproperty 
public var relatedObject:DisplayObject

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

triggerEventproperty 
public var triggerEvent:Event

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)

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
CHANGEconstant
public static const CHANGE:String = "change"

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:

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.
inputTypeIndicates whether this event was caused by a mouse or keyboard interaction.
newIndexThe zero-based index after the change.
oldIndexThe zero-based index before the change.
relatedObjectContains a reference to the child object that corresponds to the new index.
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.
TriggerEventThe event that triggered this event.
TypeIndexChangedEvent.CHANGE
CHILD_INDEX_CHANGEconstant 
public static const CHILD_INDEX_CHANGE:String = "childIndexChange"

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:

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.
inputTypeIndicates whether this event was caused by a mouse or keyboard interaction.
newIndexThe zero-based index of the child after the change.
oldIndexThe zero-based index of the child before the change.
relatedObjectContains a reference to the child object whose index changed.
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.
TriggerEventnull
TypeIndexChangedEvent.CHILD_INDEX_CHANGE
HEADER_SHIFTconstant 
public static const HEADER_SHIFT:String = "headerShift"

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:

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.
inputTypeIndicates whether this event was caused by a mouse or keyboard interaction.
newIndexThe zero-based index of the header after the change.
oldIndexThe zero-based index of the header before the change.
relatedObjectnull
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.
TriggerEventThe event that triggered this event.
TypeIndexChangedEvent.HEADER_SHIFT



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

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