Class YAHOO.ext.grid.DefaultColumnModel

Object
   |
   +--YAHOO.ext.grid.AbstractColumnModel
         |
         +--YAHOO.ext.grid.DefaultColumnModel

class YAHOO.ext.grid.DefaultColumnModel

extends YAHOO.ext.grid.AbstractColumnModel

This is the default implementation of a ColumnModel used by the Grid. It defines the columns in the grid.
Usage:

 var sort = YAHOO.ext.grid.DefaultColumnModel.sortTypes;
 var myColumns = [
	{header: "Ticker", width: 60, sortable: true, sortType: sort.asUCString}, 
	{header: "Company Name", width: 150, sortable: true, sortType: sort.asUCString}, 
	{header: "Market Cap.", width: 100, sortable: true, sortType: sort.asFloat}, 
	{header: "$ Sales", width: 100, sortable: true, sortType: sort.asFloat, renderer: money}, 
	{header: "Employees", width: 100, sortable: true, sortType: sort.asFloat}
 ];
 var colModel = new YAHOO.ext.grid.DefaultColumnModel(myColumns);
 

Field Detail

config

Object config

The config passed into the constructor

defaultSortable

Boolean defaultSortable

Default sortable of columns which have no sortable specified (defaults to false)

defaultWidth

Number defaultWidth

The width of columns which have no width specified (defaults to 100)

sortTypes

<static> Object sortTypes

Defines the default sorting (casting?) comparison functions used when sorting data:
  sortTypes.none - sorts data as it is without casting or parsing (the default)
  sortTypes.asUCString - case insensitive string
  sortTypes.asDate - attempts to parse data as a date
  sortTypes.asFloat
  sortTypes.asInt

YAHOO.ext.grid.DefaultColumnModel

YAHOO.ext.grid.DefaultColumnModel(config)

getCellEditor

Object getCellEditor(<Number> colIndex, <Number> rowIndex)

Returns the editor defined for the cell/column.

Parameters:
colIndex - The column index
rowIndex - The row index

getColumnCount

Number getColumnCount()

Returns the number of columns.

getColumnHeader

String getColumnHeader(<Number> col)

Returns the header for the specified column.

Parameters:
col - The column index

getColumnWidth

Number getColumnWidth(<Number> col)

Returns the width for the specified column.

Parameters:
col - The column index

getDataIndex

Number getDataIndex(<Number> col)

Returns the dataIndex for the specified column.

Parameters:
col - The column index

getRenderer

Function getRenderer(<Number> col)

Returns the rendering (formatting) function defined for the column.

Parameters:
col - The column index

getSortType

Function getSortType(<Number> col)

Returns the sorting comparison function defined for the column (defaults to sortTypes.none).

Parameters:
col - The column index

getTotalWidth

Number getTotalWidth(<Boolean> includeHidden)

Returns the total width of all columns.

Parameters:
includeHidden - True to include hidden column widths

isCellEditable

Boolean isCellEditable(<Number> colIndex, <Number> rowIndex)

Returns true if the cell is editable.

Parameters:
colIndex - The column index
rowIndex - The row index

isHidden

Boolean isHidden(<Number> colIndex)

Returns true if the column is hidden.

Parameters:
colIndex - The column index

isSortable

Boolean isSortable(<Number> col)

Returns true if the specified column is sortable.

Parameters:
col - The column index

setColumnHeader

void setColumnHeader(<Number> col, <String> header)

Sets the header for a column.

Parameters:
col - The column index
header - The new header

setColumnWidth

void setColumnWidth(<Number> col, <Number> width, suppressEvent)

Sets the width for a column.

Parameters:
col - The column index
width - The new width

setDataIndex

void setDataIndex(<Number> col, <Number> dataIndex)

Sets the dataIndex for a column.

Parameters:
col - The column index
dataIndex - The new dataIndex

setEditable

void setEditable(<Number> col, <Boolean> editable)

Sets if a column is editable.

Parameters:
col - The column index
editable - True if the column is editable

setEditor

void setEditor(<Number> col, <Object> editor)

Sets the editor for a column.

Parameters:
col - The column index
editor - The editor object

setHidden

void setHidden(<Number> colIndex, hidden)

Sets if a column is hidden.

Parameters:
colIndex - The column index

setRenderer

void setRenderer(<Number> col, <Function> fn)

Sets the rendering (formatting) function for a column.

Parameters:
col - The column index
fn -

setSortType

void setSortType(<Number> col, <Function> fn)

Sets the sorting comparison function for a column.

Parameters:
col - The column index
fn -

defaultRenderer

<static> Object defaultRenderer(value)

Default empty rendering function