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

Package | mx.events
Class | public class ItemClickEvent
Inheritance | ItemClickEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Represents events that are dispatched when a navigation item on a navigator bar, such as a ButtonBar, LinkBar, or TabBar control, has been clicked.

See also

mx.controls.NavBar
mx.controls.Button
mx.controls.List

Public Properties

| Property | Defined By
--- | --- | ---
|  | index : int The index of the associated navigation item. | ItemClickEvent
|  | item : Object The item in the data provider of the associated navigation item. | ItemClickEvent
|  | label : String The label of the associated navigation item. | ItemClickEvent
|  | relatedObject : InteractiveObject The child object that generated the event; for example, the button that a user clicked in a ButtonBar control. | ItemClickEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | ItemClickEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, label:String = null, index:int = -1, relatedObject:InteractiveObject = null, item:Object = null) Constructor. | ItemClickEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ITEM_CLICK : String = itemClick [static] The ItemClickEvent.ITEM_CLICK constant defines the value of the type property of the event object for an itemClick event. | ItemClickEvent

Property Detail

index | property

`public var index:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The index of the associated navigation item.

item | property |

`public var item:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The item in the data provider of the associated navigation item.

label | property |

`public var label:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The label of the associated navigation item.

relatedObject | property |

`public var relatedObject:InteractiveObject`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The child object that generated the event; for example, the button that a user clicked in a ButtonBar control.

Constructor Detail

ItemClickEvent | () | Constructor

`public function ItemClickEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, label:String = null, index:int = -1, relatedObject:InteractiveObject = null, item:Object = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

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.
| `label:String` (default = `null`)`` — The label of the associated navigation item.
| `index:int` (default = `-1`)`` — The index of the associated navigation item.
| `relatedObject:InteractiveObject` (default = `null`)`` — The child object that generated the event.
| `item:Object` (default = `null`)`` — The item in the data provider for the associated navigation item.

Constant Detail

ITEM_CLICK | Constant

`public static const ITEM_CLICK:String = itemClick`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `ItemClickEvent.ITEM_CLICK` constant defines the value of the `type` property of the event object for an `itemClick` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`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`.
`index` | The index of the navigation item that was clicked.
`item` | The item in the data provider of the navigation item that was clicked.
`label` | The label of the navigation item that was clicked.
`relatedObject` | The child object that generated the event.
`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.

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