Packagemx.events
Classpublic class TreeEvent
InheritanceTreeEvent Inheritance flash.events.Event

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

The TreeEvent class represents the event object passed to the event listener for events that are associated with activities in tree, such as when a tree branch opens or closes.

See also

mx.controls.Tree


Public Properties
 PropertyDefined By
  animate : Boolean
Whether to animate an opening or closing operation; used for ITEM_OPENING type events only.
TreeEvent
  dispatchEvent : Boolean
Whether to dispatch an event (ITEM_OPEN or ITEM_CLOSE) after the open or close animation is complete.
TreeEvent
  item : Object
Storage for the item property.
TreeEvent
  itemRenderer : IListItemRenderer
The ListItemRenderer for the node that closed or opened.
TreeEvent
  opening : Boolean
Used for an ITEM_OPENING type events only.
TreeEvent
  triggerEvent : Event
The low level MouseEvent or KeyboardEvent that triggered this event or null if this event was triggered programatically.
TreeEvent
Public Methods
 MethodDefined By
  
TreeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, item:Object = null, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null)
Constructor.
TreeEvent
Public Constants
 ConstantDefined By
  ITEM_CLOSE : String = itemClose
[static] The TreeEvent.ITEM_CLOSE event type constant indicates that a tree branch closed or collapsed.
TreeEvent
  ITEM_OPEN : String = itemOpen
[static] The TreeEvent.ITEM_OPEN event type constant indicates that a tree branch opened or expanded.
TreeEvent
  ITEM_OPENING : String = itemOpening
[static] The TreeEvent.ITEM_OPENING event type constant is dispatched immediately before a tree opens or closes.
TreeEvent
Property Detail
animateproperty
public var animate:Boolean

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

Whether to animate an opening or closing operation; used for ITEM_OPENING type events only.

dispatchEventproperty 
public var dispatchEvent:Boolean

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

Whether to dispatch an event (ITEM_OPEN or ITEM_CLOSE) after the open or close animation is complete. Used for ITEM_OPENING type events only.

itemproperty 
public var item:Object

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

Storage for the item property. If you populate the Tree from XML data, access the properties for the node as event.item.@attribute_name.

itemRendererproperty 
public var itemRenderer:IListItemRenderer

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

The ListItemRenderer for the node that closed or opened.

openingproperty 
public var opening:Boolean

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

Used for an ITEM_OPENING type events only. Indicates whether the item is opening true, or closing false.

triggerEventproperty 
public var triggerEvent:Event

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

The low level MouseEvent or KeyboardEvent that triggered this event or null if this event was triggered programatically.

Constructor Detail
TreeEvent()Constructor
public function TreeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, item:Object = null, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null)

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

Constructor. Normally called by the Flex Tree control; 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.
 
item:Object (default = null) — The Tree node (item) to which this event applies.
 
itemRenderer:IListItemRenderer (default = null) — The item renderer object for the cell.
 
triggerEvent:Event (default = null) — If the node opened or closed in response to a user action, indicates the type of input action.
Constant Detail
ITEM_CLOSEConstant
public static const ITEM_CLOSE:String = itemClose

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

The TreeEvent.ITEM_CLOSE event type constant indicates that a tree branch closed or collapsed.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
itemRendererThe ListItemRenderer for the node that closed
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.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
itemthe Tree item (node) that closed
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.
typeTreeEvent.ITEM_CLOSE

ITEM_OPENConstant 
public static const ITEM_OPEN:String = itemOpen

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

The TreeEvent.ITEM_OPEN event type constant indicates that a tree branch opened or expanded.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
itemRendererThe ListItemRenderer for the item (node) that opened
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.
triggerEventIf the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action.
itemthe Tree node that opened.
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.
typeTreeEvent.ITEM_OPEN

ITEM_OPENINGConstant 
public static const ITEM_OPENING:String = itemOpening

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

The TreeEvent.ITEM_OPENING event type constant is dispatched immediately before a tree opens or closes.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
animateWhether to animate the opening or closing operation.
bubblesfalse
cancelabletrue
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.
dispatchEventWhether to dispatch an ITEM_OPEN or ITEM_CLOSE event after the open or close animation is complete. true
itemRendererThe ListItemRenderer for the item (node) that opened
itemthe Tree node that opened.
openingtrue if the item is opening, false if it is closing.
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.
triggerEventIf the item opened in response to a user action, identifies it as a keyboard action or a mouse action.
typeTreeEvent.ITEM_OPENING