Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ListData

Package | mx.controls.listClasses
Class | public class ListData
Inheritance | ListData BaseListData flash.events.EventDispatcher
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.

See also

mx.controls.listClasses.IDropInListItemRenderer

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

| Method | Defined By
--- | --- | ---
|  | ListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0) Constructor. | ListData

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.

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.

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.

Sun Mar 5 2017, 03:42 PM +11:00