class GridViewColumn

Creates a new GridViewColumn object with the given arguments.

Manages cell renderers used by this grid view column.

In the following example, the column uses a custom cell renderer class:

column.cellRendererRecycler = DisplayObjectRecycler.withClass(CustomCellRenderer);

See also:

• feathers.controls.GridView.cellRendererRecycler

• feathers.controls.dataRenderers.ItemRenderer

• feathers.controls.dataRenderers.LayoutGroupItemRenderer

Indicates if the column may be sorted by triggering the header renderer, and which direction it should be sorted by default (ascending or descending).

Setting this property will not start a sort. It only provides the initial order of the sort when triggered by the user.

If the sortableColumns property of the GridView is false, it takes precendence over this property, and the column will not be sortable by the user under any circumstances.

The following example disables sorting of a column:

column.defaultSortOrder = SortOrder.NONE;

See also:

• feathers.controls.GridView.sortableColumns

• GridViewColumn.sortCompareFunction

• feathers.data.SortOrder.ASCENDING

• feathers.data.SortOrder.DESCENDING

• feathers.data.SortOrder.NONE

The text to display in the column's header.

In the following example, the column's header text is customized.

column.headerText = "Name";

The minimum width of the column, measured in pixels.

If the width is specified explicitly, then the minWidth will be ignored.

In the following example, the column's minimum width is customized.

column.minWidth = 120.0;

The width of the column, measured in pixels.

In the following example, the column's width is customized.

column.width = 120.0;

When a grid view column requires multiple cell renderer types, this function is used to determine which type of cell renderer is required for a specific item. Returns the ID of the cell renderer recycler to use for the item, or null if the default cellRendererRecycler should be used.

The following example provides an cellRendererRecyclerIDFunction:

var regularItemRecycler = DisplayObjectRecycler.withClass(HierarchicalItemRenderer);
var firstItemRecycler = DisplayObjectRecycler.withClass(MyCustomItemRenderer);
column.setCellRendererRecycler("regular-item", regularItemRecycler);
column.setCellRendererRecycler("first-item", firstItemRecycler);
column.cellRendererRecyclerIDFunction = function(state:GridViewCellState):String {
	if(state.rowIndex == 0) {
		return "first-item";
	}
	return "regular-item";
};

See also:

• GridViewColumn.setCellRendererRecycler()

• `GridViewColumn.itemRendererRecycler

A function to compare each item in the collection to determine the order when sorted.

The return value should be -1 if the first item should appear before the second item when the collection is sorted. The return value should be 1 if the first item should appear after the second item when the collection in sorted. Finally, the return value should be 0 if both items have the same sort order.

See also:

• GridViewColumn.defaultSortOrder

• feathers.controls.GridView.sortableColumns

Returns the item renderer recycler associated with a specific ID. Returns null if no recycler is associated with the ID.

See also:

• GridViewColumn.cellRendererRecyclerIDFunction

• GridViewColumn.setCellRendererRecycler()

Converts an item to text to display within a grid view cell. By default, the toString() method is called to convert an item to text. This method may be replaced to provide custom text.

For example, consider the following item:

{ text: "Example Item" }

If the grid view cell should display the text "Example Item", a custom implementation of itemToText() might look like this:

column.itemToText = (item:Dynamic) -> {
	return item.text;
};

Associates a cell renderer recycler with an ID to allow multiple types of cell renderers may be displayed in the grid view column. A custom cellRendererRecyclerIDFunction may be specified to return the ID of the recycler to use for a specific item in the data provider.

To clear a recycler, pass in null for the value.

See also:

• GridViewColumn.cellRendererRecyclerIDFunction

• GridViewColumn.getCellRendererRecycler()