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

The AdvancedDataGridColumnGroup instance for the column that caused the event.

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

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

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

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

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.

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.

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

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.

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

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

If true, remove the column from the multicolumn sort.

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

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

Constructor.

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:

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:

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:

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:

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.

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:

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:

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:

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:

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:

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.

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.

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: