The GridEvent class extends the MouseEvent class to includes additional
grid specific information based on the event's location relative to a grid cell.
This information includes the following:
The row and column index of the cell.
The GridColumn object of the cell.
The data provider item that corresponds to the row of the cell.
The item renderer.
Grid events have a one-to-one correspondence with mouse events.
They are dispatched in response to mouse events that have "bubbled"
from some Grid descendant to the Grid itself.
One significant difference is that event listeners for grid events
are guaranteed to see an entire down-drag-up mouse gesture,
even if the drag and up parts of the gesture do not occur over the grid.
The gridMouseDrag event corresponds to a
mouse move event with the button held down.
GridEvents dispatched by the Grid class in response to mouse event are constructed with
the incoming mouse event's properties.
The grid event's x,y location, meaning the value of
its localX and localY properties,
is defined relative to the entire grid, not just the
part of the grid that has been scrolled into view.
Similarly, the event's row and column
indices might correspond to a cell that has not been scrolled into view.
Parameters
type:String — Distinguishes the mouse gesture that caused this event to be dispatched.
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.
localX:Number (default = NaN) — The event's x coordinate relative to grid.
localY:Number (default = NaN) — The event's y coordinate relative to grid.
relatedObject:InteractiveObject (default = null) — The index of the row where the event occurred, or -1.
ctrlKey:Boolean (default = false) — The index of the column where the event occurred, or -1.
altKey:Boolean (default = false) — The column where the event occurred, or null.
shiftKey:Boolean (default = false) — The data provider item at rowIndex.
buttonDown:Boolean (default = false) — The relatedObject property of the
MouseEvent that triggered this GridEvent.
delta:int (default = 0) — The visible item renderer where the event occurred, or null.
rowIndex:int (default = -1) — Whether the Control key is down.
columnIndex:int (default = -1) — Whether the Alt key is down.
column:GridColumn (default = null) — Whether the Shift key is down.
item:Object (default = null) — Whether the Control key is down.
The value of the type property for a gridClick GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_CLICK
See also
flash.display.InteractiveObject.click
GRID_DOUBLE_CLICK
Constant
public static const GRID_DOUBLE_CLICK:String = gridDoubleClick
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a gridDoubleClick GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_DOUBLE_CLICK
See also
flash.display.InteractiveObject.doubleClick
GRID_MOUSE_DOWN
Constant
public static const GRID_MOUSE_DOWN:String = gridMouseDown
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a gridMouseDown GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_MOUSE_DOWN
See also
flash.display.InteractiveObject.mouseDown
GRID_MOUSE_DRAG
Constant
public static const GRID_MOUSE_DRAG:String = gridMouseDrag
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a gridMouseDrag GridEvent.
This event is only dispatched when a listener has handled a mouseDown event,
and then only while the mouse moves with the button held down.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_MOUSE_DRAG
GRID_MOUSE_UP
Constant
public static const GRID_MOUSE_UP:String = gridMouseUp
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a gridMouseUp GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_MOUSE_UP
See also
flash.display.InteractiveObject.mouseUp
GRID_ROLL_OUT
Constant
public static const GRID_ROLL_OUT:String = gridRollOut
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a gridRollOut GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_ROLL_OUT
See also
flash.display.InteractiveObject.rollOut
GRID_ROLL_OVER
Constant
public static const GRID_ROLL_OVER:String = gridRollOver
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a gridRollOver GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.GRID_ROLL_OVER
See also
flash.display.InteractiveObject.rollOver
SEPARATOR_CLICK
Constant
public static const SEPARATOR_CLICK:String = separatorClick
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorClick GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.SEPARATOR_CLICK
SEPARATOR_DOUBLE_CLICK
Constant
public static const SEPARATOR_DOUBLE_CLICK:String = separatorDoubleClick
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorDoubleClick GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.SEPARATOR_DOUBLE_CLICK
SEPARATOR_MOUSE_DOWN
Constant
public static const SEPARATOR_MOUSE_DOWN:String = separatorMouseDown
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorMouseDown GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.SEPARATOR_MOUSE_DOWN
See also
flash.display.InteractiveObject.rollOut
SEPARATOR_MOUSE_DRAG
Constant
public static const SEPARATOR_MOUSE_DRAG:String = separatorMouseDrag
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorMouseDrag GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.SEPARATOR_MOUSE_DRAG
SEPARATOR_MOUSE_UP
Constant
public static const SEPARATOR_MOUSE_UP:String = separatorMouseUp
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorMouseUp GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.SEPARATOR_MOUSE_UP
See also
flash.display.InteractiveObject.rollOut
SEPARATOR_ROLL_OUT
Constant
public static const SEPARATOR_ROLL_OUT:String = separatorRollOut
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorRollOut GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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
GirdEvent.SEPARATOR_ROLL_OUT
SEPARATOR_ROLL_OVER
Constant
public static const SEPARATOR_ROLL_OVER:String = separatorRollOver
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10, AIR 2.5
The value of the type property for a separatorRollOver GridEvent.
The properties of the event object have the following values:
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.
column
The column where the event occurred,
or null if the event did not occur over a column.
columnIndex
The index of the column where
the event occurred, or -1 if the event did not occur over a grid column.
grid
The Grid associated with this event.
item
The data provider item for this row,
or null if the event did not occur over a grid row.
itemRenderer
The The item renderer that displayed
this cell, or null if the event did not occur over a visible cell.
rowIndex
The index of the row where the event occurred,
or -1 if the event did not occur over a grid row.
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.
flash.events.MouseEvent