ItemClickEvent

Package	mx.events
Class	public class ItemClickEvent
Inheritance	ItemClickEvent Event Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

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

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		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
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

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
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

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.

Legal Notices | Online Privacy Policy

ItemClickEvent - AS3 Flex

Classes x

index

item

label

relatedObject

ItemClickEvent

ITEM_CLICK