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

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
  columnIndex : int
The column index of the item in columns for the DataGrid control.
DataGridListData
 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 item in the data provider.
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
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property detail
columnIndexproperty
public var columnIndex:int

The column index of the item in columns for the DataGrid control.

dataFieldproperty 
public var dataField:String

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)

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.



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/controls/dataGridClasses/DataGridListData.html