AdvancedDataGridColumn  - AS3 Flex

The name of the field or property in the data provider item associated with the column. Each AdvancedDataGridColumn control requires this property and/or the labelFunction property to be set in order to calculate the displayable text for the item renderer. If the dataField and labelFunction properties are set, the data is displayed using the labelFunction and sorted using the dataField. If the property named in the dataField does not exist, the sortCompareFunction must be set for the sort to work correctly.

This value of this property is not necessarily the String that is displayed in the column header. This property is used only to access the data in the data provider. For more information, see the headerText property.

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

Related API Elements

The name of the field in the data provider to display as the data tip. By default, the AdvancedDataGrid control looks for a property named label on each data provider item and displays it. However, if the data provider does not contain a label property, you can set the dataTipField property to specify a different property. For example, you could set the value to "FullName" when a user views a set of people's names included from a database.

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

Specifies a callback function to run on each item of the data provider to determine its data tip. This property is used by the itemToDataTip() method.

By default, the control looks for a property named label on each data provider item and displays it as its dataTip. However, some data providers do not have a label property or another property that you can use for displaying data in the rows. For example, you might have a data provider that contains a lastName and firstName fields, but you want to display full names as the dataTip. You can specify a function to the dataTipFunction property that returns a single String containing the value of both fields. You can also use the dataTipFunction property for handling formatting and localization.

The function must take a single Object parameter, and return a String. For the header cell of a column, the Object parameter is of type AdvancedDataGridColumn. For table cells, the Object parameter contains the data provider element for the cell.

Shown below is an example implementation of the function. For the header cell, return "Column Name". For the table cells, return the name property of the Object:

      private function tipFunc(value:Object):String
      {
          if (value is AdvancedDataGridColumn)
              return "Column Name";
                     
          // Use the 'name' property of the data provider element.
          return "Name: " + value["name"];
      }

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

A flag that indicates whether the user is allowed to drag the column to a new position If true, the user can drag the the column headers to a new position

The default value is true.

A flag that indicates whether the items in the column are editable. If true, and the AdvancedDataGrid's editable property is also true, the items in a column are editable and can be individually edited by clicking an item or by navigating to the item with the Tab and Arrow keys.

The default value is true.

The name of the property of the item editor that contains the new data for the list item. For example, the default itemEditor is TextInput, so the default value of the editorDataField property is "text", which specifies the text property of the TextInput control.

The default value is "text".

The height of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

A flag that indicates whether the item editor uses Enter key. If true the item editor uses the Enter key and the AdvancedDataGrid will not look for the Enter key and move the editor in response. Note that changing this value while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is false.

The width of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

A flag that indicates whether the IME should be enabled when the component receives focus. If an editor is up, it will set enableIME accordingly.

An instance of a subclasses of mx.formatters.Formatter. The control use this class to format the column text.

The default value is null.

The class factory for item renderer instances that display the column header for the column. You can specify a drop-in item renderer, an inline item renderer, or a custom item renderer component as the value of this property.

The default item renderer is the AdvancedDataGridItemRenderer class, which displays the item data as text.

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

Text for the header of this column. By default, the AdvancedDataGrid control uses the value of the dataField property as the header text.

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

Set to true to wrap the text in the column header if it does not fit on one line. If undefined, the AdvancedDataGrid control's wordWrap property is used. This property overrides the headerWordWrap property of the AdvancedDataGrid control.

The default value is undefined.

Specifies the IME (input method editor) mode. The IME mode enables users to enter text in Chinese, Japanese, and Korean. Flex sets the IME mode when the itemFocusIn event occurs, and sets it back to the previous value when the itemFocusOut event occurs. The flash.system.IMEConversionMode class defines constants for the valid values for this property.

The default value is null, in which case it uses the value of the AdvancedDataGrid control's imeMode property.

Related API Elements

A class factory for the instances of the item editor to use for the column, when it is editable.

The default value is the mx.controls.TextInput control.

Related API Elements

The class factory for item renderer instances that display the data for each item in the column. You can specify a drop-in item renderer, an inline item renderer, or a custom item renderer component as the value of this property.

The default item renderer is the AdvancedDataGridItemRenderer class, which displays the item data as text.

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

