PageRenderTime 216ms CodeModel.GetById 165ms app.highlight 42ms RepoModel.GetById 2ms app.codeStats 0ms

/hippo/src/main/webapp/ext/src/widgets/grid/ColumnModel.js

http://hdbc.googlecode.com/
JavaScript | 592 lines | 202 code | 34 blank | 356 comment | 35 complexity | c303e689783599f39381a53d06f8acc7 MD5 | raw file
  1/*!
  2 * Ext JS Library 3.0.0
  3 * Copyright(c) 2006-2009 Ext JS, LLC
  4 * licensing@extjs.com
  5 * http://www.extjs.com/license
  6 */
  7/**
  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>
 16 * <pre><code>
 17{data source} == mapping ==> {data store} == <b><tt>{@link Ext.grid.Column#dataIndex dataIndex}</tt></b> ==> {ColumnModel}
 18 * </code></pre>
 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>
 24<pre><code>
 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}
 31 ]);
 32 </code></pre>
 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).  Field's 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({
 51    columns: [
 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}
 57    ],
 58    defaults: {
 59        sortable: true,
 60        menuDisabled: true,
 61        width: 100
 62    },
 63    listeners: {
 64        {@link #hiddenchange}: function(cm, colIndex, hidden) {
 65            saveConfig(colIndex, hidden);
 66        }
 67    }
 68});
 69 </code></pre>
 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
 74.x-grid3-td-company {
 75    color: red; // entire column will have red font
 76}
 77// modify the header row only, adding an icon to the column header
 78.x-grid3-hd-company {
 79    background: transparent
 80        url(../../resources/images/icons/silk/building.png)
 81        no-repeat 3px 3px ! important;
 82        padding-left:20px;
 83}
 84 </code></pre>
 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>.
 87 * @constructor
 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).
 90 */
 91Ext.grid.ColumnModel = function(config){
 92    /**
 93     * An Array of {@link Ext.grid.Column Column definition} objects representing the configuration
 94     * of this ColumnModel.  See {@link Ext.grid.Column} for the configuration properties that may
 95     * be specified.
 96     * @property config
 97     * @type Array
 98     */
 99    if(config.columns){
100        Ext.apply(this, config);
101        this.setConfig(config.columns, true);
102    }else{
103        this.setConfig(config, true);
104    }
105    this.addEvents(
106        /**
107         * @event widthchange
108         * Fires when the width of a column is programmaticially changed using
109         * <code>{@link #setColumnWidth}</code>.
110         * Note internal resizing suppresses the event from firing. See also
111         * {@link Ext.grid.GridPanel}.<code>{@link #columnresize}</code>.
112         * @param {ColumnModel} this
113         * @param {Number} columnIndex The column index
114         * @param {Number} newWidth The new width
115         */
116        "widthchange",
117        /**
118         * @event headerchange
119         * Fires when the text of a header changes.
120         * @param {ColumnModel} this
121         * @param {Number} columnIndex The column index
122         * @param {String} newText The new header text
123         */
124        "headerchange",
125        /**
126         * @event hiddenchange
127         * Fires when a column is hidden or "unhidden".
128         * @param {ColumnModel} this
129         * @param {Number} columnIndex The column index
130         * @param {Boolean} hidden true if hidden, false otherwise
131         */
132        "hiddenchange",
133        /**
134         * @event columnmoved
135         * Fires when a column is moved.
136         * @param {ColumnModel} this
137         * @param {Number} oldIndex
138         * @param {Number} newIndex
139         */
140        "columnmoved",
141        /**
142         * @event configchange
143         * Fires when the configuration is changed
144         * @param {ColumnModel} this
145         */
146        "configchange"
147    );
148    Ext.grid.ColumnModel.superclass.constructor.call(this);
149};
150Ext.extend(Ext.grid.ColumnModel, Ext.util.Observable, {
151    /**
152     * @cfg {Number} defaultWidth (optional) The width of columns which have no <tt>{@link #width}</tt>
153     * specified (defaults to <tt>100</tt>).  This property shall preferably be configured through the
154     * <tt><b>{@link #defaults}</b></tt> config property.
155     */
156    defaultWidth: 100,
157    /**
158     * @cfg {Boolean} defaultSortable (optional) Default sortable of columns which have no
159     * sortable specified (defaults to <tt>false</tt>).  This property shall preferably be configured
160     * through the <tt><b>{@link #defaults}</b></tt> config property.
161     */
162    defaultSortable: false,
163    /**
164     * @cfg {Array} columns An Array of object literals.  The config options defined by
165     * <b>{@link Ext.grid.Column}</b> are the options which may appear in the object literal for each
166     * individual column definition.
167     */
168    /**
169     * @cfg {Object} defaults Object literal which will be used to apply {@link Ext.grid.Column}
170     * configuration options to all <tt><b>{@link #columns}</b></tt>.  Configuration options specified with
171     * individual {@link Ext.grid.Column column} configs will supersede these <tt><b>{@link #defaults}</b></tt>.
172     */
173
174    /**
175     * Returns the id of the column at the specified index.
176     * @param {Number} index The column index
177     * @return {String} the id
178     */
179    getColumnId : function(index){
180        return this.config[index].id;
181    },
182
183    getColumnAt : function(index){
184        return this.config[index];
185    },
186
187    /**
188     * <p>Reconfigures this column model according to the passed Array of column definition objects.
189     * For a description of the individual properties of a column definition object, see the
190     * <a href="#Ext.grid.ColumnModel-configs">Config Options</a>.</p>
191     * <p>Causes the {@link #configchange} event to be fired. A {@link Ext.grid.GridPanel GridPanel}
192     * using this ColumnModel will listen for this event and refresh its UI automatically.</p>
193     * @param {Array} config Array of Column definition objects.
194     * @param {Boolean} initial Specify <tt>true</tt> to bypass cleanup which deletes the <tt>totalWidth</tt>
195     * and destroys existing editors.
196     */
197    setConfig : function(config, initial){
198        var i, c, len;
199        if(!initial){ // cleanup
200            delete this.totalWidth;
201            for(i = 0, len = this.config.length; i < len; i++){
202                c = this.config[i];
203                if(c.editor){
204                    c.editor.destroy();
205                }
206            }
207        }
208
209        // backward compatibility
210        this.defaults = Ext.apply({
211            width: this.defaultWidth,
212            sortable: this.defaultSortable
213        }, this.defaults);
214
215        this.config = config;
216        this.lookup = {};
217        // if no id, create one
218        for(i = 0, len = config.length; i < len; i++){
219            c = Ext.applyIf(config[i], this.defaults);
220            if(!c.isColumn){
221                var cls = Ext.grid.Column.types[c.xtype || 'gridcolumn'];
222                c = new cls(c);
223                config[i] = c;
224            }
225            this.lookup[c.id] = c;
226        }
227        if(!initial){
228            this.fireEvent('configchange', this);
229        }
230    },
231
232    /**
233     * Returns the column for a specified id.
234     * @param {String} id The column id
235     * @return {Object} the column
236     */
237    getColumnById : function(id){
238        return this.lookup[id];
239    },
240
241    /**
242     * Returns the index for a specified column id.
243     * @param {String} id The column id
244     * @return {Number} the index, or -1 if not found
245     */
246    getIndexById : function(id){
247        for(var i = 0, len = this.config.length; i < len; i++){
248            if(this.config[i].id == id){
249                return i;
250            }
251        }
252        return -1;
253    },
254
255    /**
256     * Moves a column from one position to another.
257     * @param {Number} oldIndex The index of the column to move.
258     * @param {Number} newIndex The position at which to reinsert the coolumn.
259     */
260    moveColumn : function(oldIndex, newIndex){
261        var c = this.config[oldIndex];
262        this.config.splice(oldIndex, 1);
263        this.config.splice(newIndex, 0, c);
264        this.dataMap = null;
265        this.fireEvent("columnmoved", this, oldIndex, newIndex);
266    },
267
268    /**
269     * Returns the number of columns.
270     * @param {Boolean} visibleOnly Optional. Pass as true to only include visible columns.
271     * @return {Number}
272     */
273    getColumnCount : function(visibleOnly){
274        if(visibleOnly === true){
275            var c = 0;
276            for(var i = 0, len = this.config.length; i < len; i++){
277                if(!this.isHidden(i)){
278                    c++;
279                }
280            }
281            return c;
282        }
283        return this.config.length;
284    },
285
286    /**
287     * Returns the column configs that return true by the passed function that is called
288     * with (columnConfig, index)
289<pre><code>
290// returns an array of column config objects for all hidden columns
291var columns = grid.getColumnModel().getColumnsBy(function(c){
292  return c.hidden;
293});
294</code></pre>
295     * @param {Function} fn
296     * @param {Object} scope (optional)
297     * @return {Array} result
298     */
299    getColumnsBy : function(fn, scope){
300        var r = [];
301        for(var i = 0, len = this.config.length; i < len; i++){
302            var c = this.config[i];
303            if(fn.call(scope||this, c, i) === true){
304                r[r.length] = c;
305            }
306        }
307        return r;
308    },
309
310    /**
311     * Returns true if the specified column is sortable.
312     * @param {Number} col The column index
313     * @return {Boolean}
314     */
315    isSortable : function(col){
316        return this.config[col].sortable;
317    },
318
319    /**
320     * Returns true if the specified column menu is disabled.
321     * @param {Number} col The column index
322     * @return {Boolean}
323     */
324    isMenuDisabled : function(col){
325        return !!this.config[col].menuDisabled;
326    },
327
328    /**
329     * Returns the rendering (formatting) function defined for the column.
330     * @param {Number} col The column index.
331     * @return {Function} The function used to render the cell. See {@link #setRenderer}.
332     */
333    getRenderer : function(col){
334        if(!this.config[col].renderer){
335            return Ext.grid.ColumnModel.defaultRenderer;
336        }
337        return this.config[col].renderer;
338    },
339
340    /**
341     * Sets the rendering (formatting) function for a column.  See {@link Ext.util.Format} for some
342     * default formatting functions.
343     * @param {Number} col The column index
344     * @param {Function} fn The function to use to process the cell's raw data
345     * to return HTML markup for the grid view. The render function is called with
346     * the following parameters:<ul>
347     * <li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
348     * <li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
349     * <li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
350     * <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
351     * (e.g. 'style="color:red;"').</p></li></ul></p></li>
352     * <li><b>record</b> : Ext.data.record<p class="sub-desc">The {@link Ext.data.Record} from which the data was extracted.</p></li>
353     * <li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
354     * <li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
355     * <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>
356     */
357    setRenderer : function(col, fn){
358        this.config[col].renderer = fn;
359    },
360
361    /**
362     * Returns the width for the specified column.
363     * @param {Number} col The column index
364     * @return {Number}
365     */
366    getColumnWidth : function(col){
367        return this.config[col].width;
368    },
369
370    /**
371     * Sets the width for a column.
372     * @param {Number} col The column index
373     * @param {Number} width The new width
374     * @param {Boolean} suppressEvent True to suppress firing the <code>{@link #widthchange}</code>
375     * event. Defaults to false.
376     */
377    setColumnWidth : function(col, width, suppressEvent){
378        this.config[col].width = width;
379        this.totalWidth = null;
380        if(!suppressEvent){
381             this.fireEvent("widthchange", this, col, width);
382        }
383    },
384
385    /**
386     * Returns the total width of all columns.
387     * @param {Boolean} includeHidden True to include hidden column widths
388     * @return {Number}
389     */
390    getTotalWidth : function(includeHidden){
391        if(!this.totalWidth){
392            this.totalWidth = 0;
393            for(var i = 0, len = this.config.length; i < len; i++){
394                if(includeHidden || !this.isHidden(i)){
395                    this.totalWidth += this.getColumnWidth(i);
396                }
397            }
398        }
399        return this.totalWidth;
400    },
401
402    /**
403     * Returns the header for the specified column.
404     * @param {Number} col The column index
405     * @return {String}
406     */
407    getColumnHeader : function(col){
408        return this.config[col].header;
409    },
410
411    /**
412     * Sets the header for a column.
413     * @param {Number} col The column index
414     * @param {String} header The new header
415     */
416    setColumnHeader : function(col, header){
417        this.config[col].header = header;
418        this.fireEvent("headerchange", this, col, header);
419    },
420
421    /**
422     * Returns the tooltip for the specified column.
423     * @param {Number} col The column index
424     * @return {String}
425     */
426    getColumnTooltip : function(col){
427            return this.config[col].tooltip;
428    },
429    /**
430     * Sets the tooltip for a column.
431     * @param {Number} col The column index
432     * @param {String} tooltip The new tooltip
433     */
434    setColumnTooltip : function(col, tooltip){
435            this.config[col].tooltip = tooltip;
436    },
437
438    /**
439     * Returns the dataIndex for the specified column.
440<pre><code>
441// Get field name for the column
442var fieldName = grid.getColumnModel().getDataIndex(columnIndex);
443</code></pre>
444     * @param {Number} col The column index
445     * @return {String} The column's dataIndex
446     */
447    getDataIndex : function(col){
448        return this.config[col].dataIndex;
449    },
450
451    /**
452     * Sets the dataIndex for a column.
453     * @param {Number} col The column index
454     * @param {String} dataIndex The new dataIndex
455     */
456    setDataIndex : function(col, dataIndex){
457        this.config[col].dataIndex = dataIndex;
458    },
459
460    /**
461     * Finds the index of the first matching column for the given dataIndex.
462     * @param {String} col The dataIndex to find
463     * @return {Number} The column index, or -1 if no match was found
464     */
465    findColumnIndex : function(dataIndex){
466        var c = this.config;
467        for(var i = 0, len = c.length; i < len; i++){
468            if(c[i].dataIndex == dataIndex){
469                return i;
470            }
471        }
472        return -1;
473    },
474
475    /**
476     * Returns true if the cell is editable.
477<pre><code>
478var store = new Ext.data.Store({...});
479var colModel = new Ext.grid.ColumnModel({
480  columns: [...],
481  isCellEditable: function(col, row) {
482    var record = store.getAt(row);
483    if (record.get('readonly')) { // replace with your condition
484      return false;
485    }
486    return Ext.grid.ColumnModel.prototype.isCellEditable.call(this, col, row);
487  }
488});
489var grid = new Ext.grid.GridPanel({
490  store: store,
491  colModel: colModel,
492  ...
493});
494</code></pre>
495     * @param {Number} colIndex The column index
496     * @param {Number} rowIndex The row index
497     * @return {Boolean}
498     */
499    isCellEditable : function(colIndex, rowIndex){
500        return (this.config[colIndex].editable || (typeof this.config[colIndex].editable == "undefined" && this.config[colIndex].editor)) ? true : false;
501    },
502
503    /**
504     * Returns the editor defined for the cell/column.
505     * @param {Number} colIndex The column index
506     * @param {Number} rowIndex The row index
507     * @return {Ext.Editor} The {@link Ext.Editor Editor} that was created to wrap
508     * the {@link Ext.form.Field Field} used to edit the cell.
509     */
510    getCellEditor : function(colIndex, rowIndex){
511        return this.config[colIndex].getCellEditor(rowIndex);
512    },
513
514    /**
515     * Sets if a column is editable.
516     * @param {Number} col The column index
517     * @param {Boolean} editable True if the column is editable
518     */
519    setEditable : function(col, editable){
520        this.config[col].editable = editable;
521    },
522
523
524    /**
525     * Returns true if the column is hidden.
526     * @param {Number} colIndex The column index
527     * @return {Boolean}
528     */
529    isHidden : function(colIndex){
530        return this.config[colIndex].hidden;
531    },
532
533
534    /**
535     * Returns true if the column width cannot be changed
536     */
537    isFixed : function(colIndex){
538        return this.config[colIndex].fixed;
539    },
540
541    /**
542     * Returns true if the column can be resized
543     * @return {Boolean}
544     */
545    isResizable : function(colIndex){
546        return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true;
547    },
548    /**
549     * Sets if a column is hidden.
550<pre><code>
551myGrid.getColumnModel().setHidden(0, true); // hide column 0 (0 = the first column).
552</code></pre>
553     * @param {Number} colIndex The column index
554     * @param {Boolean} hidden True if the column is hidden
555     */
556    setHidden : function(colIndex, hidden){
557        var c = this.config[colIndex];
558        if(c.hidden !== hidden){
559            c.hidden = hidden;
560            this.totalWidth = null;
561            this.fireEvent("hiddenchange", this, colIndex, hidden);
562        }
563    },
564
565    /**
566     * Sets the editor for a column and destroys the prior editor.
567     * @param {Number} col The column index
568     * @param {Object} editor The editor object
569     */
570    setEditor : function(col, editor){
571        Ext.destroy(this.config[col].editor);
572        this.config[col].editor = editor;
573    },
574
575    /**
576     * Destroys this column model by purging any event listeners, and removing any editors.
577     */
578    destroy : function(){
579        for(var i = 0, c = this.config, len = c.length; i < len; i++){
580            Ext.destroy(c[i].editor);
581        }
582        this.purgeListeners();
583    }
584});
585
586// private
587Ext.grid.ColumnModel.defaultRenderer = function(value){
588    if(typeof value == "string" && value.length < 1){
589        return "&#160;";
590    }
591    return value;
592};