mx.events.TreeEvent - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.events
Class	public class TreeEvent
Inheritance	TreeEvent Event Object

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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		animate : Boolean Whether to animate an opening or closing operation; used for ITEM_OPENING type events only.	TreeEvent
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		dispatchEvent : Boolean Whether to dispatch an event (ITEM_OPEN or ITEM_CLOSE) after the open or close animation is complete.	TreeEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object [read-only] The event target.	Event
		triggerEvent : Event The low level MouseEvent or KeyboardEvent that triggered this event or null if this event was triggered programatically.	TreeEvent
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		TreeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, item:Object = null, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null) Constructor.	TreeEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		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
		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
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		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
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		SCROLL : 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 Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.	Event
		STANDARD_INPUT_CLOSE : String = "standardInputClose" [static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.	Event
		STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		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

animate

property

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.

dispatchEvent

property

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.

item

property

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.

itemRenderer

property

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.

opening

property

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.

triggerEvent

property

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_CLOSE

Constant

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.

Property	Value
`itemRenderer`	The ListItemRenderer for the node that closed
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`triggerEvent`	If the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
`item`	the Tree item (node) that closed
`target`	The 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.
`type`	TreeEvent.ITEM_CLOSE

ITEM_OPEN

Constant

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.

Property	Value
`itemRenderer`	The ListItemRenderer for the item (node) that opened
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`triggerEvent`	If the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action.
`item`	the Tree node that opened.
`target`	The 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.
`type`	TreeEvent.ITEM_OPEN

ITEM_OPENING

Constant

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.

Property	Value
`animate`	Whether to animate the opening or closing operation.
`bubbles`	false
`cancelable`	true
`currentTarget`	The 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`.
`dispatchEvent`	Whether to dispatch an `ITEM_OPEN` or `ITEM_CLOSE` event after the open or close animation is complete. true
`itemRenderer`	The ListItemRenderer for the item (node) that opened
`item`	the Tree node that opened.
`opening`	true if the item is opening, false if it is closing.
`target`	The 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.
`triggerEvent`	If the item opened in response to a user action, identifies it as a keyboard action or a mouse action.
`type`	TreeEvent.ITEM_OPENING