Packageimpression.events
Classpublic class TreeViewEvent
InheritanceTreeViewEvent Inheritance flash.events.Event
Subclasses LessonMapViewerEvent

The TreeView object dispatches a TreeViewEvent object when tree view related actions occur.



Public Properties
 PropertyDefined By
  node : TreeNode
[read-only] The node associated with the event.
TreeViewEvent
  reason : String
[read-only] Indicates why the event occurred.
TreeViewEvent
Public Methods
 MethodDefined By
  
TreeViewEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, reason:String = null, node:TreeNode = null)
Creates a new instance of a TreeViewEvent object.
TreeViewEvent
  
clone():Event
[override] Duplicates an instance of the event object.
TreeViewEvent
  
toString():String
[override] Returns a string containing all the properties of the TreeViewEvent object.
TreeViewEvent
Public Constants
 ConstantDefined By
  COLLAPSE : String = treeviewCollapse
[static] The TreeViewEvent.COLLAPSE constant defines the value of the type property of a TreeView collapse event object.
TreeViewEvent
  EXPAND : String = treeviewExpand
[static] The TreeViewEvent.EXPAND constant defines the value of the type property of an TreeView expand event object.
TreeViewEvent
  LOAD_COMPLETE : String = treeviewLoadComplete
[static] The TreeViewEvent.LOAD_COMPLETE constant defines the value of the type property of a TreeView event object.
TreeViewEvent
  SELECT : String = treeviewSelect
[static] The TreeViewEvent.SELECT constant defines the value of the type property of a TreeView select event object.
TreeViewEvent
Property Detail
nodeproperty
node:TreeNode  [read-only]

The node associated with the event.


Implementation
    public function get node():TreeNode
reasonproperty 
reason:String  [read-only]

Indicates why the event occurred. When dispatched by the LessonMapViewer, this value will contain one of the TreeViewEventReasons constant values.


Implementation
    public function get reason():String

See also

Constructor Detail
TreeViewEvent()Constructor
public function TreeViewEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, reason:String = null, node:TreeNode = null)

Creates a new instance of a TreeViewEvent object.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inheritied bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
reason:String (default = null) — The reason the event was raised. Event listeners can access this information through the reason property.
 
node:TreeNode (default = null) — The node associated with the event. Event listeners can access this information through the node property.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of the event object.

Returns a new TreeViewEvent object that is a copy of the original instance of the TreeViewEvent object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event--that is, when you call dispatchEvent(event) from a handler that is handling event.

Returns
Event — A new TreeViewEvent object that is identical to the original.
toString()method 
override public function toString():String

Returns a string containing all the properties of the TreeViewEvent object. The string is in the following format:

[TreeViewEvent type=value bubbles=value cancelable=value eventPhase=value reason=value node=value]

Returns
String — A string containing all the properties of the TreeViewEvent object.
Constant Detail
COLLAPSEConstant
public static const COLLAPSE:String = treeviewCollapse

The TreeViewEvent.COLLAPSE constant defines the value of the type property of a TreeView collapse event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
reasonIndicates why the event occurred.
nodeThe node associated with the event.

EXPANDConstant 
public static const EXPAND:String = treeviewExpand

The TreeViewEvent.EXPAND constant defines the value of the type property of an TreeView expand event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
reasonIndicates why the event occurred.
nodeThe node associated with the event.

LOAD_COMPLETEConstant 
public static const LOAD_COMPLETE:String = treeviewLoadComplete

The TreeViewEvent.LOAD_COMPLETE constant defines the value of the type property of a TreeView event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
reasonIndicates why the event occurred.
nodeThe node associated with the event.

SELECTConstant 
public static const SELECT:String = treeviewSelect

The TreeViewEvent.SELECT constant defines the value of the type property of a TreeView select event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
reasonIndicates why the event occurred.
nodeThe node associated with the event.