| Package | com.elfgrid.columns |
| Interface | public interface IElfGridColumn extends flash.events.IEventDispatcher |
| Implementors | ElfBooleanColumn, ElfBooleanIconColumn, ElfButtonColumn, ElfColumnBase, ElfDateColumn, ElfEmptyColumn, ElfLinkButtonColumn, ElfNumberColumn, ElfStringColumn |
| Property | Defined by | ||
|---|---|---|---|
| actualWidth : Number | IElfGridColumn | ||
| cellFactory : IFactory [read-only]
The cell factory is responsible for creating the cells.
| IElfGridColumn | ||
| dataField : String
The name of the field with which to populate the column's data.
| IElfGridColumn | ||
| editable : Boolean [read-only]
If true, items in this column can be edited.
| IElfGridColumn | ||
| editorFactory : IFactory [read-only]
The cell factory is responsible for creating editor cells.
| IElfGridColumn | ||
| enterCommitsCell : Boolean [read-only]
This property determines if the enter key will commit the current value in
an edited cell and move to the next cell below the current.
| IElfGridColumn | ||
| headerCellFactory : IFactory [read-only]
The header cell factory is responsible for creating the header cells.
| IElfGridColumn | ||
| headerData : Object
The data to be given to the header cell.
| IElfGridColumn | ||
| headerTip : String
If
headerTip is set, a toolTip is provided on the header cell to this value. | IElfGridColumn | ||
| maxWidth : Number
The maximum width of the column.
| IElfGridColumn | ||
| minWidth : Number
The minimum width of the column.
| IElfGridColumn | ||
| movable : Boolean [read-only]
If true, the column can be moved to a different column index via user interaction.
| IElfGridColumn | ||
| multiline : Boolean
Whether or not the cells are multiline.
| IElfGridColumn | ||
| multilineHeader : Boolean
Whether or not the header label is multiline.
| IElfGridColumn | ||
| percentWidth : Number
The original percentWidth of the column.
| IElfGridColumn | ||
| preventCellChange : Boolean [read-only]
Whether or not to prevent the tab key and arrow keys to change the selected cell.
| IElfGridColumn | ||
| resizable : Boolean [read-only]
| IElfGridColumn | ||
| selectable : Boolean [read-only]
If true, this column can be selected.
| IElfGridColumn | ||
| sortable : Boolean [read-only]
If true, the column can be sorted via user interaction.
| IElfGridColumn | ||
| sortField : String
The name of the property that sorting this column uses for comparison.
| IElfGridColumn | ||
| visible : Boolean
If false, this column will not be shown and filtered out of the columnsView collection.
| IElfGridColumn | ||
| width : Number
The original width of the column.
| IElfGridColumn | ||
| Method | Defined by | ||
|---|---|---|---|
|
commitValueFunction(rowData:Object, cellItem:IListItemRenderer):Boolean
This takes the value from the editor and commits it to the value object.
| IElfGridColumn | ||
|
createSortField():SortField
When the grid is sorted by this column, this SortField gets used.
| IElfGridColumn | ||
|
getToolTip(rowData:Object):String
Returns a tool tip value to be used when the user's mouse is over the cell with the given
rowData. | IElfGridColumn | ||
|
setCellData(gridItem:IElfGridItem, rowData:Object, cellData:Object):void
Sets the data of an IElfGridItem.
| IElfGridColumn | ||
|
setEditorCellData(editorGridItem:IElfGridItem, rowData:Object):void
Sets the data on the editor cell.
| IElfGridColumn | ||
|
setHeaderCellData(headerGridItem:IElfHeaderGridItem, col:uint):void
Sets the col index of an IElfHeaderGridItem.
| IElfGridColumn | ||
| actualWidth | property |
actualWidth:Number [read-write]Implementation
public function get actualWidth():Number
public function set actualWidth(value:Number):void
| cellFactory | property |
cellFactory:IFactory [read-only]The cell factory is responsible for creating the cells. This factory should create IElfGridItem objects.
Implementation public function get cellFactory():IFactory
| dataField | property |
dataField:String [read-write]The name of the field with which to populate the column's data.
Implementation public function get dataField():String
public function set dataField(value:String):void
| editable | property |
editable:Boolean [read-only]If true, items in this column can be edited. This only affects user events, explicitly setting this column to be edited will still work.
Implementation public function get editable():Boolean
| editorFactory | property |
editorFactory:IFactory [read-only]The cell factory is responsible for creating editor cells. This factory should create IElfGridItem objects.
Implementation public function get editorFactory():IFactory
| enterCommitsCell | property |
enterCommitsCell:Boolean [read-only]This property determines if the enter key will commit the current value in an edited cell and move to the next cell below the current. If this property is not set, we will default it to whatever the multiline property is.
Implementation public function get enterCommitsCell():Boolean
| headerCellFactory | property |
headerCellFactory:IFactory [read-only]The header cell factory is responsible for creating the header cells. This factory should create IElfHeaderGridItem objects.
Implementation public function get headerCellFactory():IFactory
| headerData | property |
headerData:Object [read-write]The data to be given to the header cell.
Implementation public function get headerData():Object
public function set headerData(value:Object):void
| headerTip | property |
headerTip:String [read-write]
If headerTip is set, a toolTip is provided on the header cell to this value.
public function get headerTip():String
public function set headerTip(value:String):void
| maxWidth | property |
maxWidth:Number [read-write]The maximum width of the column. This property is optional.
Implementation public function get maxWidth():Number
public function set maxWidth(value:Number):void
| minWidth | property |
minWidth:Number [read-write]The minimum width of the column. This should not be NaN or < 0.
Implementation public function get minWidth():Number
public function set minWidth(value:Number):void
| movable | property |
movable:Boolean [read-only]If true, the column can be moved to a different column index via user interaction.
Implementation public function get movable():Boolean
| multiline | property |
multiline:Boolean [read-write]Whether or not the cells are multiline. If a column is multiline, its width cannot be auto-determined.
Implementation public function get multiline():Boolean
public function set multiline(value:Boolean):void
| multilineHeader | property |
multilineHeader:Boolean [read-write]Whether or not the header label is multiline. If this is true, consider increasing minWidth to avoid broken words.
Implementation public function get multilineHeader():Boolean
public function set multilineHeader(value:Boolean):void
| percentWidth | property |
percentWidth:Number [read-write]The original percentWidth of the column.
Implementation public function get percentWidth():Number
public function set percentWidth(value:Number):void
| preventCellChange | property |
preventCellChange:Boolean [read-only]Whether or not to prevent the tab key and arrow keys to change the selected cell.
Implementation public function get preventCellChange():Boolean
| resizable | property |
resizable:Boolean [read-only]Implementation
public function get resizable():Boolean
| selectable | property |
selectable:Boolean [read-only]If true, this column can be selected. If false, tab and keyboard selection changes will pass over this column. This only affects user events, explicitly setting this column to be selected will still work.
Implementation public function get selectable():Boolean
See also
| sortable | property |
sortable:Boolean [read-only]If true, the column can be sorted via user interaction.
Implementation public function get sortable():Boolean
| sortField | property |
sortField:String [read-write]The name of the property that sorting this column uses for comparison. If not set, dataField is used.
Implementation public function get sortField():String
public function set sortField(value:String):void
| visible | property |
visible:Boolean [read-write]If false, this column will not be shown and filtered out of the columnsView collection.
Implementation public function get visible():Boolean
public function set visible(value:Boolean):void
| width | property |
width:Number [read-write]The original width of the column.
Implementation public function get width():Number
public function set width(value:Number):void
| commitValueFunction | () | method |
public function commitValueFunction(rowData:Object, cellItem:IListItemRenderer):BooleanThis takes the value from the editor and commits it to the value object. If the value is invalid, return false.
ParametersrowData:Object |
|
cellItem:IListItemRenderer |
Boolean |
| createSortField | () | method |
public function createSortField():SortFieldWhen the grid is sorted by this column, this SortField gets used.
ReturnsSortField |
| getToolTip | () | method |
public function getToolTip(rowData:Object):String
Returns a tool tip value to be used when the user's mouse is over the cell with the given rowData.
rowData:Object |
String |
| setCellData | () | method |
public function setCellData(gridItem:IElfGridItem, rowData:Object, cellData:Object):voidSets the data of an IElfGridItem.
ParametersgridItem:IElfGridItem — A recycled cell in the grid.
|
|
rowData:Object — The element of the grid's dataProvider,
This function should be able to handle an empty cell, where rowData is null.
|
|
cellData:Object |
| setEditorCellData | () | method |
public function setEditorCellData(editorGridItem:IElfGridItem, rowData:Object):voidSets the data on the editor cell.
ParameterseditorGridItem:IElfGridItem |
|
rowData:Object |
| setHeaderCellData | () | method |
public function setHeaderCellData(headerGridItem:IElfHeaderGridItem, col:uint):voidSets the col index of an IElfHeaderGridItem. This allows you to change styling on different columns on recycled elf header grid items.
ParametersheaderGridItem:IElfHeaderGridItem |
|
col:uint |