The <s:GridColumn> tag inherits all of the tag
* attributes of its superclass and adds the following tag attributes:
* <s:GridColumn * Properties * dataField="null" * dataTipField="null" * dataTipFormatter="null" * dataTipFunction="null" * editable="true" * formatter="null" * headerRenderer="null" * headerText="value of dataField" * imeMode="null" * itemEditor="null" * itemRenderer="null" * itemRendererFunction="null" * labelFunction="null" * maxWidth="NaN" * minWidth="20" * rendererIsEditable="false" * resizeable="true" * showDataTips="undefined" * sortable="true" * sortCompareFunction="null" * sortDescending="false" * visible="true" * width="NaN" * /> ** * @see spark.components.Grid * @see spark.components.DataGrid * * @includeExample examples/GridColumnExample.mxml * @includeExample examples/GridColumnVisibilityExample.mxml * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public class GridColumn extends EventDispatcher { include "../../core/Version.as"; //-------------------------------------------------------------------------- // // Class constants // //-------------------------------------------------------------------------- /** * The return value for the
itemToLabel() or
* itemToDataTip() method if resolving the corresponding
* property name (path) fails.
* The value of this constant is a single space String: " ".
*
* @see #itemToLabel
* @see #itemToDataTip
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public static const ERROR_TEXT:String = new String(" ");
//--------------------------------------------------------------------------
//
// Class variables and methods
//
//--------------------------------------------------------------------------
//----------------------------------
// defaultItemEditorFactory
//----------------------------------
private static var _defaultItemEditorFactory:IFactory;
/**
* @private
*/
mx_internal static function get defaultItemEditorFactory():IFactory
{
if (!_defaultItemEditorFactory)
_defaultItemEditorFactory = new ClassFactory(DefaultGridItemEditor);
return _defaultItemEditorFactory;
}
/**
* @private
* A default compare function for sorting if the dataField is a complex path.
*/
private static function dataFieldPathSortCompare(obj1:Object, obj2:Object, column:GridColumn):int
{
if (!obj1 && !obj2)
return 0;
if (!obj1)
return 1;
if (!obj2)
return -1;
const dataFieldPath:Array = column.dataField.split(".");
const formatter:IFormatter = column.formatter;
const obj1String:String = column.itemToString(obj1, dataFieldPath, null, formatter);
const obj2String:String = column.itemToString(obj2, dataFieldPath, null, formatter);
if ( obj1String < obj2String )
return -1;
if ( obj1String > obj2String )
return 1;
return 0;
}
//--------------------------------------------------------------------------
//
// Constructor
//
//--------------------------------------------------------------------------
/**
* Constructor.
*
* @param columnName Initial value for the dataField and
* headerText properties.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function GridColumn(columnName:String = null)
{
super();
if (columnName)
dataField = headerText = columnName;
}
//--------------------------------------------------------------------------
//
// Properties
//
//--------------------------------------------------------------------------
//----------------------------------
// grid
//----------------------------------
private var _grid:Grid = null;
/**
* @private
* Set by the Grid when this column is added to grid.columns, set
* to null when the column is removed.
*/
mx_internal function setGrid(value:Grid):void
{
if (_grid == value)
return;
_grid = value;
dispatchChangeEvent("gridChanged");
}
[Bindable("gridChanged")]
/**
* The Grid object associated with this column.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get grid():Grid
{
return _grid;
}
//----------------------------------
// columnIndex
//----------------------------------
private var _columnIndex:int = -1;
/**
* @private
* Set by the Grid when this column is added to the grid.columns, set
* to -1 when the column is removed.
*/
mx_internal function setColumnIndex(value:int):void
{
if (_columnIndex == value)
return;
_columnIndex = value;
dispatchChangeEvent("columnIndexChanged");
}
[Bindable("columnIndexChanged")]
/**
* The position of this column in the grid's column list,
* or -1 if this column's grid is null.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get columnIndex():int
{
return _columnIndex;
}
//----------------------------------
// dataField
//----------------------------------
private var _dataField:String = null;
mx_internal var dataFieldPath:Array = [];
[Bindable("dataFieldChanged")]
/**
* The name of the field or property in the data provider item associated
* with the column.
* Each GridColumn requires this property or
* the labelFunction property to be set
* 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.
*
* 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.
If the column or its grid specifies a labelFunction,
* then the dataField is not used.
showDataTips is true,
* the associated grid 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 name.
* For example, you could set the value to "FullName" when a user views a
* set of people's names included from a database.
*
* GridColumn.dataTipField takes precedence over this property.
If this column or its grid specifies a value for the
* dataTipFunction property, then the
* dataTipField property is ignored.
itemToDataTip() method to
* convert data provider items to Strings.
*
* If the formatter's styleParent was not specified, it's set
* to the column's grid, so that the formatter inherits the grid's locale style.
itemToDataTip method.
*
* By default, if showDataTips is true,
* the column looks for a property named label
* on each data provider item and displays it as its data tip.
* However, some data providers do not have a label property
* nor do they have another property that you can use for displaying data
* in the rows.
For example, you have a data provider that contains a lastName
* and firstName fields, but you want to display full names as the data tip.
* 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 signature of the dataTipFunction function must match the following:
*
*
dataTipFunction(item:Object, column:GridColumn):String* * The
item parameter is the data provider item for an entire row.
* The second parameter is this column object.
*
* A typical function might concatenate an item's firstName and * lastName properties, or do some custom formatting on a Date value * property.
* * @default null * * @see #itemToDataTip * @see #dataTipField * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function get dataTipFunction():Function { return _dataTipFunction; } /** * @private */ public function set dataTipFunction(value:Function):void { if (_dataTipFunction == value) return; _dataTipFunction = value; if (grid) grid.invalidateDisplayList(); dispatchChangeEvent("dataTipFunctionChanged"); } //---------------------------------- // editable //---------------------------------- private var _editable:Boolean = true; [Bindable("editableChanged")] [Inspectable(category="General")] /** * Indicates whether the items in the column are editable. * Iftrue, and the associated grid's editable
* property is also true, the items in a column are
* editable and can be individually edited
* by clicking on a selected item, or by navigating to the item and
* pressing the F2 key.
*
* @default true
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get editable():Boolean
{
return _editable;
}
/**
* @private
*/
public function set editable(value:Boolean):void
{
if (_editable == value)
return;
_editable = value;
dispatchChangeEvent("editableChanged");
}
//----------------------------------
// formatter
//----------------------------------
private var _formatter:IFormatter = null;
private var formatterStyleParentInvalid:Boolean = false;
[Bindable("formatterChanged")]
[Inspectable(category="General")]
/**
* Specifies the formatter used by the column's itemToLabel() method to
* convert data provider items to strings.
*
* If the formatter's styleParent was not specified, it's set
* to the column's grid, so that the formatter inherits the grid's locale style.
columnHeaderGroup
* skin part defines the default header renderer.
*
* @default null
*
* @see #headerText
* @see IGridItemRenderer
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get headerRenderer():IFactory
{
return _headerRenderer;
}
/**
* @private
*/
public function set headerRenderer(value:IFactory):void
{
if (_headerRenderer == value)
return;
_headerRenderer = value;
if (grid)
grid.invalidateDisplayList();
dispatchChangeEvent("headerRendererChanged");
}
//----------------------------------
// headerText
//----------------------------------
private var _headerText:String;
[Bindable("headerTextChanged")]
/**
* Text for the header of this column.
* By default, the associated grid control uses the value of
* the dataField property as the header text.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get headerText():String
{
return (_headerText != null) ? _headerText : ((dataField) ? dataField : "");
}
/**
* @private
*/
public function set headerText(value:String):void
{
_headerText = value;
if (grid)
grid.invalidateDisplayList();
dispatchChangeEvent("headerTextChanged");
}
//----------------------------------
// imeMode
//----------------------------------
private var _imeMode:String = null;
[Inspectable(environment="none")]
/**
* @copy spark.components.gridClasses.GridItemEditor#imeMode
*
* @see flash.system.IMEConversionMode
*
* @default null
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get imeMode():String
{
return _imeMode;
}
/**
* @private
*/
public function set imeMode(value:String):void
{
_imeMode = value;
}
//----------------------------------
// itemEditor
//----------------------------------
private var _itemEditor:IFactory = null;
[Bindable("itemEditorChanged")]
/**
* A class factory for IGridItemEditor class used to edit individual
* grid cells in this column.
* If this property is null, and the column grid's owner is a DataGrid control,
* then the value of the DataGrid control's itemEditor property is used.
* If no item editor is specified by the DataGrid control,
* then use the DefaultGridItemEditor class.
*
* The default item editor is the DefaultGridItemEditor class, * which lets you edit a simple text field. * You can create custom item renderers by creating a subclass of the GridItemEditor class. * Your custom item editor can write data to the entire row of the grid * to define more complex editor.
* * @default null * * @see spark.components.gridClasses.DefaultGridItemEditor * @see spark.components.gridClasses.GridItemEditor * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function get itemEditor():IFactory { return _itemEditor; } /** * @private */ public function set itemEditor(value:IFactory):void { if (_itemEditor == value) return; _itemEditor = value; dispatchChangeEvent("itemEditorChanged"); } //---------------------------------- // itemRenderer //---------------------------------- private var _itemRenderer:IFactory = null; [Bindable("itemRendererChanged")] /** * The class factory for the IGridItemRenderer class used to * render individual grid cells. * If not specified, use the value of theitemRenderer
* property from the associated grid control.
*
* The default item renderer is the DefaultGridItemRenderer class, * which displays the data item as text. * You can create custom item renderers by creating a subclass of the GridItemRenderer class. * Your custom item renderer can access the data from the entire row of the grid * to define more complex visual representation of the cell.
* *The default value is the value of the itemRenderer
* property from the associated grid control, or null.
itemRendererFunction property
* makes it possible to use more than one item renderer in this column.
*
* The function specified to the itemRendererFunction property
* must have the following signature:
itemRendererFunction(item:Object, column:GridColumn):IFactory* *
The item parameter is the data provider item for an entire row.
* The second parameter is this column object.
Shown below is an example of an item renderer function:
*
* function myItemRendererFunction(item:Object, column:GridColumn):IFactory
* {
* return (item is Array) ? myArrayItemRenderer : myItemRenderer;
* }
*
*
* @default null
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get itemRendererFunction():Function
{
return _itemRendererFunction;
}
/**
* @private
*/
public function set itemRendererFunction(value:Function):void
{
if (_itemRendererFunction == value)
return;
_itemRendererFunction = value;
invalidateGrid();
if (grid)
grid.clearGridLayoutCache(true);
dispatchChangeEvent("itemRendererFunctionChanged");
}
//----------------------------------
// labelFunction
//----------------------------------
private var _labelFunction:Function = null;
[Bindable("labelFunctionChanged")]
/**
* An idempotent function that converts a data provider item into a column-specific string
* that's used to initialize the item renderer's label property.
*
* You can use a label function to combine the values of several data provider items
* into a single string.
* If specified, this property is used by the
* itemToLabel() method, which computes the value of each item
* renderer's label property in this column.
The function specified to the labelFunction property
* must have the following signature:
labelFunction(item:Object, column:GridColumn):String* *
The item parameter is the data provider item for an entire row.
* The second parameter is this column object.
A typical label function could concatenate the firstName and * lastName properties of the data provider item , * or do some custom formatting on a Date value property.
* * @default null * * @see #itemToLabel * @see #dataField * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function get labelFunction():Function { return _labelFunction; } /** * @private */ public function set labelFunction(value:Function):void { if (_labelFunction == value) return; _labelFunction = value; invalidateGrid(); if (grid) grid.clearGridLayoutCache(true); dispatchChangeEvent("labelFunctionChanged"); } //---------------------------------- // width //---------------------------------- private var _width:Number = NaN; [Bindable("widthChanged")] /** * The width of this column in pixels. * If specified, the grid's layout ignores its *typicalItem property and this column's
* minWidth and maxWidth properties.
*
* @default NaN
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get width():Number
{
return _width;
}
/**
* @private
*/
public function set width(value:Number):void
{
if (_width == value)
return;
_width = value;
invalidateGrid();
// Reset content size so scroller's viewport can be resized. There
// is loop-prevention logic in the scroller which may not allow the
// width/height to be reduced if there are automatic scrollbars.
// See ScrollerLayout/measure().
/*
if (grid)
grid.setContentSize(0, 0);
*/
dispatchChangeEvent("widthChanged");
}
//----------------------------------
// minWidth
//----------------------------------
private var _minWidth:Number = 20;
[Bindable("minWidthChanged")]
/**
* The minimum width of this column in pixels.
* If specified, the grid's layout makes the column's layout
* width the larger of the width of the typicalItem and
* the minWidth.
* If this column is resizable, this property limits how small
* the user can make this column.
* Setting this property does not change the width
* or maxWidth properties.
*
* @default 20
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get minWidth():Number
{
return _minWidth;
}
/**
* @private
*/
public function set minWidth(value:Number):void
{
if (_minWidth == value)
return;
_minWidth = value;
invalidateGrid();
// Reset content size so scroller's viewport can be resized. There
// is loop-prevention logic in the scroller which may not allow the
// width/height to be reduced if there are automatic scrollbars.
// See ScrollerLayout/measure().
if (grid)
grid.setContentSize(0, 0);
dispatchChangeEvent("minWidthChanged");
}
//----------------------------------
// maxWidth
//----------------------------------
private var _maxWidth:Number = NaN;
[Bindable("maxWidthChanged")]
/**
* The maximum width of this column in pixels.
* If specified, the grid's layout makes the column's layout width the
* smaller of the width of the typicalItem and the maxWidth.
* If this column is resizable, this property limits how wide the user can make this column.
* Setting this property does not change the width
* or minWidth properties.
*
* @default NaN
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get maxWidth():Number
{
return _maxWidth;
}
/**
* @private
*/
public function set maxWidth(value:Number):void
{
if (_maxWidth == value)
return;
_maxWidth = value;
invalidateGrid();
// Reset content size so scroller's viewport can be resized. There
// is loop-prevention logic in the scroller which may not allow the
// width/height to be reduced if there are automatic scrollbars.
// See ScrollerLayout/measure().
if (grid)
grid.setContentSize(0, 0);
dispatchChangeEvent("maxWidthChanged");
}
//----------------------------------
// rendererIsEditable
//----------------------------------
private var _rendererIsEditable:Boolean = false;
[Bindable("rendererIsEditableChanged")]
/**
* Determines whether any of the item renderer's controls are editable.
* If the column is editable, the focusable controls in the item renderer
* are given keyboard focus when the user starts editing the item
* renderer.
*
* When you set this property to true, the cell becomes
* editable when the user clicks inside of it.
* Because the cell is editable, the DataGrid displays the editorIndicator
* skin part, which appears on top of the selectionIndicator skin part.
* Therefore, the user does not see an indicator for cell selection until the
* edit session is complete.
* You can create a custom skin to remove or modify the editorIndicator
* skin part so that the selectionIndicator skin part appears.
* For example, you can set alpha property of the editorIndicator
* to allow the selectionIndicator to show through, or change
* the size of the editorIndicator so that it is smaller than the cell.
By setting this property to true, you take responsibility for
* validating and saving input collected by the item renderer.
* If the item renderer contains an override of the IGridItemRenderer.prepare() method,
* then you must ensure that unsaved input field changes are not overwritten.
* For example, rendererIsEditable is true
* and the renderer contains a single TextInput element that displays
* the value of data.myDataField.
* If the renderer's prepare() method sets the TextInput control's
* text property, then the prepare() method must
* not set the text property when there are pending changes.
true, and the resizableColumns property of
* the associated grid is also true, the user can drag
* the grid lines between the column headers to resize the column.
*
* @default true
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get resizable():Boolean
{
return _resizable;
}
/**
* @private
*/
public function set resizable(value:Boolean):void
{
if (_resizable == value)
return;
_resizable = value;
dispatchChangeEvent("resizableChanged");
}
//----------------------------------
// showDataTips
//----------------------------------
private var _showDataTips:* = undefined;
[Bindable("showDataTipsChanged")]
/**
* Indicates whether the datatips are shown 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.
*
* If this property's value is undefined, the default, then the associated
* grid's showDataTips property determines if datatips are shown.
* If this property is set, the grid's showDataTips property is ignored.
true, and if the grid's data provider is an ICollectionView,
* and if the associated grid's sortableColumns property is true,
* then this column supports interactive sorting.
* Typically the column's header handles mouse clicks by setting the data provider's
* sort property to a Sort object whose SortField is this column's dataField.
*
* If the data provider is not an ICollectionView, then this property has no effect.
* * @default true * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function get sortable():Boolean { return _sortable; } /** * @private */ public function set sortable(value:Boolean):void { if (_sortable == value) return; _sortable = value; dispatchChangeEvent("sortableChanged"); } //---------------------------------- // sortCompareFunction //---------------------------------- private var _sortCompareFunction:Function; [Bindable("sortCompareFunctionChanged")] [Inspectable(category="Advanced")] /** * The function that compares two elements during a sort of on the * data elements of this column. * If you specify a value of thelabelFunction property,
* you typically also provide a sortCompareFunction.
*
* The sortCompareFunction's signature must match the following:
* *sortCompareFunction(obj1:Object, obj2:Object, column:GridColumn):int* *
The function should return a value based on the comparison * of the objects:
*The function may use the column parameter to write generic * compare functions.
* *Note: The obj1 and
* obj2 parameters are entire data provider elements and not
* just the data for the item.
If the dataProvider is not an ICollectionView, then this property has no effect.
* * @default null * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function get sortCompareFunction():Function { return _sortCompareFunction; } /** * @private */ public function set sortCompareFunction(value:Function):void { if (_sortCompareFunction == value) return; _sortCompareFunction = value; dispatchChangeEvent("sortCompareFunctionChanged"); } //---------------------------------- // sortDescending //---------------------------------- private var _sortDescending:Boolean = false; [Bindable("sortDescendingChanged")] /** * Iftrue, this column is sorted in descending order.
* For example, if the column's dataField contains a numeric value,
* then the first row would be the one with the largest value
* for this column.
*
* Setting this property does not start a sort; it only sets the sort direction.
* When the dataProvider.refresh() method is called, the sort is performed.
If the data provider is not an ICollectionView, then this property has no effect.
* * @default false * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function get sortDescending():Boolean { return _sortDescending; } /** * @private */ public function set sortDescending(value:Boolean):void { if (_sortDescending == value) return; _sortDescending = value; dispatchChangeEvent("sortDescendingChanged"); } //---------------------------------- // sortField //---------------------------------- /** * Returns a SortField that can be used to sort a collection by this * column'sdataField.
*
* If the sortCompareFunction property is defined,
* then the SortField's compareFunction is automatically set.
If the sortCompareFunction property is not defined
* and the dataField is complex, then the SortField's
* compare function is assigned to a closure around a default compare
* function that handles the complex dataField.
If the sortCompareFunction and
* dataField properties are not defined, but the
* labelFunction property is defined, then it assigns the
* compareFunction to a closure that does a basic string compare
* on the labelFunction applied to the data objects.
true, then display this column.
* If false, no space will be allocated
* for this column; it will not be included in the layout.
*
* @default true
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function get visible():Boolean
{
return _visible;
}
/**
* @private
*/
public function set visible(value:Boolean):void
{
if (_visible == value)
return;
_visible = value;
// dispatch event for grid.
if (grid && grid.columns)
{
var propertyChangeEvent:PropertyChangeEvent = PropertyChangeEvent.createUpdateEvent(this, "visible", !_visible, _visible);
var collectionEvent:CollectionEvent = new CollectionEvent(CollectionEvent.COLLECTION_CHANGE);
collectionEvent.kind = CollectionEventKind.UPDATE;
collectionEvent.items.push(propertyChangeEvent);
grid.columns.dispatchEvent(collectionEvent);
}
dispatchChangeEvent("visibleChanged");
}
//--------------------------------------------------------------------------
//
// Methods
//
//--------------------------------------------------------------------------
/**
* @private
* Common logic for itemToLabel(), itemToDataTip(). Logically this code is
* similar to (not the same as) LabelUtil.itemToLabel().
*/
mx_internal function itemToString(item:Object, labelPath:Array, labelFunction:Function, formatter:IFormatter):String
{
if (!item)
return ERROR_TEXT;
if (labelFunction != null)
return labelFunction(item, this);
var itemString:String = null;
try
{
var itemData:Object = item;
for each (var pathElement:String in labelPath)
itemData = itemData[pathElement];
if ((itemData != null) && (labelPath.length > 0))
itemString = (formatter) ? formatter.format(itemData) : itemData.toString();
}
catch(ignored:Error)
{
}
return (itemString != null) ? itemString : ERROR_TEXT;
}
/**
* Convert the specified data provider item to a column-specific String.
* This method is used to initialize item renderers' label property.
*
* If labelFunction is null, and dataField
* is a string that does not contain "." field name separator characters,
* and formatter is null, then this method is equivalent to:
item[dataField].toString()* *
If the formatter was specified, then this method's value is:
* *formatter.format(item[dataField])* *
If dataField is a "." separated
* path, then this method looks up each successive path element.
* For example if ="foo.bar.baz", then this method returns
* a string based on the value of item.foo.bar.baz.
* If resolving the item's dataField
* causes an error to be thrown, ERROR_TEXT is returned.
If item and labelFunction are not null,
* then this method returns labelFunction(item, this),
* where the second argument is this GridColumn.
grid.dataProvider.getItemAt(rowIndex).
*
* @return A column-specific string for the specified dataProvider item or ERROR_TEXT.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function itemToLabel(item:Object):String
{
return itemToString(item, dataFieldPath, labelFunction, formatter);
}
/**
* Convert the specified data provider item to a column-specific datatip String.
*
* This method uses the values dataTipField
* and dataTipFunction.
* If those properties are null, it uses the corresponding properties
* from the associated grid control.
* If dataTipField properties is also null in the grid control,
* then use the dataField property.
If dataTipFunction and dataTipFormatter are
* null, then this method's value is the same as:
* item[dataTipField].toString(). If dataTipFormatter is
* specified then this method's value is the same as:
* dataTipFormatter.format(item[dataTipField])
* If resolving the item's dataField
* causes an error to be thrown, ERROR_TEXT is returned.
If item and dataTipFunction
* are not null, then this method returns
* dataTipFunction(item, this), where the second argument is
* this GridColumn.
grid.dataProvider.getItemAt(rowIndex).
*
* @return A column-specific string for the specified data provider item
* or ERROR_TEXT.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function itemToDataTip(item:Object):String
{
const tipFunction:Function = (dataTipFunction != null) ? dataTipFunction : grid.dataTipFunction;
const tipField:String = (dataTipField) ? dataTipField : grid.dataTipField;
const tipPath:Array = (tipField) ? [tipField] : dataFieldPath;
return itemToString(item, tipPath, tipFunction, dataTipFormatter);
}
/**
* Convert the specified data provider item to a column-specific item renderer factory.
* By default this method calls the itemRendererFunction if it's
* non-null, otherwise it just returns the value of the column's itemRenderer
* property.
*
* @param item The value of grid.dataProvider.getItemAt(rowIndex).
*
* @return A column-specific item renderer factory for the specified dataProvider item.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
public function itemToRenderer(item:Object):IFactory
{
const itemRendererFunction:Function = itemRendererFunction;
return (itemRendererFunction != null) ? itemRendererFunction(item, this) : itemRenderer;
}
/**
* @private
*/
private function dispatchChangeEvent(type:String):void
{
if (hasEventListener(type))
dispatchEvent(new Event(type));
}
/**
* @private
*/
private function invalidateGrid():void
{
if (grid)
{
grid.invalidateSize();
grid.invalidateDisplayList();
}
}
}
}