| Package | com.elfgrid.columns |
| Class | public class ElfButtonColumn |
| Inheritance | ElfButtonColumn  ElfColumnBase com.nbilyk.display.CSSComponent |
| Implements | IElfGridColumn |
| Subclasses | ElfLinkButtonColumn |
| Property | Defined by | ||
|---|---|---|---|
| caseInsensitiveSorting : Boolean = true | ElfButtonColumn | ||
 | cellFactory : IFactory
The cell factory is responsible for creating the cells.
| ElfColumnBase | |
| dataField : String
The name of the field with which to populate the column's data.
| ElfColumnBase | |
| editable : Boolean
If true, items in this column can be edited.
| ElfColumnBase | |
| editorFactory : IFactory
The cell factory is responsible for creating editor cells.
| ElfColumnBase | |
| enterCommitsCell : Boolean
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.
| ElfColumnBase | |
| focusOnColumnSelect : Boolean = true | ElfButtonColumn | ||
| focusOnRowSelect : Boolean = true | ElfButtonColumn | ||
| headerCellFactory : IFactory
The header cell factory is responsible for creating the header cells.
| ElfColumnBase | |
| headerData : Object
The data to be given to the header cell.
| ElfColumnBase | |
| headerText : String
The text to be given to the header cell.
| ElfColumnBase | |
| headerTip : String
If
headerTip is set, a toolTip is provided on the header cell to this value. | ElfColumnBase | |
| labelFunction : Function
labelFunction follows the signature: labelFunction(rowData:Object, column:IElfGridColumn):String
| ElfColumnBase | |
| maxWidth : Number
The maximum width of the column.
| ElfColumnBase | |
| minRowHeight : Number
The minimum row height of item renderers from this column.
| ElfColumnBase | |
| minWidth : Number
The minimum width of the column.
| ElfColumnBase | |
| movable : Boolean
Whether or not this column can be moved by the user.
| ElfColumnBase | |
| multiline : Boolean
If true, the Text created for cellItem will be multiline.
| ElfColumnBase | |
| multilineHeader : Boolean
Whether or not the header label is multiline.
| ElfColumnBase | |
| percentWidth : Number
The percent width of this column.
| ElfColumnBase | |
| preventCellChange : Boolean
Whether or not to prevent the tab key and arrow keys to change the selected cell.
| ElfColumnBase | |
| resizable : Boolean
Whether or not this column can be resized by the user.
| ElfColumnBase | |
| selectable : Boolean
If true, this column can be selected.
| ElfColumnBase | |
| selectableHeaderText : Boolean
If true, the text in the header can be selected.
| ElfColumnBase | |
| selectableText : Boolean
If true, the text can be selected.
| ElfColumnBase | |
| sortable : Boolean
Whether or not this column can be sorted by the user.
| ElfColumnBase | |
| sortCaseInsensitive : Boolean | ElfColumnBase | |
| sortCompareFunction : Function | ElfColumnBase | |
| sortDescending : Boolean
If true, when the column is first sorted, instead of being sorted ascending
(lowest value at the top, highest value on the bottom), the column is sorted descending.
| ElfColumnBase | |
| sortField : String
The name of the property that sorting this column uses for comparison.
| ElfColumnBase | |
| sortNumeric : Object | ElfColumnBase | |
| tipField : String
If you wish for a tool tip on the cell, set either
tipField or tipFunction
| ElfColumnBase | |
| tipFunction : Function
If you wish for a tool tip on the cell, set either
tipField or tipFunction
tipFunction follows the signature: tipFunction(rowData:Object, column:IElfGridColumn):String
| ElfColumnBase | |
| toolTip : String
If set, this writes the tipFunction to be just a method that always returns
toolTip. | ElfColumnBase | |
| truncateToFit : Boolean
If true, text that doesn't fit in a cell will be truncated with a ...
| ElfColumnBase | |
| truncateToFitHeader : Boolean = true
If true, text that doesn't fit in the header cell will be truncated with a ...
| ElfColumnBase | |
| visible : Boolean | ElfColumnBase | |
| width : Number
The width of the column.
| ElfColumnBase | |
| Method | Defined by | ||
|---|---|---|---|
| ElfButtonColumn | |||
|
commitValueFunction(rowData:Object, cellItem:IListItemRenderer):Boolean
| ElfButtonColumn | ||
|
createSortField():SortField
When the grid is sorted by this column, this SortField gets used in sorting the grid.
| ElfColumnBase | |
|
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. | ElfColumnBase | |
|
setCellData(gridItem:IElfGridItem, rowData:Object, cellData:Object):void
| ElfButtonColumn | ||
|
setEditorCellData(editorGridItem:IElfGridItem, rowData:Object):void
| ElfButtonColumn | ||
|
setHeaderCellData(gridItem:IElfHeaderGridItem, col:uint):void
Sets the col index of an IElfHeaderGridItem.
| ElfColumnBase | |
|
toString():String
| ElfColumnBase | |
|
validateCellItem(rowData:Object, cellItem:IListItemRenderer):ValidationResultEvent
| ElfColumnBase | |
| Method | Defined by | ||
|---|---|---|---|
|
cellButtonClickHandler(event:MouseEvent):void
| ElfButtonColumn | ||
|
createButton():Button
| ElfButtonColumn | ||
| ElfButtonColumn | |||
| ElfButtonColumn | |||
|
| ElfColumnBase | |
|
formatData(value:Object):String
No special formatting by default.
| ElfColumnBase | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| ElfButtonColumn | ||||
| ElfColumnBase | |||
| caseInsensitiveSorting | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var caseInsensitiveSorting:Boolean = true
| focusOnColumnSelect | property |
public var focusOnColumnSelect:Boolean = true
| focusOnRowSelect | property |
public var focusOnRowSelect:Boolean = true
| ElfButtonColumn | () | constructor |
public function ElfButtonColumn()
| cellButtonClickHandler | () | method |
protected function cellButtonClickHandler(event:MouseEvent):voidParameters
event:MouseEvent |
| commitValueFunction | () | method |
public override function commitValueFunction(rowData:Object, cellItem:IListItemRenderer):BooleanParameters
rowData:Object |
|
cellItem:IListItemRenderer |
Boolean |
| createButton | () | method |
protected function createButton():Button
Returns
Button |
| createCell | () | method |
| createEditorCell | () | method |
| setCellData | () | method |
public override function setCellData(gridItem:IElfGridItem, rowData:Object, cellData:Object):voidParameters
gridItem:IElfGridItem |
|
rowData:Object |
|
cellData:Object |
| setEditorCellData | () | method |
public override function setEditorCellData(editorGridItem:IElfGridItem, rowData:Object):voidParameters
editorGridItem:IElfGridItem |
|
rowData:Object |
| click | event |