GridEvent

(Preview)

Package	spark.events
Class	public class GridEvent
Inheritance	GridEvent MouseEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

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.

Related API Elements

spark.components.DataGrid
spark.components.Grid
spark.components.gridClasses.GridSelectionMode

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		altKey : Boolean Indicates whether the Alt key is active (true) or inactive (false).	MouseEvent
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		buttonDown : Boolean Indicates whether the primary mouse button is pressed (true) or not (false).	MouseEvent
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		clickCount : int [read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.	MouseEvent
		column : GridColumn The column where the event occurred, or null if the event did not occur over a column.	GridEvent
		columnIndex : int The index of the column where the event occurred, or -1 if the event did not occur over a grid column.	GridEvent
		commandKey : Boolean Indicates whether the command key is activated (Mac only.) The value of property commandKey will have the same value as property ctrlKey on the Mac.	MouseEvent
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		controlKey : Boolean Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.	MouseEvent
		ctrlKey : Boolean On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).	MouseEvent
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		delta : int Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.	MouseEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		grid : Grid [read-only] The Grid associated with this event.	GridEvent
		isRelatedObjectInaccessible : Boolean If true, the relatedObject property is set to null for reasons related to security sandboxes.	MouseEvent
		item : Object The data provider item for this row, or null if the event did not occur over a grid row.	GridEvent
		itemRenderer : IGridItemRenderer The item renderer that displayed this cell, or null if the event did not occur over a visible cell.	GridEvent
		localX : Number When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		movementX : Number When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event.	MouseEvent
		movementY : Number When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event.	MouseEvent
		relatedObject : InteractiveObject A reference to a display list object that is related to the event.	MouseEvent
		rowIndex : int The index of the row where the event occurred, or -1 if the event did not occur over a grid row.	GridEvent
		shiftKey : Boolean Indicates whether the Shift key is active (true) or inactive (false).	MouseEvent
		stageX : Number [read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		stageY : Number [read-only] The vertical coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		GridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, rowIndex:int = -1, columnIndex:int = -1, column:GridColumn = null, item:Object = null, itemRenderer:IGridItemRenderer = null) GridEvents dispatched by the Grid class in response to mouse event are constructed with the incoming mouse event's properties.	GridEvent
		clone():Event [override] Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.	MouseEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the MouseEvent object.	MouseEvent
		updateAfterEvent():void Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.	MouseEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		GRID_CLICK : String = "gridClick" [static] The value of the type property for a gridClick GridEvent.	GridEvent
		GRID_DOUBLE_CLICK : String = "gridDoubleClick" [static] The value of the type property for a gridDoubleClick GridEvent.	GridEvent
		GRID_MOUSE_DOWN : String = "gridMouseDown" [static] The value of the type property for a gridMouseDown GridEvent.	GridEvent
		GRID_MOUSE_DRAG : String = "gridMouseDrag" [static] The value of the type property for a gridMouseDrag GridEvent.	GridEvent
		GRID_MOUSE_UP : String = "gridMouseUp" [static] The value of the type property for a gridMouseUp GridEvent.	GridEvent
		GRID_ROLL_OUT : String = "gridRollOut" [static] The value of the type property for a gridRollOut GridEvent.	GridEvent
		GRID_ROLL_OVER : String = "gridRollOver" [static] The value of the type property for a gridRollOver GridEvent.	GridEvent
		SEPARATOR_CLICK : String = "separatorClick" [static] The value of the type property for a separatorClick GridEvent.	GridEvent
		SEPARATOR_DOUBLE_CLICK : String = "separatorDoubleClick" [static] The value of the type property for a separatorDoubleClick GridEvent.	GridEvent
		SEPARATOR_MOUSE_DOWN : String = "separatorMouseDown" [static] The value of the type property for a separatorMouseDown GridEvent.	GridEvent
		SEPARATOR_MOUSE_DRAG : String = "separatorMouseDrag" [static] The value of the type property for a separatorMouseDrag GridEvent.	GridEvent
		SEPARATOR_MOUSE_UP : String = "separatorMouseUp" [static] The value of the type property for a separatorMouseUp GridEvent.	GridEvent
		SEPARATOR_ROLL_OUT : String = "separatorRollOut" [static] The value of the type property for a separatorRollOut GridEvent.	GridEvent
		SEPARATOR_ROLL_OVER : String = "separatorRollOver" [static] The value of the type property for a separatorRollOver GridEvent.	GridEvent

Property Detail

Constructor Detail

Constant Detail

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

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

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

	`itemRenderer:IGridItemRenderer` (default = `null`) — Not used.

GridEvent - AS3 Flex

Packagesx

Language Elements

Appendixes

Package spark.events

column

columnIndex

grid

item

itemRenderer

rowIndex

GRID_CLICK

GRID_DOUBLE_CLICK

GRID_MOUSE_DOWN

GRID_MOUSE_DRAG

GRID_MOUSE_UP

GRID_ROLL_OUT

GRID_ROLL_OVER

SEPARATOR_CLICK

SEPARATOR_DOUBLE_CLICK

SEPARATOR_MOUSE_DOWN

SEPARATOR_MOUSE_DRAG

SEPARATOR_MOUSE_UP

SEPARATOR_ROLL_OUT

SEPARATOR_ROLL_OVER