Packagemx.controls.dataGridClasses
Classpublic class DataGridListData
InheritanceDataGridListData Inheritance BaseListData Inheritance Object
Subclasses AdvancedDataGridListData

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DataGridListData class defines the data type of the listData property that is implemented by drop-in item renderers or drop-in item editors for the DataGrid control. All drop-in item renderers and drop-in item editors must implement the IDropInListItemRenderer interface, which defines the listData property.

Although the properties of this class are writable, you should consider them to be read-only. They are initialized by the DataGrid 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
 PropertyDefined By
 InheritedcolumnIndex : 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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataField : String
Name of the field or property in the data provider associated with the column.
DataGridListData
 Inheritedlabel : String
The textual representation of the item data, based on the list class's itemToLabel() method.
BaseListData
 Inheritedowner : IUIComponent
A reference to the list object that owns this item.
BaseListData
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrowIndex : 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
 Inheriteduid : String
The unique identifier for this item.
BaseListData
Public Methods
 MethodDefined By
  
DataGridListData(text:String, dataField:String, columnIndex:int, uid:String, owner:IUIComponent, rowIndex:int = 0)
Constructor.
DataGridListData
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
dataFieldproperty
public var dataField:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Name of the field or property in the data provider associated with the column.

Constructor Detail
DataGridListData()Constructor
public function DataGridListData(text:String, dataField:String, columnIndex:int, uid:String, owner:IUIComponent, rowIndex: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.
 
dataField:String — Name of the field or property in the data provider associated with the column.
 
columnIndex:int — The column index of the item in the columns for the DataGrid control.
 
uid:String — A unique identifier for the item.
 
owner:IUIComponent — A reference to the DataGrid control.
 
rowIndex:int (default = 0) — The index of the item in the data provider for the DataGrid control.