GridSelectionEvent

Package	spark.events
Class	public class GridSelectionEvent
Inheritance	GridSelectionEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

The GridSelectionEvent class represents events that are dispatched when the selection changes in a Spark DataGrid control as the result of user interaction.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

spark.events.GridSelectionEventKind
spark.components.DataGrid
spark.components.Grid

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		kind : String Indicates the kind of event that occurred.	GridSelectionEvent
		selectionChange : CellRegion The upcoming or just-completed selection changes triggered by some user gesture.	GridSelectionEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		GridSelectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, selectionChange:CellRegion = null) Constructor.	GridSelectionEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		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 Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		SELECTION_CHANGE : String = "selectionChange" [static] The GridSelectionEvent.SELECTION_CHANGE constant defines the value of the type property of the event object for a selectionChange event, which indicates that the current selection has just been changed.	GridSelectionEvent
		SELECTION_CHANGING : String = "selectionChanging" [static] The GridSelectionEvent.SELECTION_CHANGING constant defines the value of the type property of the event object for a selectionChanging event, which indicates that the current selection is about to change.	GridSelectionEvent

Property Detail

kind

property

public var kind:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

Indicates the kind of event that occurred. The property value can be one of the values in the GridSelectionEventKind class, or null, which indicates that the kind is unknown.

Related API Elements

spark.events.GridSelectionEventKind

selectionChange

property

public var selectionChange:CellRegion

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

The upcoming or just-completed selection changes triggered by some user gesture. If this change is adding to the current selection, it will not represent the complete selection. Use the DataGrid selection methods to determine the selection.

Related API Elements

spark.components.DataGrid

Constructor Detail

GridSelectionEvent

()

Constructor

public function GridSelectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, selectionChange:CellRegion = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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.

	`kind:String` (default = `null`) — The kind of changing event. The valid values are defined in `GridSelectionEventKind` class as constants. This value determines which properties in the event are used.

	`selectionChange:CellRegion` (default = `null`) — The proposed or accepted change to the current selection. Use the Spark DataGrid selection methods to determine the current selection.

Related API Elements

spark.components.DataGrid.selectedCells
spark.components.DataGrid.selectedIndices

Constant Detail

SELECTION_CHANGE

Constant

public static const SELECTION_CHANGE:String = "selectionChange"

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

The GridSelectionEvent.SELECTION_CHANGE constant defines the value of the type property of the event object for a selectionChange event, which indicates that the current selection has just been changed.

This event is dispatched when the user interacts with the control. When you sort the data provider's collection programmatically, the component does not dispatch the selectionChange event.

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`.
kind	The kind of changing event. The valid values are defined in GridSelectionEventKind class as constants. This value determines which properties in the event are used.
`selectionChange`	The just completed selection change that was triggered by a user gesture. Use the DataGrid selection methods to determine the current selection.
`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`	GridSelectionEvent.SELECTION_CHANGE

Related API Elements

spark.components.DataGrid.selectedCells
spark.components.DataGrid.selectedIndices

SELECTION_CHANGING

Constant

public static const SELECTION_CHANGING:String = "selectionChanging"

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

The GridSelectionEvent.SELECTION_CHANGING constant defines the value of the type property of the event object for a selectionChanging event, which indicates that the current selection is about to change. Call preventDefault() on this event to prevent the selection from changing.

This event is dispatched when the user interacts with the control. When you sort the data provider's collection programmatically, the component does not dispatch the selectionChanging event.

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`.
kind	The kind of changing event. The valid values are defined in GridSelectionEventKind class as constants. This value determines which properties in the event are used.
`selectionChange`	The upcoming selection change that is triggered by a user gesture.
`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`	GridSelectionEvent.SELECTION_CHANGING

Related API Elements

spark.components.DataGrid.selectedCells
spark.components.DataGrid.selectedIndices

Legal Notices | Online Privacy Policy

GridSelectionEvent - AS3 Flex

Classes x

kind

selectionChange

GridSelectionEvent

SELECTION_CHANGE

SELECTION_CHANGING