Packagemx.events
Classpublic class ItemClickEvent
InheritanceItemClickEvent Inheritance 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
 PropertyDefined 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
 MethodDefined 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
 ConstantDefined 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
indexproperty
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.

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

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

relatedObjectproperty 
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_CLICKConstant
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
indexThe index of the navigation item that was clicked.
itemThe item in the data provider of the navigation item that was clicked.
labelThe label of the navigation item that was clicked.
relatedObjectThe child object that generated the event.
targetThe 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.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00