ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.automation.events 

AdvancedDataGridHeaderShiftEvent  - AS3 Flex
Packagemx.automation.events
Classpublic class AdvancedDataGridHeaderShiftEvent
InheritanceAdvancedDataGridHeaderShiftEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The AdvancedDataGridHeaderShiftEvent class represents event objects that are dispatched when an AdvancedDataGrid control's header item is shifted.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] 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
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  itemAutomationValue : String
The automationValue string of the item to be selected.
AdvancedDataGridHeaderShiftEvent
  movingColumnIndex : int
The data provider index of the item to be selected.
AdvancedDataGridHeaderShiftEvent
  newColumnIndex : int
The zero-based index after the change.
AdvancedDataGridHeaderShiftEvent
  oldColumnIndex : int
The zero-based index before the change.
AdvancedDataGridHeaderShiftEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  triggerEvent : Event
Event that triggered the item selection event, such as a keyboard or mouse event.
AdvancedDataGridHeaderShiftEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AdvancedDataGridHeaderShiftEvent(type:String, movingColumnIndex:int = -1, oldColumnIndex:int = -1, newColumnIndex:int = -1, bubbles:Boolean = false, cancelable:Boolean = false, triggerEvent:Event = null)
Constructor.
AdvancedDataGridHeaderShiftEvent
 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 custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method 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
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 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
  HEADER_RELEASE : String = "headerRelease"
[static] The AdvancedDataGridEvent.HEADER_RELEASE constant defines the value of the type property of the event object for a headerRelease event, which indicates that the user pressed and released the mouse on a column header.
AdvancedDataGridHeaderShiftEvent
Property Detail

itemAutomationValue

property
public var itemAutomationValue:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The automationValue string of the item to be selected. This is used when the item to be selected is not visible in the control.

movingColumnIndex

property 
public var movingColumnIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The data provider index of the item to be selected.

newColumnIndex

property 
public var newColumnIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The zero-based index after the change.

oldColumnIndex

property 
public var oldColumnIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The zero-based index before the change.

triggerEvent

property 
public var triggerEvent:Event

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event that triggered the item selection event, such as a keyboard or mouse event.

The default value is null.

Constructor Detail

AdvancedDataGridHeaderShiftEvent

()Constructor
public function AdvancedDataGridHeaderShiftEvent(type:String, movingColumnIndex:int = -1, oldColumnIndex:int = -1, newColumnIndex:int = -1, bubbles:Boolean = false, cancelable:Boolean = false, triggerEvent:Event = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor. Normally called by the Flex control and not used in application code.

Parameters
type:String — The event type; indicates the action that caused the event.
 
movingColumnIndex:int (default = -1) — The data provider index of the item to be selected.
 
oldColumnIndex:int (default = -1) — The zero-based index before the change.
 
newColumnIndex:int (default = -1) — The zero-based index after the change.
 
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.
 
triggerEvent:Event (default = null) — The event, such as a mouse or keyboard event, that triggered the selection action.
Constant Detail

HEADER_RELEASE

Constant
public static const HEADER_RELEASE:String = "headerRelease"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The AdvancedDataGridEvent.HEADER_RELEASE constant defines the value of the type property of the event object for a headerRelease event, which indicates that the user pressed and released the mouse on a column header.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the AdvancedDataGrid object's columns array.
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.
dataFieldThe name of the field or property in the data associated with the column.
itemRendererThe header renderer that is being released.
localXNaN
reasonnull
rowIndexnull
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.
typeAdvancedDataGridEvent.HEADER_RELEASE



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy