ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.automation.events 

ChartSelectionChangeEvent  - AS3 Flex

Packagemx.automation.events
Classpublic class ChartSelectionChangeEvent
InheritanceChartSelectionChangeEvent 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.

Learn more



Public Properties
 PropertyDefined By
  altKey : Boolean
Indicates whether the Alt key was pressed at the time of the event, true, or not, false.
ChartSelectionChangeEvent
 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.
ChartSelectionChangeEvent
 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.
ChartSelectionChangeEvent
  selectionInfo : Array
ChartSelectionChangeEvent
  shiftKey : Boolean
Indicates whether the Shift key was pressed at the time of the event, true, or not, false.
ChartSelectionChangeEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  triggerEvent : Event
Event that triggered the item selection event, such as a keyboard or mouse event.
ChartSelectionChangeEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ChartSelectionChangeEvent(type:String, selectionInfo:Array = null, bubbles:Boolean = false, cancelable:Boolean = false, triggerEvent:Event = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
Constructor.
ChartSelectionChangeEvent
 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
  CHANGE : String = "change"
[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.
ChartSelectionChangeEvent
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.

selectionInfo

property 
public var selectionInfo:Array

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

ChartSelectionChangeEvent

()Constructor
public function ChartSelectionChangeEvent(type:String, selectionInfo:Array = null, bubbles:Boolean = false, cancelable:Boolean = false, 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.
 
selectionInfo:Array (default = null) — Specifies whether the event can bubble up the display list hierarchy.
 
bubbles:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
cancelable:Boolean (default = false) — 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

CHANGE

Constant
public static const CHANGE:String = "change"

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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the AdvancedDataGrid object's columns array.
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.
dataFieldThe name of the field or property in the data associated with the column.
itemRendererThe header renderer that is being released.
localXNaN
reasonnull
rowIndexnull
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.
typeAdvancedDataGridEvent.HEADER_RELEASE