Related API Elements

A function that determines the text to display in this column. By default, the column displays the text for the field in the data that matches the column name. However, sometimes you want to display text based on more than one field in the data, or display something that does not have the format that you want. In such a case, you specify a callback function using labelFunction.

For the AdvancedDataGrid control, the method signature has the following form:

labelFunction(item:Object, column:AdvancedDataGridColumn):String

where item contains the AdvancedDataGrid item object, and column specifies the AdvancedDataGrid column.

A callback function might concatenate the firstName and lastName fields in the data, or do some custom formatting on a Date, or convert a number for the month into the string for the month.

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

The minimum width of the column, in pixels.

The default value is 20.

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

A flag that indicates that the item renderer is also an item editor. If this property is true, Flex ignores the itemEditor property and uses the item renderer for that item as the editor.

The default value is false.

Set to true if the user is allowed to resize the width of the column. If true, the user can drag the grid lines between the column headers to resize the column.

The default value is true.

Set to true to show data tips in the column. If true, datatips are displayed for text in the rows. Datatips are tooltips designed to show the text that is too long for the row.

The default value is false.

Set to true to indicate that the user can click on the header of this column to sort the data provider. If this property and the AdvancedDataGrid sortableColumns property are both true, the AdvancedDataGrid control dispatches a headerRelease event when a user releases the mouse button on this column's header. If no other handler calls the preventDefault() method on the headerRelease event, the dataField property or sortCompareFunction in the column is used to reorder the items in the data provider.

The default value is true.

A callback function that gets called when sorting the data in the column. If this property is not specified, the sort tries to use a basic string or number sort on the data. If the data is not a string or number or if the dataField property is not a valid property of the data provider, the sort does not work or will generate an exception. If you specify a value of the labelFunction property, you typically also provide a function to the sortCompareFunction property, unless sorting is not allowed on this column. That means you specify a function when the value from the column's dataField does not sort in the same way as the computed value from the labelFunction property.

The AdvancedDataGrid control uses this function to sort the elements of the data provider collection. The function signature of the callback function takes two parameters and has the following form:

mySortCompareFunction(obj1:Object, obj2:Object):int 

obj1 — A data element to compare.

obj2 — Another data element to compare with obj1.

The function should return a value based on the comparison of the objects:

• -1 if obj1 should appear before obj2 in ascending order.
• 0 if obj1 = obj2.
• 1 if obj1 should appear after obj2 in ascending order.

Note: The obj1 and obj2 parameters are entire data provider elements and not just the data for the item.

The default value is null.

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

Indicates whether the column sort is in ascending order, false, or descending order, true.

The default value is false.

A callback function that is called when rendering each cell. The signature of the function should be:

function myStyleFunction(data:Object, column:AdvancedDataGridColumn):Object

data - data object associated with the item being rendered.

column - AdvancedDataGridColumn instance with which the item renderer is associated.

The return value should be a object with styles as properties having the required values. For example:

{ color:0xFF0000, fontWeight:"bold" }

If true, the column is visible. Set to false to hide the column.

The default value is true.

The width of the column, in pixels. If the AdvancedDataGrid's horizontalScrollPolicy property is false, all visible columns must fit in the displayable area, and the AdvancedDataGrid will not always honor the width of the columns if the total width of the columns is too small or too large for the displayable area.

The default value is 100.

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

Set to false to wrap the text in a row of this column because it does not fit on one line If undefined, the AdvancedDataGrid control's wordWrap property is used.

The default value is undefined.

Constructor.

Clone this column and return a new Column with the same properties and styles as this one. It does not set all the available properties

Returns a String that the item renderer displays as the data tip for the given data object, based on the dataTipField and dataTipFunction properties. If the method cannot convert the parameter to a String, it returns a single space.

This method is for use by developers who are creating subclasses of the AdvancedDataGridColumn class. It is not for use by application developers.

Parameters

Returns the String that the item renderer displays for the given data object. If the AdvancedDataGridColumn or its AdvancedDataGrid control has a non-null labelFunction property, it applies the function to the data object. Otherwise, the method extracts the contents of the field specified by the dataField property, or gets the string value of the data object. If the method cannot convert the parameter to a String, it returns a single space.

Parameters