Observable ColumnModel
Package: | Ext.grid |
Defined In: | ColumnModel.js |
Class: | ColumnModel |
Subclasses: | PropertyColumnModel |
Extends: | Observable |
var colModel = new Ext.grid.ColumnModel([
{header: "Ticker", width: 60, sortable: true},
{header: "Company Name", width: 150, sortable: true},
{header: "Market Cap.", width: 100, sortable: true},
{header: "$ Sales", width: 100, sortable: true, renderer: money},
{header: "Employees", width: 100, sortable: true, resizable: false}
]);
The config options defined by
Config Options | Defined By | |
---|---|---|
align : String
(optional) Set the CSS text-align property of the column. Defaults to undefined.
|
ColumnModel | |
css : String
(optional) Set custom CSS for all table cells in the column (excluding headers). Defaults to undefined.
|
ColumnModel | |
dataIndex : String (optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the col...
(optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the column's value. If not specified, the column's index is used as an index into the Record's data Array.
|
ColumnModel | |
editor : Ext.form.Field
(optional) The Ext.form.Field to use when editing values in this column if editing is supported by the grid.
|
ColumnModel | |
fixed : Boolean
(optional) True if the column width cannot be changed. Defaults to false.
|
ColumnModel | |
header : String
The header text to display in the Grid view.
|
ColumnModel | |
(optional) True to hide the column. Defaults to false.
|
hidden : Boolean ColumnModel | |
hideable : Boolean (optional) Specify as false to prevent the user from hiding this column (defaults to true). To disallow column hiding...
(optional) Specify as false to prevent the user from hiding this column (defaults to true). To disallow column hiding globally for all columns in the grid, use Ext.grid.GridPanel.enableColumnHide instead.
|
ColumnModel | |
id : String (optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to ...
(optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to create a CSS class name which is applied to all table cells (including headers) in that column. The class name takes the form of
x-grid3-td-id Header cells will also recieve this class name, but will also have the class .x-grid3-hd.x-grid3-td-idThe Ext.grid.GridPanel.autoExpandColumn grid config option references the column via this identifier. |
ColumnModel | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
|
Observable | |
menuDisabled : Boolean
(optional) True to disable the column menu. Defaults to false.
|
ColumnModel | |
renderer : Function (optional) A function used to generate HTML markup for a cell given the cell's data value. See setRenderer. If not sp...
(optional) A function used to generate HTML markup for a cell given the cell's data value. See setRenderer. If not specified, the default renderer uses the raw data value.
|
ColumnModel | |
resizable : Boolean
(optional) False to disable column resizing. Defaults to true.
|
ColumnModel | |
sortable : Boolean (optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Wh...
(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.
|
ColumnModel | |
tooltip : String (optional) A text string to use as the column header's tooltip. If Quicktips are enabled, this value will be used as ...
(optional) A text string to use as the column header's tooltip. If Quicktips are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the header's HTML title attribute. Defaults to ''.
|
ColumnModel | |
width : Number
(optional) The initial width in pixels of the column.
|
ColumnModel |
Method | Defined By | |
---|---|---|
ColumnModel( Object config )
Parameters:
|
ColumnModel | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
findColumnIndex( String col ) : Number Finds the index of the first matching column for the given dataIndex.
Finds the index of the first matching column for the given dataIndex.
Parameters:
|
ColumnModel | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
getCellEditor( Number colIndex , Number rowIndex ) : Object Returns the editor defined for the cell/column.
Returns the editor defined for the cell/column.
Parameters:
|
ColumnModel | |
getColumnById( String id ) : Object Returns the column for a specified id.
Returns the column for a specified id.
Parameters:
|
ColumnModel | |
getColumnCount() : Number Returns the number of columns.
Returns the number of columns.
Parameters:
|
ColumnModel | |
getColumnHeader( Number col ) : String Returns the header for the specified column.
Returns the header for the specified column.
Parameters:
|
ColumnModel | |
getColumnId( Number index ) : String
Returns the id of the column at the specified index.
Returns the id of the column at the specified index.
Parameters:
|
ColumnModel | |
getColumnTooltip( Number col ) : String Returns the tooltip for the specified column.
Returns the tooltip for the specified column.
Parameters:
|
ColumnModel | |
getColumnWidth( Number col ) : Number Returns the width for the specified column.
Returns the width for the specified column.
Parameters:
|
ColumnModel | |
getColumnsBy( Function fn , [Object scope ] ) : Array Returns the column configs that return true by the passed function that is called with (columnConfig, index)
Returns the column configs that return true by the passed function that is called with (columnConfig, index)
Parameters:
|
ColumnModel | |
getDataIndex( Number col ) : String Returns the dataIndex for the specified column.
Returns the dataIndex for the specified column.
Parameters:
|
ColumnModel | |
getIndexById( String id ) : Number Returns the index for a specified column id.
Returns the index for a specified column id.
Parameters:
|
ColumnModel | |
getRenderer( Number col ) : Function Returns the rendering (formatting) function defined for the column.
Returns the rendering (formatting) function defined for the column.
Parameters:
|
ColumnModel | |
getTotalWidth( Boolean includeHidden ) : Number Returns the total width of all columns.
Returns the total width of all columns.
Parameters:
|
ColumnModel | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
Parameters:
|
Observable | |
isCellEditable( Number colIndex , Number rowIndex ) : Boolean Returns true if the cell is editable.
Returns true if the cell is editable.
Parameters:
|
ColumnModel | |
isFixed() : void Returns true if the column width cannot be changed
Returns true if the column width cannot be changed
Parameters:
|
ColumnModel | |
isHidden( Number colIndex ) : Boolean Returns true if the column is hidden.
Returns true if the column is hidden.
Parameters:
|
ColumnModel | |
isMenuDisabled( Number col ) : Boolean Returns true if the specified column menu is disabled.
Returns true if the specified column menu is disabled.
Parameters:
|
ColumnModel | |
isResizable() : Boolean Returns true if the column can be resized
Returns true if the column can be resized
Parameters:
|
ColumnModel | |
isSortable( Number col ) : Boolean Returns true if the specified column is sortable.
Returns true if the specified column is sortable.
Parameters:
|
ColumnModel | |
moveColumn( Number oldIndex , Number newIndex ) : void Moves a column from one position to another.
Moves a column from one position to another.
Parameters:
|
ColumnModel | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
Observable | |
relayEvents( Object o , Array events ) : void Relays selected events from the specified Observable as if the events were fired by this.
Relays selected events from the specified Observable as if the events were fired by this.
Parameters:
|
Observable | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
setColumnHeader( Number col , String header ) : void Sets the header for a column.
Sets the header for a column.
Parameters:
|
ColumnModel | |
setColumnTooltip( Number col , String tooltip ) : void Sets the tooltip for a column.
Sets the tooltip for a column.
Parameters:
|
ColumnModel | |
setColumnWidth( Number col , Number width ) : void Sets the width for a column.
Sets the width for a column.
Parameters:
|
ColumnModel | |
setConfig( Array config ) : void Reconfigures this column model
Reconfigures this column model
Parameters:
|
ColumnModel | |
setDataIndex( Number col , String dataIndex ) : void Sets the dataIndex for a column.
Sets the dataIndex for a column.
Parameters:
|
ColumnModel | |
setEditable( Number col , Boolean editable ) : void Sets if a column is editable.
Sets if a column is editable.
Parameters:
|
ColumnModel | |
setEditor( Number col , Object editor ) : void Sets the editor for a column.
Sets the editor for a column.
Parameters:
|
ColumnModel | |
setHidden( Number colIndex , Boolean hidden ) : void Sets if a column is hidden.
Sets if a column is hidden.
Parameters:
|
ColumnModel | |
setRenderer( Number col , Function fn ) : void Sets the rendering (formatting) function for a column. See Ext.util.Format for some
default formatting functions.
Sets the rendering (formatting) function for a column. See Ext.util.Format for some
default formatting functions.
Parameters:
|
ColumnModel | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
Observable | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable |