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

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

See also

mx.controls.listClasses.IDropInListItemRenderer

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
|  | 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
|  | 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
--- | --- | ---
|  | BaseListData(label:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0) Constructor. | BaseListData

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.

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.

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.

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.

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.

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.

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