blob: 174a8264b2695ebb5def5bf7baf048206c792332 [file] [log] [blame]
{ "type": "class",
"qname": "mx.events.TreeEvent",
"baseClassname": "org.apache.royale.events.Event"
,
"description": "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.",
"tags": [
{ "tagName": "see",
"values": ["mx.controls.Tree"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ],
"members": [
{ "type": "field",
"qname": "ITEM_CLOSE",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "The TreeEvent.ITEM_CLOSE event type constant indicates that a tree branch closed or collapsed. <p>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.</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>itemRenderer</code></td> <td>The ListItemRenderer for the node that closed</td></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>false</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myButton.addEventListener()</code> to register an event listener, myButton is the value of the <code>currentTarget</code>. </td></tr> <tr><td><code>triggerEvent</code></td> <td>If the node closed in response to a user action, identifies it as a keyboard action or a mouse action.</td></tr> <tr><td><code>item</code></td><td>the Tree item (node) that closed</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> <tr><td><code>type</code></td><td>TreeEvent.ITEM_CLOSE</td></tr> </table>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["itemClose"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "ITEM_OPEN",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "The TreeEvent.ITEM_OPEN event type constant indicates that a tree branch opened or expanded. <p>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.</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>itemRenderer</code></td> <td>The ListItemRenderer for the item (node) that opened</td></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>false</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myButton.addEventListener()</code> to register an event listener, myButton is the value of the <code>currentTarget</code>. </td></tr> <tr><td><code>triggerEvent</code></td> <td>If the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action.</td></tr> <tr><td><code>item</code></td><td>the Tree node that opened.</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> <tr><td><code>type</code></td><td>TreeEvent.ITEM_OPEN</td></tr> </table>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["itemOpen"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "ITEM_OPENING",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "The TreeEvent.ITEM_OPENING event type constant is dispatched immediately before a tree opens or closes. <p>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.</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>animate</code></td><td>Whether to animate the opening or closing operation.</td></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>true</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myButton.addEventListener()</code> to register an event listener, myButton is the value of the <code>currentTarget</code>.</td></tr> <tr><td><code>dispatchEvent</code></td><td>Whether to dispatch an <code>ITEM_OPEN</code> or <code>ITEM_CLOSE</code> event after the open or close animation is complete. true</td></tr> <tr><td><code>itemRenderer</code></td> <td>The ListItemRenderer for the item (node) that opened</td></tr> <tr><td><code>item</code></td><td>the Tree node that opened.</td></tr> <tr><td><code>opening</code></td><td>true if the item is opening, false if it is closing.</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> <tr><td><code>triggerEvent</code></td> <td>If the item opened in response to a user action, identifies it as a keyboard action or a mouse action.</td></tr> <tr><td><code>type</code></td><td>TreeEvent.ITEM_OPENING</td></tr> </table>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["itemOpening"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "mx.events.TreeEvent",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor. Normally called by the Flex Tree control; not used in application code. up the display list hierarchy. can be prevented. user action, indicates the type of input action.",
"tags": [
{ "tagName": "param",
"values": ["type The event type; indicates the action that caused the event.", "bubbles Specifies whether the event can bubble", "cancelable Specifies whether the behavior associated with the event", "item The Tree node (item) to which this event applies.", "itemRenderer The item renderer object for the cell.", "triggerEvent If the node opened or closed in response to a"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "type", "type": "String"},
{ "name": "bubbles", "type": "Boolean"},
{ "name": "cancelable", "type": "Boolean"},
{ "name": "item", "type": "Object"},
{ "name": "itemRenderer", "type": "mx.controls.listClasses.IListItemRenderer"},
{ "name": "triggerEvent", "type": "org.apache.royale.events.Event"}]}
,
{ "type": "field",
"qname": "animate",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Whether to animate an opening or closing operation; used for ITEM_OPENING type events only.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "dispatchEvent",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Whether to dispatch an event (<code>ITEM_OPEN</code> or <code>ITEM_CLOSE</code>) after the open or close animation is complete. Used for ITEM_OPENING type events only.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "item",
"return": "Object",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Storage for the item property. If you populate the Tree from XML data, access the properties for the node as <code>event.item.&#64;<i>attribute_name</i></code>.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "itemRenderer",
"return": "mx.controls.listClasses.IListItemRenderer",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The ListItemRenderer for the node that closed or opened.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "opening",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Used for an <code>ITEM_OPENING</code> type events only. Indicates whether the item is opening <code>true</code>, or closing <code>false</code>.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "triggerEvent",
"return": "org.apache.royale.events.Event",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The low level MouseEvent or KeyboardEvent that triggered this event or <code>null</code> if this event was triggered programatically.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}