Packagepotomac.ui
Classpublic class SelectionEvent
InheritanceSelectionEvent Inheritance flash.events.Event

SelectionEvents are dispatched in response to selection changes in parts. Selection tracking is used when parts change their content based on the selection in other parts.



Public Properties
 PropertyDefined By
  partReference : PartReference
[read-only] The reference to the part whose selection changed.
SelectionEvent
  selection : Array
[read-only] The new selection.
SelectionEvent
Public Methods
 MethodDefined By
  
SelectionEvent(type:String, partRef:PartReference, selection:Array)
Callers should not create SelectionEvent instances.
SelectionEvent
  
clone():Event
[override]
SelectionEvent
Public Constants
 ConstantDefined By
  SELECTION_CHANGED : String = partSelectionChanged
[static] The SelectionEvent.SELECTION_CHANGED constant defines the value of the type property of the event object for a partSelectionChanged event.
SelectionEvent
Property Detail
partReferenceproperty
partReference:PartReference  [read-only]

The reference to the part whose selection changed.


Implementation
    public function get partReference():PartReference
selectionproperty 
selection:Array  [read-only]

The new selection. Potomac ensures the selection is never null. If the selection is empty, or if the part set its selection to null, Potomac will set the selection to an empty array.


Implementation
    public function get selection():Array
Constructor Detail
SelectionEvent()Constructor
public function SelectionEvent(type:String, partRef:PartReference, selection:Array)

Callers should not create SelectionEvent instances.

Parameters
type:String
 
partRef:PartReference
 
selection:Array
Method Detail
clone()method
override public function clone():Event

Returns
Event
Constant Detail
SELECTION_CHANGEDConstant
public static const SELECTION_CHANGED:String = partSelectionChanged

The SelectionEvent.SELECTION_CHANGED constant defines the value of the type property of the event object for a partSelectionChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
partReferenceThe reference of the part whose changed.
selectionThe part's new selection.