Packagemx.events
Classpublic class AdvancedDataGridEvent
InheritanceAdvancedDataGridEvent Inheritance flash.events.Event

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

The AdvancedDataGridEvent class represents event objects that are specific to the AdvancedDataGrid control, such as the event that is dispatched when an editable grid item gets the focus.

See also

mx.controls.AdvancedDataGrid
mx.events.AdvancedDataGridEventReason


Public Properties
 PropertyDefined By
  animate : Boolean
If true, animate an opening or closing operation; used for ITEM_OPENING type events only.
AdvancedDataGridEvent
  column : AdvancedDataGridColumn
The AdvancedDataGridColumnGroup instance for the column that caused the event.
AdvancedDataGridEvent
  columnIndex : int
The zero-based index in the AdvancedDataGrid object's columns Array of the column associated with the event.
AdvancedDataGridEvent
  dataField : String
The name of the field or property in the data associated with the column.
AdvancedDataGridEvent
  dispatchEvent : Boolean
Whether to dispatch an ITEM_OPEN or ITEM_CLOSE event after the open or close animation is complete.
AdvancedDataGridEvent
  headerPart : String
If HEADER_RELEASE event, which part of the header was clicked.
AdvancedDataGridEvent
  item : Object
Storage for the node property.
AdvancedDataGridEvent
  itemRenderer : IListItemRenderer
The item renderer for the item that is being edited, or the header render that is being clicked or stretched.
AdvancedDataGridEvent
  localX : Number
The column's x-position, in pixels; used for replaying column stretch events.
AdvancedDataGridEvent
  multiColumnSort : Boolean
If true, indicates that the new dataField property should be used along with whatever sorting is already in use, resulting in a multicolumn sort.
AdvancedDataGridEvent
  opening : Boolean
Indicates whether the item is opening true, or closing false.
AdvancedDataGridEvent
  reason : String
The reason the itemEditEnd event was dispatched.
AdvancedDataGridEvent
  removeColumnFromSort : Boolean
If true, remove the column from the multicolumn sort.
AdvancedDataGridEvent
  rowIndex : int
The zero-based index of the item in the data provider.
AdvancedDataGridEvent
  triggerEvent : Event
The MouseEvent object or KeyboardEvent object for the event that triggered this event, or null if this event was triggered programmatically.
AdvancedDataGridEvent
Public Methods
 MethodDefined By
  
AdvancedDataGridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, dataField:String = null, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null, localX:Number, multiColumnSort:Boolean = false, removeColumnFromSort:Boolean = false, item:Object = null, triggerEvent:Event = null, headerPart:String = null)
Constructor.
AdvancedDataGridEvent
Public Constants
 ConstantDefined By
  COLUMN_STRETCH : String = columnStretch
[static] The AdvancedDataGridEvent.COLUMN_STRETCH constant defines the value of the type property of the event object for a columnStretch event, which indicates that a user expanded a column horizontally.
AdvancedDataGridEvent
  HEADER_DRAG_OUTSIDE : String = headerDragOutside
[static] The AdvancedDataGridEvent.HEADER_DRAG_OUTSIDE constant defines the value of the type property of the event object for a headerDragOutside event, which indicates that the user pressed and released the mouse on a column header.
AdvancedDataGridEvent
  HEADER_DROP_OUTSIDE : String = headerDropOutside
[static] The AdvancedDataGridEvent.HEADER_DROP_OUTSIDE constant defines the value of the type property of the event object for a headerDropOutside event.
AdvancedDataGridEvent
  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.
AdvancedDataGridEvent
  ITEM_CLOSE : String = itemClose
[static] The AdvancedDataGridEvent.ITEM_CLOSE event type constant indicates that a AdvancedDataGrid branch closed or collapsed.
AdvancedDataGridEvent
  ITEM_EDIT_BEGIN : String = itemEditBegin
[static] The AdvancedDataGridEvent.ITEM_EDIT_BEGIN constant defines the value of the type property of the event object for a itemEditBegin event, which indicates that an item is ready to be edited.
AdvancedDataGridEvent
  ITEM_EDIT_BEGINNING : String = itemEditBeginning
[static] The AdvancedDataGridEvent.ITEM__EDIT_BEGINNING constant defines the value of the type property of the event object for a itemEditBeginning event, which indicates that the user has prepared to edit an item, for example, by releasing the mouse button over the item.
AdvancedDataGridEvent
  ITEM_EDIT_END : String = itemEditEnd
[static] The AdvancedDataGridEvent.ITEM_EDIT_END constant defines the value of the type property of the event object for a itemEditEnd event, which indicates that an edit session is ending.
AdvancedDataGridEvent
  ITEM_FOCUS_IN : String = itemFocusIn
[static] The AdvancedDataGridEvent.ITEM_FOCUS_IN constant defines the value of the type property of the event object for a itemFocusIn event, which indicates that an item has received the focus.
AdvancedDataGridEvent
  ITEM_FOCUS_OUT : String = itemFocusOut
[static] The AdvancedDataGridEvent.ITEM_FOCUS_OUT constant defines the value of the type property of the event object for a itemFocusOut event, which indicates that an item has lost the focus.
AdvancedDataGridEvent
  ITEM_OPEN : String = itemOpen
[static] The AdvancedDataGridEvent.ITEM_OPEN event type constant indicates that an AdvancedDataGrid branch opened or expanded.
AdvancedDataGridEvent
  ITEM_OPENING : String = itemOpening
[static] The AdvancedDataGridEvent.ITEM_OPENING event type constant is dispatched immediately before a AdvancedDataGrid opens or closes.
AdvancedDataGridEvent
  SORT : String = sort
[static] The AdvancedDataGridEvent.SORT constant defines the value of the type property of the event object for a sort event.
AdvancedDataGridEvent
Property Detail
animateproperty
public var animate:Boolean

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

If true, animate an opening or closing operation; used for ITEM_OPENING type events only.

columnproperty 
public var column:AdvancedDataGridColumn

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

The AdvancedDataGridColumnGroup instance for the column that caused the event.

columnIndexproperty 
public var columnIndex:int

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

The zero-based index in the AdvancedDataGrid object's columns Array of the column associated with the event.

dataFieldproperty 
public var dataField:String

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

The name of the field or property in the data associated with the column.

dispatchEventproperty 
public var dispatchEvent:Boolean

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

Whether to dispatch an ITEM_OPEN or ITEM_CLOSE event after the open or close animation is complete. Used for ITEM_OPENING events only.

headerPartproperty 
public var headerPart:String

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

If HEADER_RELEASE event, which part of the header was clicked.

itemproperty 
public var item:Object

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

Storage for the node property. If you populate the AdvancedDataGrid control from XML data, access the label and data properties for the node as event.node.attributes.label and event.node.attributes.data.

itemRendererproperty 
public var itemRenderer:IListItemRenderer

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

The item renderer for the item that is being edited, or the header render that is being clicked or stretched. You can access the data provider by using this property.

localXproperty 
public var localX:Number

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

The column's x-position, in pixels; used for replaying column stretch events.

multiColumnSortproperty 
public var multiColumnSort:Boolean

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

If true, indicates that the new dataField property should be used along with whatever sorting is already in use, resulting in a multicolumn sort.

If false, any sorting present should be removed, and a fresh sorting should be done for the new dataField property.

openingproperty 
public var opening:Boolean

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

Indicates whether the item is opening true, or closing false. Used for an ITEM_OPENING type events only.

reasonproperty 
public var reason:String

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

The reason the itemEditEnd event was dispatched. Valid only for events with type ITEM_EDIT_END. The possible values are defined in the AdvancedDataGridEventReason class.

See also

removeColumnFromSortproperty 
public var removeColumnFromSort:Boolean

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

If true, remove the column from the multicolumn sort.

rowIndexproperty 
public var rowIndex:int

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

The zero-based index of the item in the data provider.

triggerEventproperty 
public var triggerEvent:Event

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

The MouseEvent object or KeyboardEvent object for the event that triggered this event, or null if this event was triggered programmatically.

Constructor Detail
AdvancedDataGridEvent()Constructor
public function AdvancedDataGridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, dataField:String = null, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null, localX:Number, multiColumnSort:Boolean = false, removeColumnFromSort:Boolean = false, item:Object = null, triggerEvent:Event = null, headerPart:String = null)

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

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.
 
columnIndex:int (default = -1) — The zero-based index of the column where the event occurred.
 
