| Package | mx.controls.listClasses |
| Class | public class ListData |
| Inheritance | ListData  BaseListData |
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
| 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 | |
| Method | Defined by | ||
|---|---|---|---|
|
ListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0)
Constructor.
| ListData | ||
| icon | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var icon:Class
A Class representing the icon for the item in the List control computed
from the list class's itemToIcon() method
| labelField | property |
public var labelField:String
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.
| ListData | () | constructor |
public function ListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0)Constructor.
Parameterstext: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) |
|
columnIndex:int (default = 0) |