blob: 685c2ceb5afcc7a1d5866479493697afe9704b84 [file] [log] [blame]
{ "type": "class",
"qname": "mx.events.ItemClickEvent",
"baseClassname": "org.apache.royale.events.Event"
,
"description": "Represents events that are dispatched when a navigation item on a navigator bar, such as a ButtonBar, LinkBar, or TabBar control, has been clicked.",
"tags": [
{ "tagName": "see",
"values": ["mx.controls.NavBar", "mx.controls.Button", "mx.controls.List"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "field",
"qname": "ITEM_CLICK",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "The <code>ItemClickEvent.ITEM_CLICK</code> constant defines the value of the <code>type</code> property of the event object for an <code>itemClick</code> event. <p>The properties of the event object have the following values:</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></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>index</code></td><td>The index of the navigation item that was clicked.</td></tr> <tr><td><code>item</code></td><td>The item in the data provider of the navigation item that was clicked.</td></tr> <tr><td><code>label</code></td><td>The label of the navigation item that was clicked.</td></tr> <tr><td><code>relatedObject</code></td><td>The child object that generated the event.</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> </table>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["itemClick"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "mx.events.ItemClickEvent",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor. up the display list hierarchy. associated with the event can be prevented.",
"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", "label The label of the associated navigation item.", "index The index of the associated navigation item.", "relatedObject The child object that generated the event.", "item The item in the data provider for the associated navigation item."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "type", "type": "String"},
{ "name": "bubbles", "type": "Boolean"},
{ "name": "cancelable", "type": "Boolean"},
{ "name": "label", "type": "String"},
{ "name": "index", "type": "int"},
{ "name": "relatedObject", "type": "Object"},
{ "name": "item", "type": "Object"}]}
,
{ "type": "field",
"qname": "index",
"return": "int",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The index of the associated navigation item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ]},
{ "type": "field",
"qname": "item",
"return": "Object",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The item in the data provider of the associated navigation item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ]},
{ "type": "field",
"qname": "label",
"return": "String",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The label of the associated navigation item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ]},
{ "type": "field",
"qname": "relatedObject",
"return": "Object",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The child object that generated the event; for example, the button that a user clicked in a ButtonBar control.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ]}]
}