dataField:String (default = null) — The name of the field or property in the data associated with the column.
 
rowIndex:int (default = -1) — The zero-based index of the item in the data provider.
 
reason:String (default = null) — The reason for an itemEditEnd event.
 
itemRenderer:IListItemRenderer (default = null) — The item renderer that is being edited or the header renderer that was clicked.
 
localX:Number (default = NaN) — Column x position for replaying columnStretch events.
 
multiColumnSort:Boolean (default = false) — Specifies a multicolumn sort.
 
removeColumnFromSort:Boolean (default = false) — Specifies to remove the column from the multicolumn sort.
 
item:Object (default = null) — Specifies the node property. .
 
triggerEvent:Event (default = null) — The MouseEvent or KeyboardEvent that triggered this event or null if this event was triggered programmatically.
 
headerPart:String (default = null) — The part of the header that was clicked.
Constant Detail
COLUMN_STRETCHConstant
public static const COLUMN_STRETCH:String = columnStretch

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

The AdvancedDataGridEvent.COLUMN_STRETCH constant defines the value of the type property of the event object for a columnStretch event, which indicates that a user expanded a column horizontally.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
itemThe AdvancedDataGrid item (node) that closed.
itemRenderernull
localXThe x position of the mouse.
multiColumnSort false
reasonnull
removeColumnFromSortfalse
rowIndexThe zero-based index of the item in the data provider.
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.COLUMN_STRETCH

HEADER_DRAG_OUTSIDEConstant 
public static const HEADER_DRAG_OUTSIDE:String = headerDragOutside

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

The AdvancedDataGridEvent.HEADER_DRAG_OUTSIDE constant defines the value of the type property of the event object for a headerDragOutside 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

HEADER_DROP_OUTSIDEConstant 
public static const HEADER_DROP_OUTSIDE:String = headerDropOutside

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

The AdvancedDataGridEvent.HEADER_DROP_OUTSIDE constant defines the value of the type property of the event object for a headerDropOutside event.

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.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe header renderer that is being released.
localXNaN
multiColumnSort false
reasonnull
removeColumnFromSortfalse
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.HEADER_RELEASE

HEADER_RELEASEConstant 
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.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe header renderer that is being released.
localXNaN
multiColumnSort undefined - Use the sort event if you want to sort on multiple columns.
reasonnull
removeColumnFromSortfalse
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.HEADER_RELEASE

ITEM_CLOSEConstant 
public static const ITEM_CLOSE:String = itemClose

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

The AdvancedDataGridEvent.ITEM_CLOSE event type constant indicates that a AdvancedDataGrid branch closed or collapsed.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

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.
dataFieldThe name of the field or property in the data associated with the column.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe ListItemRenderer for the node that closed.
localXNaN
multiColumnSort false
removeColumnFromSortfalse
rowIndex-1
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_CLOSE

ITEM_EDIT_BEGINConstant 
public static const ITEM_EDIT_BEGIN:String = itemEditBegin

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

The AdvancedDataGridEvent.ITEM_EDIT_BEGIN constant defines the value of the type property of the event object for a itemEditBegin event, which indicates that an item is ready to be edited.

The default listener for this event performs the following actions:

You can write an event listener for this event to modify the data passed to the item editor. For example, you might modify the data, its format, or other information used by the item editor.

You can also create an event listener to specify the item editor used to edit the item. For example, you might have two different item editors. Within the event listener, you can examine the data to be edited or other information, and open the appropriate item editor by doing the following:

  1. Call preventDefault() to stop Flex from calling the createItemEditor() method as part of the default event listener.
  2. Set the itemEditor property to the appropriate editor.
  3. Call the createItemEditor() method.

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.
dataFieldnull
itemThe AdvancedDataGrid item (node).
itemRendererThe item renderer for the item that is being edited.
localXNaN
multiColumnSort false
reasonnull
removeColumnFromSortfalse
rowIndexThe zero-based index of the item in the data provider.
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_EDIT_BEGIN

ITEM_EDIT_BEGINNINGConstant 
public static const ITEM_EDIT_BEGINNING:String = itemEditBeginning

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

The AdvancedDataGridEvent.ITEM__EDIT_BEGINNING constant defines the value of the type property of the event object for a itemEditBeginning event, which indicates that the user has prepared to edit an item, for example, by releasing the mouse button over the item.

The default listener for this event sets the AdvancedDataGrid.editedItemPosition property to the item that has focus, which starts the item editing session.

You typically write your own event listener for this event to disallow editing of a specific item or items. Calling the preventDefault() method from within your own event listener for this event prevents the default listener from executing.

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 item's column.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe item renderer for the item that will be edited. This property is null if this event is generated by keyboard, as the item to be edited may be off-screen.
localXNaN
multiColumnSort false
reasonnull
removeColumnFromSortfalse
rowIndexThe zero-based index of the item in the data provider.
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_EDIT_BEGINNING

ITEM_EDIT_ENDConstant 
public static const ITEM_EDIT_END:String = itemEditEnd

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

The AdvancedDataGridEvent.ITEM_EDIT_END constant defines the value of the type property of the event object for a itemEditEnd event, which indicates that an edit session is ending.

The list components have a default handler for this event that copies the data from the item editor to the data provider of the list control. The default event listener performs the following actions:

You typically write an event listener for this event to perform the following actions:

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 item's column.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe item renderer for the item that is being edited.
localXNaN
multiColumnSort false
reasonA constant defining the reason for the event. The value must be a member of the AdvancedDataGridEventReason class.
removeColumnFromSortfalse
rowIndexThe zero-based index of the item in the data provider.
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_EDIT_END

ITEM_FOCUS_INConstant 
public static const ITEM_FOCUS_IN:String = itemFocusIn

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

The AdvancedDataGridEvent.ITEM_FOCUS_IN constant defines the value of the type property of the event object for a itemFocusIn event, which indicates that an item has received the focus.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
dataFieldnull
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe item editor instance for the item that is being edited.
localXNaN
multiColumnSort false
reasonnull
removeColumnFromSortfalse
rowIndexThe zero-based index of the item in the data provider.
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_FOCUS_IN

ITEM_FOCUS_OUTConstant 
public static const ITEM_FOCUS_OUT:String = itemFocusOut

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

The AdvancedDataGridEvent.ITEM_FOCUS_OUT constant defines the value of the type property of the event object for a itemFocusOut event, which indicates that an item has lost the focus.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
dataFieldnull
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe item editor instance for the item that is being edited.
localXNaN
multiColumnSort false
reasonnull
removeColumnFromSortfalse
rowIndexThe zero-based index of the item in the data provider.
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_FOCUS_OUT

ITEM_OPENConstant 
public static const ITEM_OPEN:String = itemOpen

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

The AdvancedDataGridEvent.ITEM_OPEN event type constant indicates that an AdvancedDataGrid branch opened or expanded.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

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.
itemThe AdvancedDataGrid node that opened.
itemRendererThe ListItemRenderer for the item (node) that opened.
localXNaN
multiColumnSort false
removeColumnFromSortfalse
rowIndex-1
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.
triggerEventIf the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_OPEN

ITEM_OPENINGConstant 
public static const ITEM_OPENING:String = itemOpening

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

The AdvancedDataGridEvent.ITEM_OPENING event type constant is dispatched immediately before a AdvancedDataGrid opens or closes.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
animateWhether to animate the opening or closing operation.
bubblesfalse
cancelabletrue
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.
dispatchEventWhether to dispatch an ITEM_OPEN or ITEM_CLOSE event after the open or close animation is complete. true
itemThe AdvancedDataGrid node that opened.
itemRendererThe ListItemRenderer for the item (node) that opened.
localXNaN
multiColumnSort false
removeColumnFromSortfalse
rowIndex-1
openingtrue if the item is opening, false if it is closing.
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.
triggerEventIf the item opened in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_OPENING

SORTConstant 
public static const SORT:String = sort

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

The AdvancedDataGridEvent.SORT constant defines the value of the type property of the event object for a sort event. The AdvancedDataGrid control performs sorting based on the value of the dataField and multiColumnSort properties.

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.
multiColumnSort If true, indicates that the new dataField property should be used along with whatever sorting is already in use, resulting in a multicolumn sort.

If false, any sorting present should be removed, and a fresh sorting should be done for the new dataField property.

removeColumnFromSortfalse
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.SORT