Language Version : | ActionScript 3.0 |
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.
public var animate:Boolean
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
If true
, animate an opening or closing operation; used for
ITEM_OPENING
type events only.
public var column:AdvancedDataGridColumn
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The AdvancedDataGridColumnGroup instance for the column that caused the event.
public var columnIndex:int
Language Version : | ActionScript 3.0 |
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.
public var dataField:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The name of the field or property in the data associated with the column.
public var dispatchEvent:Boolean
Language Version : | ActionScript 3.0 |
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.
public var headerPart:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
If HEADER_RELEASE event, which part of the header was clicked.
public var item:Object
Language Version : | ActionScript 3.0 |
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
.
public var itemRenderer:IListItemRenderer
Language Version : | ActionScript 3.0 |
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.
public var localX:Number
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The column's x-position, in pixels; used for replaying column stretch events.
public var multiColumnSort:Boolean
Language Version : | ActionScript 3.0 |
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.
public var opening:Boolean
Language Version : | ActionScript 3.0 |
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.
public var reason:String
Language Version : | ActionScript 3.0 |
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
public var removeColumnFromSort:Boolean
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
If true
, remove the column from the multicolumn sort.
public var rowIndex:int
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The zero-based index of the item in the data provider.
public var triggerEvent:Event
Language Version : | ActionScript 3.0 |
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.
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 |
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.
|
public static const COLUMN_STRETCH:String = columnStretch
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The name of the field or property in the
data associated with the column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | null |
localX | The x position of the mouse. |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the
item in the data provider. |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.COLUMN_STRETCH |
public static const HEADER_DRAG_OUTSIDE:String = headerDragOutside
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The name of the field or property in the
data associated with the column. |
itemRenderer | The header renderer that is
being released. |
localX | NaN |
reason | null |
rowIndex | null |
target | The 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. |
type | AdvancedDataGridEvent.HEADER_RELEASE |
public static const HEADER_DROP_OUTSIDE:String = headerDropOutside
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The name of the field or property in the
data associated with the column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The header renderer that is
being released. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | null |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.HEADER_RELEASE |
public static const HEADER_RELEASE:String = headerRelease
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The name of the field or property in the
data associated with the column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The header renderer that is
being released. |
localX | NaN |
multiColumnSort | undefined - Use the sort event
if you want to sort on multiple columns. |
reason | null |
removeColumnFromSort | false |
rowIndex | null |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.HEADER_RELEASE |
public static const ITEM_CLOSE:String = itemClose
Language Version : | ActionScript 3.0 |
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.
Property | Value |
---|
bubbles | false |
cancelable | false |
currentTarget | The 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 . |
dataField | The name of the field or property in the data associated with the column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The ListItemRenderer for the node that closed. |
localX | NaN |
multiColumnSort | false |
removeColumnFromSort | false |
rowIndex | -1 |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_CLOSE |
public static const ITEM_EDIT_BEGIN:String = itemEditBegin
Language Version : | ActionScript 3.0 |
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:
- Call
preventDefault()
to stop Flex from calling
the createItemEditor()
method as part
of the default event listener.
- Set the
itemEditor
property to the appropriate editor.
- Call the
createItemEditor()
method.
The properties of the event object have the following values:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | null |
item | The AdvancedDataGrid item (node). |
itemRenderer | The item renderer for the item
that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the
item in the data provider. |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_EDIT_BEGIN |
public static const ITEM_EDIT_BEGINNING:String = itemEditBeginning
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The name of the field or property in the
data associated with the item's column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The 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. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the
item in the data provider. |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_EDIT_BEGINNING |
public static const ITEM_EDIT_END:String = itemEditEnd
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The name of the field or property in the
data associated with the item's column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item renderer for the item
that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | A constant defining the reason for the event.
The value must be a member of the AdvancedDataGridEventReason class. |
removeColumnFromSort | false |
rowIndex | The zero-based index of the
item in the data provider. |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_EDIT_END |
public static const ITEM_FOCUS_IN:String = itemFocusIn
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | null |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item editor instance for the item
that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the
item in the data provider. |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_FOCUS_IN |
public static const ITEM_FOCUS_OUT:String = itemFocusOut
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | null |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item editor instance for the item
that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the
item in the data provider. |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_FOCUS_OUT |
public static const ITEM_OPEN:String = itemOpen
Language Version : | ActionScript 3.0 |
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.
Property | Value |
---|
bubbles | false |
cancelable | false |
currentTarget | The 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 . |
item | The AdvancedDataGrid node that opened. |
itemRenderer | The ListItemRenderer for the item (node) that opened. |
localX | NaN |
multiColumnSort | false |
removeColumnFromSort | false |
rowIndex | -1 |
target | The 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. |
triggerEvent | If the item (node) opened in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_OPEN |
public static const ITEM_OPENING:String = itemOpening
Language Version : | ActionScript 3.0 |
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.
Property | Value |
---|
animate | Whether to animate the opening
or closing operation. |
bubbles | false |
cancelable | true |
currentTarget | The 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 . |
dispatchEvent | Whether to dispatch an
ITEM_OPEN or ITEM_CLOSE event
after the open or close animation is complete. true |
item | The AdvancedDataGrid node that opened. |
itemRenderer | The ListItemRenderer for the item (node) that opened. |
localX | NaN |
multiColumnSort | false |
removeColumnFromSort | false |
rowIndex | -1 |
opening | true if the item is opening, false
if it is closing. |
target | The 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. |
triggerEvent | If the item opened in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_OPENING |
public static const SORT:String = sort
Language Version : | ActionScript 3.0 |
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:
Property | Value |
---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The 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 . |
dataField | The 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.
|
removeColumnFromSort | false |
target | The 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. |
triggerEvent | If the node closed in response to a user action,
identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.SORT |
Mon Jul 9 2012, 07:18 PM -04:00