ListEvent

Package	spark.events
Class	public class ListEvent
Inheritance	ListEvent MouseEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

ListEvents dispatched by ListBase components like ButtonBar and List in response to MouseEvents are constructed with the incoming mouse event's properties. The list event's x,y location, i.e. the value of its localX and localY properties, is defined relative to the entire component, not just the part of the component that has been scrolled into view. Similarly, the event's row and column indices may correspond to a cell that has not been scrolled into view.

More examples

Manually dispatching events

Learn more

About Flex events

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		altKey : Boolean Indicates whether the Alt key is active (true) or inactive (false).	MouseEvent
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		buttonDown : Boolean Indicates whether the primary mouse button is pressed (true) or not (false).	MouseEvent
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		clickCount : int [read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.	MouseEvent
		commandKey : Boolean Indicates whether the command key is activated (Mac only.) The value of property commandKey will have the same value as property ctrlKey on the Mac.	MouseEvent
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		controlKey : Boolean Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.	MouseEvent
		ctrlKey : Boolean On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).	MouseEvent
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		delta : int Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.	MouseEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		isRelatedObjectInaccessible : Boolean If true, the relatedObject property is set to null for reasons related to security sandboxes.	MouseEvent
		item : Object The data provider item the item renderer is displaying.	ListEvent
		itemIndex : int The index of the data item the item renderer is displaying.	ListEvent
		itemRenderer : IItemRenderer The item renderer that is displaying the item.	ListEvent
		localX : Number When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		movementX : Number When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event.	MouseEvent
		movementY : Number When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event.	MouseEvent
		relatedObject : InteractiveObject A reference to a display list object that is related to the event.	MouseEvent
		shiftKey : Boolean Indicates whether the Shift key is active (true) or inactive (false).	MouseEvent
		stageX : Number [read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		stageY : Number [read-only] The vertical coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, itemIndex:int = -1, item:Object = null, itemRenderer:IItemRenderer = null) Constructor.	ListEvent
		clone():Event [override] Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.	MouseEvent
		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 [override] Returns a string that contains all the properties of the MouseEvent object.	MouseEvent
		updateAfterEvent():void Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.	MouseEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ITEM_ROLL_OUT : String = "itemRollOut" [static] The ListEvent.ITEM_ROLL_OUT constant defines the value of the type property of the ListEvent object for an itemRollOut event, which indicates that the user rolled the mouse pointer out of a visual item in the control.	ListEvent
		ITEM_ROLL_OVER : String = "itemRollOver" [static] The ListEvent.ITEM_ROLL_OVER constant defines the value of the type property of the ListEvent object for an itemRollOver event, which indicates that the user rolled the mouse pointer over a visual item in the control.	ListEvent

Property Detail

item

property

public var item:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

The data provider item the item renderer is displaying.

itemIndex

property

public var itemIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

The index of the data item the item renderer is displaying. You can access the data provider item using this property.

itemRenderer

property

public var itemRenderer:IItemRenderer

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

The item renderer that is displaying the item.

Constructor Detail

()

Constructor

public function ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, itemIndex:int = -1, item:Object = null, itemRenderer:IItemRenderer = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

Constructor. Normally called by the Flex control and not used in application code.

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.

	`localX:Number` (default = `NaN`) — Distinguishes the mouse gesture that caused this event to be dispatched.

	`localY:Number` (default = `NaN`) — Specifies whether the event can bubble up the display list hierarchy.

	`relatedObject:InteractiveObject` (default = `null`) — Specifies whether the behavior associated with the event can be prevented.

	`ctrlKey:Boolean` (default = `false`) — The event's x coordinate relative to the List.

	`altKey:Boolean` (default = `false`) — The event's y coordinate relative to the List.

	`shiftKey:Boolean` (default = `false`) — The `relatedObject` property of the MouseEvent that triggered this ListEvent.

	`buttonDown:Boolean` (default = `false`) — Whether the Control key is down.

	`delta:int` (default = `0`) — Whether the Alt key is down.

	`itemIndex:int` (default = `-1`) — Whether the Shift key is down.

	`item:Object` (default = `null`) — Whether the Control key is down.

	`itemRenderer:IItemRenderer` (default = `null`) — Not used.

Constant Detail

ITEM_ROLL_OUT

Constant

public static const ITEM_ROLL_OUT:String = "itemRollOut"

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

The ListEvent.ITEM_ROLL_OUT constant defines the value of the type property of the ListEvent object for an itemRollOut event, which indicates that the user rolled the mouse pointer out of a visual item in the control.

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`.
`itemIndex`	The data provider index of the item displayed by the item renderer where the event occurred.
`item`	The data provider item for the item renderer.
`itemRenderer`	The The item renderer that displayed this item.
`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.
`Type`	ListEvent.ITEM_ROLL_OUT

ITEM_ROLL_OVER

Constant

public static const ITEM_ROLL_OVER:String = "itemRollOver"

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.5

The ListEvent.ITEM_ROLL_OVER constant defines the value of the type property of the ListEvent object for an itemRollOver event, which indicates that the user rolled the mouse pointer over a visual item in the control.

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`.
`itemIndex`	The data provider index of the item displayed by the item renderer where the event occurred.
`item`	The data provider item for the item renderer.
`itemRenderer`	The The item renderer that displayed this item.
`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.
`Type`	ListEvent.ITEM_ROLL_OVER

ListEvent - AS3 Flex

Classes x

item

itemIndex

itemRenderer

ListEvent

ITEM_ROLL_OUT

ITEM_ROLL_OVER

spark.events ListEvent - AS3 Flex		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples