Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
TreeEvent

Package | mx.events
Class | public class TreeEvent
Inheritance | TreeEvent 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

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | TreeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, item:Object = null, itemRenderer:IListItemRenderer = null, triggerEvent:Event = null) Constructor. | TreeEvent

Public Constants

| Constant | Defined 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

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.

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 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.

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
--- | ---
`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

Sun Mar 5 2017, 03:42 PM +11:00