Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
GridSelectionEvent

Package | spark.events
Class | public class GridSelectionEvent
Inheritance | GridSelectionEvent flash.events.Event

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.

See also

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

Public Properties

| Property | Defined By
--- | --- | ---
|  | 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

Public Methods

| Method | Defined By
--- | --- | ---
|  | GridSelectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, selectionChange:CellRegion = null) Constructor. | GridSelectionEvent

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.

See also

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.

See also

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.

See also

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

See also

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

See also

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

Sun Mar 5 2017, 03:42 PM +11:00