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

Package	mx.controls.listClasses
Class	public class BaseListData
Inheritance	BaseListData EventDispatcher Object
Subclasses	DataGridListData, ListData, TreeListData

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

The listData property is of type BaseListData, where the BaseListData class has three subclasses: DataGridListData, ListData, and TreeListData. The actual data type of the value of the listData property depends on the control using the drop-in item renderer or item editor. For a DataGrid control, the value is of type DataGridListData, for a List control the value is of type ListData, and for a Tree control, the value is of type TreeListData.

When used as a drop-in item renderer or drop-in item editor, Flex sets the listData property to a BaseListData-derived class containing information computed about the item in the data provider containing the data for the item.

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.

The properties are marked bindable, but these properties do not actually do any change detection or send change events. The properties are changed as a whole by setting a new value for the listData property. The change event for the modification of the listData property updates all bindings.

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
		label : String The textual representation of the item data, based on the list class's itemToLabel() method.	BaseListData
		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
		BaseListData(label:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0) Constructor.	BaseListData
		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

columnIndex

property

public var columnIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

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

label

property

public var label:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The textual representation of the item data, based on the list class's itemToLabel() method.

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

owner

property

public var owner:IUIComponent

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A reference to the list object that owns this item. This should be a ListBase-derived class. This property is typed as IUIComponent so that drop-ins like Label and TextInput don't have to have dependencies on List and all of its dependencies.

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

rowIndex

property

public var rowIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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. For example, you click on an item in the control and rowIndex is set to 3. You then scroll the control to change the row's position in the visible rows of the control, and then click on the same row as before. The rowIndex now contains a different value corresponding to the new index of the row in the currently visible rows.

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

uid

property

uid:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The unique identifier for this item.

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

Implementation
public function get uid():String
public function set uid(value:String):void

Constructor Detail

BaseListData

()

Constructor

public function BaseListData(label: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

	`label:String` — The textual representation of the item data.

	`uid:String` — A unique identifier.

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

	`rowIndex:int` (default = `0`) — The index of the row in the currently visible rows of the control.

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