Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.events 
AdvancedDataGridEvent 
Packagemx.events
Classpublic class AdvancedDataGridEvent
InheritanceAdvancedDataGridEvent Inheritance Event Inheritance Object

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



Public Properties
 PropertyDefined By
  animate : Boolean
If true, animate an opening or closing operation; used for ITEM_OPENING type events only.
AdvancedDataGridEvent
 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
  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
 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
  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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  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
 Inheritedtarget : Object
[read-only] The event target.
Event
  triggerEvent : Event
The MouseEvent object or KeyboardEvent object for the event that triggered this event, or null if this event was triggered programmatically.
AdvancedDataGridEvent
 Inheritedtype : String
[read-only] The type of event.
Event
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 = NaN, multiColumnSort:Boolean = false, removeColumnFromSort:Boolean = false, item:Object = null, triggerEvent:Event = null, headerPart:String = null)
Constructor.
AdvancedDataGridEvent
 Inherited
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
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant efines the value of the type property of a clear event object.
Event
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
  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
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
 InheritedDISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
  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
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
  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
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
  SORT : String = "sort"
[static] The AdvancedDataGridEvent.SORT constant defines the value of the type property of the event object for a sort event.
AdvancedDataGridEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
Event
Property Detail

animate

property
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.

column

property 
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.

columnIndex

property 
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.

dataField

property 
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.

dispatchEvent

property 
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.

headerPart

property 
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.

item

property 
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.

itemRenderer

property 
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.

localX

property 
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.

multiColumnSort

property 
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.

opening

property 
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.

reason

property 
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

removeColumnFromSort

property 
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.

rowIndex

property 
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.

triggerEvent

property 
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 = NaN, 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)
Constant Detail

COLUMN_STRETCH

Constant
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_OUTSIDE

Constant 
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_OUTSIDE

Constant 
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_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.
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_CLOSE

Constant 
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_BEGIN

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

  • Creates an item editor object by using a call to the createItemEditor() method.
  • Copies the data property from the item to the editor. By default, the item editor object is an instance of the TextInput control. You use the itemEditor property of the list control to specify a custom item editor class.
  • Sets the itemEditorInstance property of the list control to reference the item editor instance.

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_BEGINNING

Constant 
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_END

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

  • Uses the editorDataField property of the AdvancedDataGridColumn associated with this event to determine the property of the item editor containing the new data and updates the data provider item with that new data. Since the default item editor is the TextInput control, the default value of the editorDataField property is "text", to specify that the text property of the TextInput contains the new item data.
  • Calls the destroyItemEditor() method to close the item editor.

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

  • In your event listener, you can modify the data returned by the editor to the list component. For example, you can reformat the data before returning it to the list control. By default, an item editor can only return a single value. You must write an event listener for the itemEditEnd event if you want to return multiple values.
  • In your event listener, you can examine the data entered into the item editor. If the data is incorrect, you can call the preventDefault() method to stop Flex from passing the new data back to the list control and from closing the editor.

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_IN

Constant 
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_OUT

Constant 
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_OPEN

Constant 
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_OPENING

Constant 
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

SORT

Constant 
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