mx.controls.listClasses.ListData - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.controls.listClasses
Class	public class ListData
Inheritance	ListData BaseListData EventDispatcher Object
Subclasses	MenuListData

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ListData class defines the data type of the listData property implemented by drop-in item renderers or drop-in item editors for the List control. All drop-in item renderers and drop-in item editors must implement the IDropInListItemRenderer interface, which defines the listData property.

While the properties of this class are writable, you should consider them to be read only. They are initialized by the List class, and read by an item renderer or item editor. Changing these values can lead to unexpected results.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		columnIndex : int The index of the column of the List-based control relative to the currently visible columns of the control, where the first column is at an index of 1.	BaseListData
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		icon : Class A Class representing the icon for the item in the List control computed from the list class's itemToIcon() method	ListData
		label : String The textual representation of the item data, based on the list class's itemToLabel() method.	BaseListData
		labelField : String The value of the labelField property in the list class.	ListData
		owner : IUIComponent A reference to the list object that owns this item.	BaseListData
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		rowIndex : int The index of the row of the DataGrid, List, or Tree control relative to the currently visible rows of the control, where the first row is at an index of 1.	BaseListData
		uid : String The unique identifier for this item.	BaseListData

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0) Constructor.	ListData
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

icon

property

public var icon:Class

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A Class representing the icon for the item in the List control computed from the list class's itemToIcon() method

This property can be used as the source for data binding. When this property is modified, it dispatches the __NoChangeEvent__ event.

labelField

property

public var labelField:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The value of the labelField property in the list class. This is the value normally used to calculate which property should be taken from the item in the data provider for the text displayed in the item renderer, but is also used by DateField and other components to indicate which field to take from the data provider item that contains a Date or other non-text property.

For example, if a data provider item contains a "hiredDate" property, the labelField property can be set to "hiredDate" and the itemRenderer property can be set to DateField. The DateField control then uses the hiredDate property.

This property can be used as the source for data binding. When this property is modified, it dispatches the __NoChangeEvent__ event.

Constructor Detail

ListData

()

Constructor

public function ListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`text:String` — Text representation of the item data.

	`icon:Class` — A Class or String object representing the icon for the item in the List control.

	`labelField:String` — The name of the field of the data provider containing the label data of the List component.

	`uid:String` — A unique identifier for the item.

	`owner:IUIComponent` — A reference to the List control.

	`rowIndex:int` (default = `0`) — The index of the item in the data provider for the List control.

	`columnIndex:int` (default = `0`) — The index of the column in the currently visible columns of the control.