3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.grid.ColumnModel
9 * @extends Ext.util.Observable
10 * <p>After the data has been read into the client side cache (<b>{@link Ext.data.Store Store}</b>),
11 * the ColumnModel is used to configure how and what parts of that data will be displayed in the
12 * vertical slices (columns) of the grid. The Ext.grid.ColumnModel Class is the default implementation
13 * of a ColumnModel used by implentations of {@link Ext.grid.GridPanel GridPanel}.</p>
14 * <p>Data is mapped into the store's records and then indexed into the ColumnModel using the
15 * <tt>{@link Ext.grid.Column#dataIndex dataIndex}</tt>:</p>
17 {data source} == mapping ==> {data store} == <b><tt>{@link Ext.grid.Column#dataIndex dataIndex}</tt></b> ==> {ColumnModel}
19 * <p>Each {@link Ext.grid.Column Column} in the grid's ColumnModel is configured with a
20 * <tt>{@link Ext.grid.Column#dataIndex dataIndex}</tt> to specify how the data within
21 * each record in the store is indexed into the ColumnModel.</p>
22 * <p>There are two ways to initialize the ColumnModel class:</p>
23 * <p><u>Initialization Method 1: an Array</u></p>
25 var colModel = new Ext.grid.ColumnModel([
26 { header: "Ticker", width: 60, sortable: true},
27 { header: "Company Name", width: 150, sortable: true, id: 'company'},
28 { header: "Market Cap.", width: 100, sortable: true},
29 { header: "$ Sales", width: 100, sortable: true, renderer: money},
30 { header: "Employees", width: 100, sortable: true, resizable: false}
33 * <p>The ColumnModel may be initialized with an Array of {@link Ext.grid.Column} column configuration
34 * objects to define the initial layout / display of the columns in the Grid. The order of each
35 * {@link Ext.grid.Column} column configuration object within the specified Array defines the initial
36 * order of the column display. A Column's display may be initially hidden using the
37 * <tt>{@link Ext.grid.Column#hidden hidden}</tt></b> config property (and then shown using the column
38 * header menu). Fields that are not included in the ColumnModel will not be displayable at all.</p>
39 * <p>How each column in the grid correlates (maps) to the {@link Ext.data.Record} field in the
40 * {@link Ext.data.Store Store} the column draws its data from is configured through the
41 * <b><tt>{@link Ext.grid.Column#dataIndex dataIndex}</tt></b>. If the
42 * <b><tt>{@link Ext.grid.Column#dataIndex dataIndex}</tt></b> is not explicitly defined (as shown in the
43 * example above) it will use the column configuration's index in the Array as the index.</p>
44 * <p>See <b><tt>{@link Ext.grid.Column}</tt></b> for additional configuration options for each column.</p>
45 * <p><u>Initialization Method 2: an Object</u></p>
46 * <p>In order to use configuration options from <tt>Ext.grid.ColumnModel</tt>, an Object may be used to
47 * initialize the ColumnModel. The column configuration Array will be specified in the <tt><b>{@link #columns}</b></tt>
48 * config property. The <tt><b>{@link #defaults}</b></tt> config property can be used to apply defaults
49 * for all columns, e.g.:</p><pre><code>
50 var colModel = new Ext.grid.ColumnModel({
52 { header: "Ticker", width: 60, menuDisabled: false},
53 { header: "Company Name", width: 150, id: 'company'},
54 { header: "Market Cap."},
55 { header: "$ Sales", renderer: money},
56 { header: "Employees", resizable: false}
64 {@link #hiddenchange}: function(cm, colIndex, hidden) {
65 saveConfig(colIndex, hidden);
70 * <p>In both examples above, the ability to apply a CSS class to all cells in a column (including the
71 * header) is demonstrated through the use of the <b><tt>{@link Ext.grid.Column#id id}</tt></b> config
72 * option. This column could be styled by including the following css:</p><pre><code>
73 //add this css *after* the core css is loaded
75 color: red; // entire column will have red font
77 // modify the header row only, adding an icon to the column header
79 background: transparent
80 url(../../resources/images/icons/silk/building.png)
81 no-repeat 3px 3px ! important;
85 * Note that the "Company Name" column could be specified as the
86 * <b><tt>{@link Ext.grid.GridPanel}.{@link Ext.grid.GridPanel#autoExpandColumn autoExpandColumn}</tt></b>.
88 * @param {Mixed} config Specify either an Array of {@link Ext.grid.Column} configuration objects or specify
89 * a configuration Object (see introductory section discussion utilizing Initialization Method 2 above).
91 Ext.grid.ColumnModel = Ext.extend(Ext.util.Observable, {
93 * @cfg {Number} defaultWidth (optional) The width of columns which have no <tt>{@link #width}</tt>
94 * specified (defaults to <tt>100</tt>). This property shall preferably be configured through the
95 * <tt><b>{@link #defaults}</b></tt> config property.
99 * @cfg {Boolean} defaultSortable (optional) Default sortable of columns which have no
100 * sortable specified (defaults to <tt>false</tt>). This property shall preferably be configured
101 * through the <tt><b>{@link #defaults}</b></tt> config property.
103 defaultSortable: false,
105 * @cfg {Array} columns An Array of object literals. The config options defined by
106 * <b>{@link Ext.grid.Column}</b> are the options which may appear in the object literal for each
107 * individual column definition.
110 * @cfg {Object} defaults Object literal which will be used to apply {@link Ext.grid.Column}
111 * configuration options to all <tt><b>{@link #columns}</b></tt>. Configuration options specified with
112 * individual {@link Ext.grid.Column column} configs will supersede these <tt><b>{@link #defaults}</b></tt>.
115 constructor : function(config){
117 * An Array of {@link Ext.grid.Column Column definition} objects representing the configuration
118 * of this ColumnModel. See {@link Ext.grid.Column} for the configuration properties that may
124 Ext.apply(this, config);
125 this.setConfig(config.columns, true);
127 this.setConfig(config, true);
132 * Fires when the width of a column is programmaticially changed using
133 * <code>{@link #setColumnWidth}</code>.
134 * Note internal resizing suppresses the event from firing. See also
135 * {@link Ext.grid.GridPanel}.<code>{@link #columnresize}</code>.
136 * @param {ColumnModel} this
137 * @param {Number} columnIndex The column index
138 * @param {Number} newWidth The new width
142 * @event headerchange
143 * Fires when the text of a header changes.
144 * @param {ColumnModel} this
145 * @param {Number} columnIndex The column index
146 * @param {String} newText The new header text
150 * @event hiddenchange
151 * Fires when a column is hidden or "unhidden".
152 * @param {ColumnModel} this
153 * @param {Number} columnIndex The column index
154 * @param {Boolean} hidden true if hidden, false otherwise
159 * Fires when a column is moved.
160 * @param {ColumnModel} this
161 * @param {Number} oldIndex
162 * @param {Number} newIndex
166 * @event configchange
167 * Fires when the configuration is changed
168 * @param {ColumnModel} this
172 Ext.grid.ColumnModel.superclass.constructor.call(this);
176 * Returns the id of the column at the specified index.
177 * @param {Number} index The column index
178 * @return {String} the id
180 getColumnId : function(index){
181 return this.config[index].id;
184 getColumnAt : function(index){
185 return this.config[index];
189 * <p>Reconfigures this column model according to the passed Array of column definition objects.
190 * For a description of the individual properties of a column definition object, see the
191 * <a href="#Ext.grid.ColumnModel-configs">Config Options</a>.</p>
192 * <p>Causes the {@link #configchange} event to be fired. A {@link Ext.grid.GridPanel GridPanel}
193 * using this ColumnModel will listen for this event and refresh its UI automatically.</p>
194 * @param {Array} config Array of Column definition objects.
195 * @param {Boolean} initial Specify <tt>true</tt> to bypass cleanup which deletes the <tt>totalWidth</tt>
196 * and destroys existing editors.
198 setConfig : function(config, initial){
200 if(!initial){ // cleanup
201 delete this.totalWidth;
202 for(i = 0, len = this.config.length; i < len; i++){
210 // backward compatibility
211 this.defaults = Ext.apply({
212 width: this.defaultWidth,
213 sortable: this.defaultSortable
216 this.config = config;
219 for(i = 0, len = config.length; i < len; i++){
220 c = Ext.applyIf(config[i], this.defaults);
221 // if no id, create one using column's ordinal position
222 if(typeof c.id == 'undefined'){
226 var Cls = Ext.grid.Column.types[c.xtype || 'gridcolumn'];
230 this.lookup[c.id] = c;
233 this.fireEvent('configchange', this);
238 * Returns the column for a specified id.
239 * @param {String} id The column id
240 * @return {Object} the column
242 getColumnById : function(id){
243 return this.lookup[id];
247 * Returns the index for a specified column id.
248 * @param {String} id The column id
249 * @return {Number} the index, or -1 if not found
251 getIndexById : function(id){
252 for(var i = 0, len = this.config.length; i < len; i++){
253 if(this.config[i].id == id){
261 * Moves a column from one position to another.
262 * @param {Number} oldIndex The index of the column to move.
263 * @param {Number} newIndex The position at which to reinsert the coolumn.
265 moveColumn : function(oldIndex, newIndex){
266 var c = this.config[oldIndex];
267 this.config.splice(oldIndex, 1);
268 this.config.splice(newIndex, 0, c);
270 this.fireEvent("columnmoved", this, oldIndex, newIndex);
274 * Returns the number of columns.
275 * @param {Boolean} visibleOnly Optional. Pass as true to only include visible columns.
278 getColumnCount : function(visibleOnly){
279 if(visibleOnly === true){
281 for(var i = 0, len = this.config.length; i < len; i++){
282 if(!this.isHidden(i)){
288 return this.config.length;
292 * Returns the column configs that return true by the passed function that is called
293 * with (columnConfig, index)
295 // returns an array of column config objects for all hidden columns
296 var columns = grid.getColumnModel().getColumnsBy(function(c){
300 * @param {Function} fn A function which, when passed a {@link Ext.grid.Column Column} object, must
301 * return <code>true</code> if the column is to be included in the returned Array.
302 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function
303 * is executed. Defaults to this ColumnModel.
304 * @return {Array} result
306 getColumnsBy : function(fn, scope){
308 for(var i = 0, len = this.config.length; i < len; i++){
309 var c = this.config[i];
310 if(fn.call(scope||this, c, i) === true){
318 * Returns true if the specified column is sortable.
319 * @param {Number} col The column index
322 isSortable : function(col){
323 return !!this.config[col].sortable;
327 * Returns true if the specified column menu is disabled.
328 * @param {Number} col The column index
331 isMenuDisabled : function(col){
332 return !!this.config[col].menuDisabled;
336 * Returns the rendering (formatting) function defined for the column.
337 * @param {Number} col The column index.
338 * @return {Function} The function used to render the cell. See {@link #setRenderer}.
340 getRenderer : function(col){
341 if(!this.config[col].renderer){
342 return Ext.grid.ColumnModel.defaultRenderer;
344 return this.config[col].renderer;
347 getRendererScope : function(col){
348 return this.config[col].scope;
352 * Sets the rendering (formatting) function for a column. See {@link Ext.util.Format} for some
353 * default formatting functions.
354 * @param {Number} col The column index
355 * @param {Function} fn The function to use to process the cell's raw data
356 * to return HTML markup for the grid view. The render function is called with
357 * the following parameters:<ul>
358 * <li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
359 * <li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
360 * <li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
361 * <li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container element <i>within</i> the table cell
362 * (e.g. 'style="color:red;"').</p></li></ul></p></li>
363 * <li><b>record</b> : Ext.data.record<p class="sub-desc">The {@link Ext.data.Record} from which the data was extracted.</p></li>
364 * <li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
365 * <li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
366 * <li><b>store</b> : Ext.data.Store<p class="sub-desc">The {@link Ext.data.Store} object from which the Record was extracted.</p></li></ul>
368 setRenderer : function(col, fn){
369 this.config[col].renderer = fn;
373 * Returns the width for the specified column.
374 * @param {Number} col The column index
377 getColumnWidth : function(col){
378 return this.config[col].width;
382 * Sets the width for a column.
383 * @param {Number} col The column index
384 * @param {Number} width The new width
385 * @param {Boolean} suppressEvent True to suppress firing the <code>{@link #widthchange}</code>
386 * event. Defaults to false.
388 setColumnWidth : function(col, width, suppressEvent){
389 this.config[col].width = width;
390 this.totalWidth = null;
392 this.fireEvent("widthchange", this, col, width);
397 * Returns the total width of all columns.
398 * @param {Boolean} includeHidden True to include hidden column widths
401 getTotalWidth : function(includeHidden){
402 if(!this.totalWidth){
404 for(var i = 0, len = this.config.length; i < len; i++){
405 if(includeHidden || !this.isHidden(i)){
406 this.totalWidth += this.getColumnWidth(i);
410 return this.totalWidth;
414 * Returns the header for the specified column.
415 * @param {Number} col The column index
418 getColumnHeader : function(col){
419 return this.config[col].header;
423 * Sets the header for a column.
424 * @param {Number} col The column index
425 * @param {String} header The new header
427 setColumnHeader : function(col, header){
428 this.config[col].header = header;
429 this.fireEvent("headerchange", this, col, header);
433 * Returns the tooltip for the specified column.
434 * @param {Number} col The column index
437 getColumnTooltip : function(col){
438 return this.config[col].tooltip;
441 * Sets the tooltip for a column.
442 * @param {Number} col The column index
443 * @param {String} tooltip The new tooltip
445 setColumnTooltip : function(col, tooltip){
446 this.config[col].tooltip = tooltip;
450 * Returns the dataIndex for the specified column.
452 // Get field name for the column
453 var fieldName = grid.getColumnModel().getDataIndex(columnIndex);
455 * @param {Number} col The column index
456 * @return {String} The column's dataIndex
458 getDataIndex : function(col){
459 return this.config[col].dataIndex;
463 * Sets the dataIndex for a column.
464 * @param {Number} col The column index
465 * @param {String} dataIndex The new dataIndex
467 setDataIndex : function(col, dataIndex){
468 this.config[col].dataIndex = dataIndex;
472 * Finds the index of the first matching column for the given dataIndex.
473 * @param {String} col The dataIndex to find
474 * @return {Number} The column index, or -1 if no match was found
476 findColumnIndex : function(dataIndex){
478 for(var i = 0, len = c.length; i < len; i++){
479 if(c[i].dataIndex == dataIndex){
487 * Returns true if the cell is editable.
489 var store = new Ext.data.Store({...});
490 var colModel = new Ext.grid.ColumnModel({
492 isCellEditable: function(col, row) {
493 var record = store.getAt(row);
494 if (record.get('readonly')) { // replace with your condition
497 return Ext.grid.ColumnModel.prototype.isCellEditable.call(this, col, row);
500 var grid = new Ext.grid.GridPanel({
506 * @param {Number} colIndex The column index
507 * @param {Number} rowIndex The row index
510 isCellEditable : function(colIndex, rowIndex){
511 return (this.config[colIndex].editable || (typeof this.config[colIndex].editable == "undefined" && this.config[colIndex].editor)) ? true : false;
515 * Returns the editor defined for the cell/column.
516 * @param {Number} colIndex The column index
517 * @param {Number} rowIndex The row index
518 * @return {Ext.Editor} The {@link Ext.Editor Editor} that was created to wrap
519 * the {@link Ext.form.Field Field} used to edit the cell.
521 getCellEditor : function(colIndex, rowIndex){
522 return this.config[colIndex].getCellEditor(rowIndex);
526 * Sets if a column is editable.
527 * @param {Number} col The column index
528 * @param {Boolean} editable True if the column is editable
530 setEditable : function(col, editable){
531 this.config[col].editable = editable;
535 * Returns <tt>true</tt> if the column is <code>{@link Ext.grid.Column#hidden hidden}</code>,
536 * <tt>false</tt> otherwise.
537 * @param {Number} colIndex The column index
540 isHidden : function(colIndex){
541 return !!this.config[colIndex].hidden; // ensure returns boolean
545 * Returns <tt>true</tt> if the column is <code>{@link Ext.grid.Column#fixed fixed}</code>,
546 * <tt>false</tt> otherwise.
547 * @param {Number} colIndex The column index
550 isFixed : function(colIndex){
551 return !!this.config[colIndex].fixed;
555 * Returns true if the column can be resized
558 isResizable : function(colIndex){
559 return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true;
562 * Sets if a column is hidden.
564 myGrid.getColumnModel().setHidden(0, true); // hide column 0 (0 = the first column).
566 * @param {Number} colIndex The column index
567 * @param {Boolean} hidden True if the column is hidden
569 setHidden : function(colIndex, hidden){
570 var c = this.config[colIndex];
571 if(c.hidden !== hidden){
573 this.totalWidth = null;
574 this.fireEvent("hiddenchange", this, colIndex, hidden);
579 * Sets the editor for a column and destroys the prior editor.
580 * @param {Number} col The column index
581 * @param {Object} editor The editor object
583 setEditor : function(col, editor){
584 Ext.destroy(this.config[col].editor);
585 this.config[col].editor = editor;
589 * Destroys this column model by purging any event listeners, and removing any editors.
591 destroy : function(){
592 for(var i = 0, c = this.config, len = c.length; i < len; i++){
593 Ext.destroy(c[i].editor);
595 this.purgeListeners();
600 Ext.grid.ColumnModel.defaultRenderer = function(value){
601 if(typeof value == "string" && value.length < 1){