Package: | Ext.grid |
Class: | ColumnModel |
Extends: | Observable |
Defined In: | ColumnModel.js |
var colModel = new Ext.grid.ColumnModel([
{header: "Ticker", width: 60, sortable: true, locked: 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 listed for this class are options which may appear in each individual column definition.
Property | Defined By | |
---|---|---|
config : Object | ColumnModel | |
The config passed into the constructor | ||
defaultSortable : Boolean | ColumnModel | |
Default sortable of columns which have no sortable specified (defaults to false) | ||
defaultWidth : Number | ColumnModel | |
The width of columns which have no width specified (defaults to 100) |
Method | Defined By | |
---|---|---|
ColumnModel( Object config ) |
ColumnModel | |
addEvents( Object object ) : void |
Observable | |
Used to define events on this Observable | ||
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable | |
Appends an event handler to this component | ||
fireEvent( String eventName , Object... args ) : Boolean |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
getCellEditor( Number colIndex , Number rowIndex ) : Object |
ColumnModel | |
Returns the editor defined for the cell/column. | ||
getColumnById( String id ) : Object |
ColumnModel | |
Returns the column for a specified id. | ||
getColumnCount() : Number | ColumnModel | |
Returns the number of columns. | ||
getColumnHeader( Number col ) : String |
ColumnModel | |
Returns the header for the specified column. | ||
getColumnId( Number index ) : String |
ColumnModel | |
Returns the id of the column at the specified index. | ||
getColumnTooltip( Number col ) : String |
ColumnModel | |
Returns the tooltip for the specified column. | ||
getColumnWidth( Number col ) : Number |
ColumnModel | |
Returns the width for the specified column. | ||
getColumnsBy( Function fn , [Object scope ] ) : Array |
ColumnModel | |
Returns the column configs that return true by the passed function that is called with (columnConfig, index) | ||
getDataIndex( Number col ) : Number |
ColumnModel | |
Returns the dataIndex for the specified column. | ||
getIndexById( String id ) : Number |
ColumnModel | |
Returns the index for a specified column id. | ||
getRenderer( Number col ) : Function |
ColumnModel | |
Returns the rendering (formatting) function defined for the column. | ||
getTotalWidth( Boolean includeHidden ) : Number |
ColumnModel | |
Returns the total width of all columns. | ||
hasListener( String eventName ) : Boolean |
Observable | |
Checks to see if this object has any listeners for a specified event | ||
isCellEditable( Number colIndex , Number rowIndex ) : Boolean |
ColumnModel | |
Returns true if the cell is editable. | ||
isFixed() : void | ColumnModel | |
Returns true if the column width cannot be changed | ||
isHidden( Number colIndex ) : Boolean |
ColumnModel | |
Returns true if the column is hidden. | ||
isResizable() : Boolean | ColumnModel | |
Returns true if the column can be resized | ||
isSortable( Number col ) : Boolean |
ColumnModel | |
Returns true if the specified column is sortable. | ||
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable | |
Appends an event handler to this element (shorthand for addListener) | ||
purgeListeners() : void | Observable | |
Removes all listeners for this object | ||
removeListener( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener | ||
setColumnHeader( Number col , String header ) : void |
ColumnModel | |
Sets the header for a column. | ||
setColumnTooltip( Number col , String tooltip ) : void |
ColumnModel | |
Sets the tooltip for a column. | ||
setColumnWidth( Number col , Number width ) : void |
ColumnModel | |
Sets the width for a column. | ||
setDataIndex( Number col , Number dataIndex ) : void |
ColumnModel | |
Sets the dataIndex for a column. | ||
setEditable( Number col , Boolean editable ) : void |
ColumnModel | |
Sets if a column is editable. | ||
setEditor( Number col , Object editor ) : void |
ColumnModel | |
Sets the editor for a column. | ||
setHidden( Number colIndex , Boolean hidden ) : void |
ColumnModel | |
Sets if a column is hidden. | ||
setRenderer( Number col , Function fn ) : void |
ColumnModel | |
Sets the rendering (formatting) function for a column. | ||
un( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener (shorthand for removeListener) |
Event | Defined By | |
---|---|---|
columlockchange : ( ColumnModel this , Number colIndex , Boolean locked ) |
ColumnModel | |
Fires when a column's locked state is changed | ||
columnmoved : ( ColumnModel this , Number oldIndex , Number newIndex ) |
ColumnModel | |
Fires when a column is moved. | ||
headerchange : ( ColumnModel this , Number columnIndex , Number newText ) |
ColumnModel | |
Fires when the text of a header changes. | ||
hiddenchange : ( ColumnModel this , Number columnIndex , Boolean hidden ) |
ColumnModel | |
Fires when a column is hidden or "unhidden". | ||
widthchange : ( ColumnModel this , Number columnIndex , Number newWidth ) |
ColumnModel | |
Fires when the width of a column changes. |
Config Options | Defined By | |
---|---|---|
align : String | ColumnModel | |
(Optional) Set the CSS text-align property of the column. Defaults to undefined. | ||
dataIndex : String | ColumnModel | |
(Optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the col... | ||
header : String | ColumnModel | |
The header text to display in the Grid view. | ||
hidden : Boolean | ColumnModel | |
(Optional) True to hide the column. Defaults to false. | ||
locked : Boolean | ColumnModel | |
(Optional) True to lock the column in place while scrolling the Grid. Defaults to false. | ||
renderer : Function | ColumnModel | |
(Optional) A function used to generate HTML markup for a cell given the cell's data value. See setRenderer. If not sp... | ||
resizable : Boolean | ColumnModel | |
(Optional) False to disable column resizing. Defaults to true. | ||
sortable : Boolean | ColumnModel | |
(Optional) True if sorting is to be allowed on this column. Defaults to true. Whether local/remote sorting is used is... | ||
width : Number | ColumnModel | |
(Optional) The initial width in pixels of the column. Using this instead of Ext.grid.Grid.autoSizeColumns is more eff... |
public Object config
public Boolean defaultSortable
public Number defaultWidth
public function ColumnModel( Object config
)
config
: Objectpublic function addEvents( Object object
)
object
: Objectvoid
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, {
single: true,
delay: 100,
forumId: 4
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
el.on({
'click': {
fn: this.onClick,
scope: this,
delay: 100
},
'mouseover': {
fn: this.onMouseOver,
scope: this
},
'mouseout': {
fn: this.onMouseOut,
scope: this
}
});
Or a shorthand syntax which passes the same scope object to all handlers:
el.on({
'click': this.onClick,
'mouseover': this.onMouseOver,
'mouseout': this.onMouseOut,
scope: this
});
void
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function getCellEditor( Number colIndex
, Number rowIndex
)
colIndex
: NumberrowIndex
: NumberObject
public function getColumnById( String id
)
id
: StringObject
public function getColumnCount()
Number
public function getColumnHeader( Number col
)
col
: NumberString
public function getColumnId( Number index
)
index
: NumberString
public function getColumnTooltip( Number col
)
col
: NumberString
public function getColumnWidth( Number col
)
col
: NumberNumber
public function getColumnsBy( Function fn
, [Object scope
] )
fn
: Functionscope
: ObjectArray
public function getDataIndex( Number col
)
col
: NumberNumber
public function getIndexById( String id
)
id
: StringNumber
public function getRenderer( Number col
)
col
: NumberFunction
public function getTotalWidth( Boolean includeHidden
)
includeHidden
: BooleanNumber
public function hasListener( String eventName
)
eventName
: StringBoolean
public function isCellEditable( Number colIndex
, Number rowIndex
)
colIndex
: NumberrowIndex
: NumberBoolean
public function isFixed()
void
public function isHidden( Number colIndex
)
colIndex
: NumberBoolean
public function isResizable()
Boolean
public function isSortable( Number col
)
col
: NumberBoolean
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Objectvoid
public function purgeListeners()
void
public function removeListener( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function setColumnHeader( Number col
, String header
)
col
: Numberheader
: Stringvoid
public function setColumnTooltip( Number col
, String tooltip
)
col
: Numbertooltip
: Stringvoid
public function setColumnWidth( Number col
, Number width
)
col
: Numberwidth
: Numbervoid
public function setDataIndex( Number col
, Number dataIndex
)
col
: NumberdataIndex
: Numbervoid
public function setEditable( Number col
, Boolean editable
)
col
: Numbereditable
: Booleanvoid
public function setEditor( Number col
, Object editor
)
col
: Numbereditor
: Objectvoid
public function setHidden( Number colIndex
, Boolean hidden
)
colIndex
: Numberhidden
: Booleanvoid
public function setRenderer( Number col
, Function fn
)
col
: Numberfn
: Functionvoid
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public event columlockchange
this
: ColumnModelcolIndex
: Numberlocked
: Booleanpublic event columnmoved
this
: ColumnModeloldIndex
: NumbernewIndex
: Numberpublic event headerchange
this
: ColumnModelcolumnIndex
: NumbernewText
: Numberpublic event hiddenchange
this
: ColumnModelcolumnIndex
: Numberhidden
: Booleanpublic event widthchange
this
: ColumnModelcolumnIndex
: NumbernewWidth
: Numberalign : String
dataIndex : String
header : String
hidden : Boolean
locked : Boolean
renderer : Function
resizable : Boolean
sortable : Boolean
width : Number