Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.automation.events 
ListItemSelectEvent 
Packagemx.automation.events
Classpublic class ListItemSelectEvent
InheritanceListItemSelectEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The ListItemSelectEvent class represents event objects that are dispatched when an item in a list-based control such as a Menu, DataGrid, or Tree control is selected or deselected.

See also



Public Properties
 PropertyDefined By
  altKey : Boolean
Indicates whether the Alt key was pressed at the time of the event, true, or not, false.
ListItemSelectEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : 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.
ListItemSelectEvent
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  itemAutomationValue : String
The automationValue string of the item to be selected.
ListItemSelectEvent
  itemIndex : uint
The data provider index of the item to be selected.
ListItemSelectEvent
  itemRenderer : IListItemRenderer
Item renderer object for the item being selected or deselected.
ListItemSelectEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  shiftKey : Boolean
Indicates whether the Shift key was pressed at the time of the event, true, or not, false.
ListItemSelectEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  triggerEvent : Event
Event that triggered the item selection event, such as a keyboard or mouse event.
ListItemSelectEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ListItemSelectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
Constructor.
ListItemSelectEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant efines the value of the type property of a clear event object.
Event
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
  DESELECT : String = "deselect"
[static] The ListItemSelectEvent.DESELECT constant defines the value of the type property of the event object for an event that is dispatched when a previously selected item is deselected.
ListItemSelectEvent
 InheritedDISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
  MULTI_SELECT : String = "multiSelect"
[static] The ListItemSelectEvent.MULTI_SELECT constant defines the value of the type property of the event object for an event that is dispatched when an item is selected as part of an action that selects multiple items.
ListItemSelectEvent
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
  SELECT : String = "select"
[static] The ListItemSelectEvent.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.
ListItemSelectEvent
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
  SELECT_INDEX : String = "selectIndex"
[static] The ListItemSelectEvent.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.
ListItemSelectEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
Event
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.

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.

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.

itemIndex

property 
public var itemIndex:uint

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.

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

ListItemSelectEvent

()Constructor
public function ListItemSelectEvent(type: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.

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:IListItemRenderer (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

DESELECT

Constant
public static const DESELECT:String = "deselect"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The ListItemSelectEvent.DESELECT constant defines the value of the type property of the event object for an event that is dispatched when a previously selected item is deselected.

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.

PropertyValue
altKeyBoolean value indicating whether the Alt key was pressed at the time of the event.
bubblesfalse
cancelablefalse
ctrlKeyBoolean value indicating whether the Ctrl key was pressed at the time of the event.
currentTargetThe 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.
itemRendererThe item renderer object for the item.
shiftKeyBoolean value indicating whether the Shift key was pressed at the time of the event.
targetThe 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.
triggerEventThe event, such as a mouse or keyboard event, that triggered the action.
typeListItemSelectEvent.DESELECT

MULTI_SELECT

Constant 
public static const MULTI_SELECT:String = "multiSelect"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The ListItemSelectEvent.MULTI_SELECT constant defines the value of the type property of the event object for an event that is dispatched when an item is selected as part of an action that selects multiple items.

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.

PropertyValue
altKeyBoolean value indicating whether the Alt key was pressed at the time of the event.
bubblesfalse
cancelablefalse
ctrlKeyBoolean value indicating whether the Ctrl key was pressed at the time of the event.
currentTargetThe 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.
itemRendererThe item renderer object for the item.
shiftKeyBoolean value indicating whether the Shift key was pressed at the time of the event.
targetThe 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.
triggerEventThe event, such as a mouse or keyboard event, that triggered the action.
typeListItemSelectEvent.MULTI_SELECT

SELECT

Constant 
public static const SELECT:String = "select"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The ListItemSelectEvent.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.

PropertyValue
altKeyBoolean value indicating whether the Alt key was pressed at the time of the event.
bubblesfalse
cancelablefalse
ctrlKeyBoolean value indicating whether the Ctrl key was pressed at the time of the event.
currentTargetThe 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.
itemRendererThe item renderer object for the item.
shiftKeyBoolean value indicating whether the Shift key was pressed at the time of the event.
targetThe 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.
triggerEventThe event, such as a mouse or keyboard event, that triggered the action.
typeListItemSelectEvent.SELECT

SELECT_INDEX

Constant 
public static const SELECT_INDEX:String = "selectIndex"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The ListItemSelectEvent.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.

PropertyValue
altKeyBoolean value indicating whether the Alt key was pressed at the time of the event.
bubblesfalse
cancelablefalse
ctrlKeyBoolean value indicating whether the Ctrl key was pressed at the time of the event.
currentTargetThe 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.
itemIndexThe data provider index of the item to be selected.
shiftKeyBoolean value indicating whether the Shift key was pressed at the time of the event.
targetThe 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.
triggerEventThe event, such as a mouse or keyboard event, that triggered the action.
typeListItemSelectEvent.SELECT_INDEX