mx.controls.dataGridClasses

# DataGridListData - AS3 Flex

Package | mx.controls.dataGridClasses
Class | public class DataGridListData
Inheritance | DataGridListData BaseListData EventDispatcher 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.

Related API Elements

mx.controls.listClasses.IDropInListItemRenderer

Public Properties
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
|  | dataField : String Name of the field or property in the data provider associated with the column. | DataGridListData
|  | 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DataGridListData(text:String, dataField:String, columnIndex:int, uid:String, owner:IUIComponent, rowIndex:int = 0) Constructor. | DataGridListData
|  | 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher

Property Detail

### dataField

property

`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.

This property can be used as the source for data binding. When this property is modified, it dispatches the `__NoChangeEvent__` event.

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00