| Package | mx.automation.events |
| Class | public class AdvancedDataGridItemSelectEvent |
| Inheritance | AdvancedDataGridItemSelectEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Learn more
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. | AdvancedDataGridItemSelectEvent | ||
 | 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 | |
| columnIndex : int
The data provider index of the item to be selected. | AdvancedDataGridItemSelectEvent | ||
| 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. | AdvancedDataGridItemSelectEvent | ||
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| dataField : String
The data field of the current column being selected. | AdvancedDataGridItemSelectEvent | ||
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| headerPart : String
The data field of the current column being selected
If HEADER_RELEASE event, which part of the header was clicked. | AdvancedDataGridItemSelectEvent | ||
| itemAutomationValue : String
The automationValue string of the item to be selected. | AdvancedDataGridItemSelectEvent | ||
| itemRenderer : IListItemRenderer
Item renderer object for the item being selected or deselected. | AdvancedDataGridItemSelectEvent | ||
| shiftKey : Boolean
Indicates whether the Shift key was pressed at the time of the event, true,
or not, false. | AdvancedDataGridItemSelectEvent | ||
| target : Object [read-only]
The event target. | Event | |
| triggerEvent : Event
Event that triggered the item selection event,
such as a keyboard or mouse event. | AdvancedDataGridItemSelectEvent | ||
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
AdvancedDataGridItemSelectEvent(type:String, columnIndex:int = -1, dataField:String = "", headerPart:String = "", bubbles:Boolean = false, cancelable:Boolean = false, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
Constructor. | AdvancedDataGridItemSelectEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| HEADER_RELEASE : String = "headerRelease" [static]
The AdvancedDataGridEvent.HEADER_RELEASE constant defines the value of the
type property of the event object for a
headerRelease event, which indicates that the
user pressed and released the mouse on a column header. | AdvancedDataGridItemSelectEvent | ||
Property Detail
altKey | property |
public var altKey:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether the Alt key was pressed at the time of the event, true,
or not, false.
The default value is false.
columnIndex | property |
public var columnIndex:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The data provider index of the item to be selected.
ctrlKey | property |
public var ctrlKey:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether the Ctrl key was pressed at the time of the event, true,
or not, false.
The default value is false.
dataField | property |
public var dataField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The data field of the current column being selected.
headerPart | property |
public var headerPart:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The data field of the current column being selected If HEADER_RELEASE event, which part of the header was clicked.
itemAutomationValue | property |
public var itemAutomationValue:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The automationValue string of the item to be selected. This is used when the item to be selected is not visible in the control.
itemRenderer | property |
public var itemRenderer:IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Event that triggered the item selection event, such as a keyboard or mouse event.
The default value is null.
Constructor Detail
AdvancedDataGridItemSelectEvent | () | Constructor |
public function AdvancedDataGridItemSelectEvent(type:String, columnIndex:int = -1, dataField:String = "", headerPart:String = "", bubbles:Boolean = false, cancelable:Boolean = false, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor. Normally called by the Flex control and not used in application code.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
columnIndex:int (default = -1) | |
dataField:String (default = " | |
headerPart:String (default = " | |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
itemRenderer:IListItemRenderer (default = null) | |
triggerEvent:Event (default = null) | |
ctrlKey:Boolean (default = false) | |
altKey:Boolean (default = false) | |
shiftKey:Boolean (default = false) |
Constant Detail
HEADER_RELEASE | Constant |
public static const HEADER_RELEASE:String = "headerRelease"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The AdvancedDataGridEvent.HEADER_RELEASE constant defines the value of the
type property of the event object for a
headerRelease event, which indicates that the
user pressed and released the mouse on a column header.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
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. |
dataField | The name of the field or property in the data associated with the column. |
itemRenderer | The header renderer that is being released. |
localX | NaN |
reason | null |
rowIndex | null |
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 | AdvancedDataGridEvent.HEADER_RELEASE |
Mon Apr 10 2017, 12:28 PM -07:00