| 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 |
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.
Related API Elements
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 | ||
| Method | Defined By | ||
|---|---|---|---|
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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
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):voidBaseListData | () | 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.
Parameterslabel: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) | |
columnIndex:int (default = 0) |
Mon Nov 28 2011, 06:48 AM -08:00