spark.automation.events

# SparkDataGridItemSelectEvent - AS3 Flex

Package | spark.automation.events
Class | public class SparkDataGridItemSelectEvent
Inheritance | SparkDataGridItemSelectEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

The SparkDataGridItemSelectEvent class represents event objects that are dispatched when an item in a datagrid control is selected or deselected.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | altKey : Boolean Indicates whether the Alt key was pressed at the time of the event, true, or not, false. | SparkDataGridItemSelectEvent
|  | 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
|  | ctrlKey : Boolean Indicates whether the Ctrl key was pressed at the time of the event, true, or not, false. | SparkDataGridItemSelectEvent
|  | 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
|  | itemAutomationValue : String The automationValue string of the item to be selected. | SparkDataGridItemSelectEvent
|  | itemIndex : uint The data provider index of the item to be selected. | SparkDataGridItemSelectEvent
|  | itemRenderer : IGridItemRenderer Item renderer object for the item being selected or deselected. | SparkDataGridItemSelectEvent
|  | shiftKey : Boolean Indicates whether the Shift key was pressed at the time of the event, true, or not, false. | SparkDataGridItemSelectEvent
|  | target : Object [read-only] The event target. | Event
|  | triggerEvent : Event Event that triggered the item selection event, such as a keyboard or mouse event. | SparkDataGridItemSelectEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SparkDataGridItemSelectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, itemRenderer:IGridItemRenderer = null, triggerEvent:Event = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false) Constructor. | SparkDataGridItemSelectEvent
|  | 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
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | SELECT : String = "select" [static] The SparkDataGridItemSelectEvent.SELECT constant defines the value of the type property of the event object for an event that is dispatched when a single item is selected. | SparkDataGridItemSelectEvent
|  | SELECT_INDEX : String = "selectIndex" [static] The SparkDataGridItemSelectEvent.SELECT_INDEX constant defines the value of the type property of the event object for an event that is dispatched when an item's index is selected. | SparkDataGridItemSelectEvent

Property Detail

### altKey

property

`public var altKey:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

Indicates whether the Alt key was pressed at the time of the event, `true`, or not, `false`.

The default value is `false.`

### ctrlKey

property

`public var ctrlKey:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

Indicates whether the Ctrl key was pressed at the time of the event, `true`, or not, `false`.

The default value is `false.`

### itemAutomationValue

property

`public var itemAutomationValue:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

The automationValue string of the item to be selected. This is used when the item to be selected is not visible in the control.

### itemIndex

property

`public var itemIndex:uint`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

The data provider index of the item to be selected.

### itemRenderer

property

`public var itemRenderer:IGridItemRenderer`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

Item renderer object for the item being selected or deselected. You can access the cell data using this property.

The default value is `null.`

### shiftKey

property

`public var shiftKey:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

Indicates whether the Shift key was pressed at the time of the event, `true`, or not, `false`.

The default value is `false.`

### triggerEvent

property

`public var triggerEvent:Event`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

Event that triggered the item selection event, such as a keyboard or mouse event.

The default value is `null.`

Constructor Detail

### SparkDataGridItemSelectEvent

()
Constructor

`public function SparkDataGridItemSelectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, itemRenderer:IGridItemRenderer = null, triggerEvent:Event = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

Constructor. Normally called by the Flex control and not used in application code.

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.
| `itemRenderer:IGridItemRenderer` (default = `null`)`` — The item renderer object for the item.
| `triggerEvent:Event` (default = `null`)`` — The event, such as a mouse or keyboard event, that triggered the selection action.
| `ctrlKey:Boolean` (default = `false`)`` — Whether the Alt key was pressed at the time of the event.
| `altKey:Boolean` (default = `false`)`` — Whether the Ctrl key was pressed at the time of the event.
| `shiftKey:Boolean` (default = `false`)`` — Whether the Shift key was pressed at the time of the event.

Constant Detail

### SELECT

Constant

`public static const SELECT:String = "select"`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

The `SparkDataGridItemSelectEvent.SELECT` constant defines the value of the `type` property of the event object for an event that is dispatched when a single item is selected.

The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

Property | Value
--- | ---
`altKey` | Boolean value indicating whether the Alt key was pressed at the time of the event.
`bubbles` | false
`cancelable` | false
`ctrlKey` | Boolean value indicating whether the Ctrl key was pressed at the time of the event.
`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`.
`itemRenderer` | The item renderer object for the item.
`shiftKey` | Boolean value indicating whether the Shift key was pressed at the time of the event.
`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` | The event, such as a mouse or keyboard event, that triggered the action.
`type` | SparkListItemSelectEvent.SELECT

### SELECT_INDEX

Constant

`public static const SELECT_INDEX:String = "selectIndex"`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 9, AIR 1.5

The `SparkDataGridItemSelectEvent.SELECT_INDEX` constant defines the value of the `type` property of the event object for an event that is dispatched when an item's index is selected.

The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

Property | Value
--- | ---
`altKey` | Boolean value indicating whether the Alt key was pressed at the time of the event.
`bubbles` | false
`cancelable` | false
`ctrlKey` | Boolean value indicating whether the Ctrl key was pressed at the time of the event.
`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`.
`itemIndex` | The data provider index of the item to be selected.
`shiftKey` | Boolean value indicating whether the Shift key was pressed at the time of the event.
`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` | The event, such as a mouse or keyboard event, that triggered the action.
`type` | SparkListItemSelectEvent.SELECT_INDEX

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00