git.roojs.org Git - roojs1/blob - Roo/grid/ColumnModel.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12
  13 /**
  14  * @class Roo.grid.ColumnModel
  15  * @extends Roo.util.Observable
  16  * This is the default implementation of a ColumnModel used by the Grid. It defines
  17  * the columns in the grid.
  18  * <br>Usage:<br>
  19  <pre><code>
  20  var colModel = new Roo.grid.ColumnModel([
  21         {header: "Ticker", width: 60, sortable: true, locked: true},
  22         {header: "Company Name", width: 150, sortable: true},
  23         {header: "Market Cap.", width: 100, sortable: true},
  24         {header: "$ Sales", width: 100, sortable: true, renderer: money},
  25         {header: "Employees", width: 100, sortable: true, resizable: false}
  26  ]);
  27  </code></pre>
  28  * <p>
  29
  30  * The config options listed for this class are options which may appear in each
  31  * individual column definition.
  32  * <br/>RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts.
  33  * @constructor
  34  * @param {Object} config An Array of column config objects. See this class's
  35  * config objects for details.
  36 */
  37 Roo.grid.ColumnModel = function(config){
  38         /**
  39      * The config passed into the constructor
  40      */
  41     this.config = config;
  42     this.lookup = {};
  43
  44     // if no id, create one
  45     // if the column does not have a dataIndex mapping,
  46     // map it to the order it is in the config
  47     for(var i = 0, len = config.length; i < len; i++){
  48         var c = config[i];
  49         if(typeof c.dataIndex == "undefined"){
  50             c.dataIndex = i;
  51         }
  52         if(typeof c.renderer == "string"){
  53             c.renderer = Roo.util.Format[c.renderer];
  54         }
  55         if(typeof c.id == "undefined"){
  56             c.id = Roo.id();
  57         }
  58         if(c.editor && c.editor.xtype){
  59             c.editor  = Roo.factory(c.editor, Roo.grid);
  60         }
  61         if(c.editor && c.editor.isFormField){
  62             c.editor = new Roo.grid.GridEditor(c.editor);
  63         }
  64         this.lookup[c.id] = c;
  65     }
  66
  67     /**
  68      * The width of columns which have no width specified (defaults to 100)
  69      * @type Number
  70      */
  71     this.defaultWidth = 100;
  72
  73     /**
  74      * Default sortable of columns which have no sortable specified (defaults to false)
  75      * @type Boolean
  76      */
  77     this.defaultSortable = false;
  78
  79     this.addEvents({
  80         /**
  81              * @event widthchange
  82              * Fires when the width of a column changes.
  83              * @param {ColumnModel} this
  84              * @param {Number} columnIndex The column index
  85              * @param {Number} newWidth The new width
  86              */
  87             "widthchange": true,
  88         /**
  89              * @event headerchange
  90              * Fires when the text of a header changes.
  91              * @param {ColumnModel} this
  92              * @param {Number} columnIndex The column index
  93              * @param {Number} newText The new header text
  94              */
  95             "headerchange": true,
  96         /**
  97              * @event hiddenchange
  98              * Fires when a column is hidden or "unhidden".
  99              * @param {ColumnModel} this
 100              * @param {Number} columnIndex The column index
 101              * @param {Boolean} hidden true if hidden, false otherwise
 102              */
 103             "hiddenchange": true,
 104             /**
 105          * @event columnmoved
 106          * Fires when a column is moved.
 107          * @param {ColumnModel} this
 108          * @param {Number} oldIndex
 109          * @param {Number} newIndex
 110          */
 111         "columnmoved" : true,
 112         /**
 113          * @event columlockchange
 114          * Fires when a column's locked state is changed
 115          * @param {ColumnModel} this
 116          * @param {Number} colIndex
 117          * @param {Boolean} locked true if locked
 118          */
 119         "columnlockchange" : true
 120     });
 121     Roo.grid.ColumnModel.superclass.constructor.call(this);
 122 };
 123 Roo.extend(Roo.grid.ColumnModel, Roo.util.Observable, {
 124     /**
 125      * @cfg {String} header The header text to display in the Grid view.
 126      */
 127     /**
 128      * @cfg {String} dataIndex (Optional) The name of the field in the grid's {@link Roo.data.Store}'s
 129      * {@link Roo.data.Record} definition from which to draw the column's value. If not
 130      * specified, the column's index is used as an index into the Record's data Array.
 131      */
 132     /**
 133      * @cfg {Number} width (Optional) The initial width in pixels of the column. Using this
 134      * instead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.
 135      */
 136     /**
 137      * @cfg {Boolean} sortable (Optional) True if sorting is to be allowed on this column.
 138      * Defaults to the value of the {@link #defaultSortable} property.
 139      * Whether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.
 140      */
 141     /**
 142      * @cfg {Boolean} locked (Optional) True to lock the column in place while scrolling the Grid.  Defaults to false.
 143      */
 144     /**
 145      * @cfg {Boolean} fixed (Optional) True if the column width cannot be changed.  Defaults to false.
 146      */
 147     /**
 148      * @cfg {Boolean} resizable (Optional) False to disable column resizing. Defaults to true.
 149      */
 150     /**
 151      * @cfg {Boolean} hidden (Optional) True to hide the column. Defaults to false.
 152      */
 153     /**
 154      * @cfg {Function} renderer (Optional) A function used to generate HTML markup for a cell
 155      * given the cell's data value. See {@link #setRenderer}. If not specified, the
 156      * default renderer uses the raw data value.
 157      */
 158        /**
 159      * @cfg {Roo.grid.GridEditor} editor (Optional) For grid editors - returns the grid editor
 160      */
 161     /**
 162      * @cfg {String} align (Optional) Set the CSS text-align property of the column.  Defaults to undefined.
 163      */
 164
 165     /**
 166      * Returns the id of the column at the specified index.
 167      * @param {Number} index The column index
 168      * @return {String} the id
 169      */
 170     getColumnId : function(index){
 171         return this.config[index].id;
 172     },
 173
 174     /**
 175      * Returns the column for a specified id.
 176      * @param {String} id The column id
 177      * @return {Object} the column
 178      */
 179     getColumnById : function(id){
 180         return this.lookup[id];
 181     },
 182
 183
 184     /**
 185      * Returns the column for a specified dataIndex.
 186      * @param {String} dataIndex The column dataIndex
 187      * @return {Object|Boolean} the column or false if not found
 188      */
 189     getColumnByDataIndex: function(dataIndex){
 190         var index = this.findColumnIndex(dataIndex);
 191         return index > -1 ? this.config[index] : false;
 192     },
 193
 194     /**
 195      * Returns the index for a specified column id.
 196      * @param {String} id The column id
 197      * @return {Number} the index, or -1 if not found
 198      */
 199     getIndexById : function(id){
 200         for(var i = 0, len = this.config.length; i < len; i++){
 201             if(this.config[i].id == id){
 202                 return i;
 203             }
 204         }
 205         return -1;
 206     },
 207
 208     /**
 209      * Returns the index for a specified column dataIndex.
 210      * @param {String} dataIndex The column dataIndex
 211      * @return {Number} the index, or -1 if not found
 212      */
 213
 214     findColumnIndex : function(dataIndex){
 215         for(var i = 0, len = this.config.length; i < len; i++){
 216             if(this.config[i].dataIndex == dataIndex){
 217                 return i;
 218             }
 219         }
 220         return -1;
 221     },
 222
 223
 224     moveColumn : function(oldIndex, newIndex){
 225         var c = this.config[oldIndex];
 226         this.config.splice(oldIndex, 1);
 227         this.config.splice(newIndex, 0, c);
 228         this.dataMap = null;
 229         this.fireEvent("columnmoved", this, oldIndex, newIndex);
 230     },
 231
 232     isLocked : function(colIndex){
 233         return this.config[colIndex].locked === true;
 234     },
 235
 236     setLocked : function(colIndex, value, suppressEvent){
 237         if(this.isLocked(colIndex) == value){
 238             return;
 239         }
 240         this.config[colIndex].locked = value;
 241         if(!suppressEvent){
 242             this.fireEvent("columnlockchange", this, colIndex, value);
 243         }
 244     },
 245
 246     getTotalLockedWidth : function(){
 247         var totalWidth = 0;
 248         for(var i = 0; i < this.config.length; i++){
 249             if(this.isLocked(i) && !this.isHidden(i)){
 250                 this.totalWidth += this.getColumnWidth(i);
 251             }
 252         }
 253         return totalWidth;
 254     },
 255
 256     getLockedCount : function(){
 257         for(var i = 0, len = this.config.length; i < len; i++){
 258             if(!this.isLocked(i)){
 259                 return i;
 260             }
 261         }
 262     },
 263
 264     /**
 265      * Returns the number of columns.
 266      * @return {Number}
 267      */
 268     getColumnCount : function(visibleOnly){
 269         if(visibleOnly === true){
 270             var c = 0;
 271             for(var i = 0, len = this.config.length; i < len; i++){
 272                 if(!this.isHidden(i)){
 273                     c++;
 274                 }
 275             }
 276             return c;
 277         }
 278         return this.config.length;
 279     },
 280
 281     /**
 282      * Returns the column configs that return true by the passed function that is called with (columnConfig, index)
 283      * @param {Function} fn
 284      * @param {Object} scope (optional)
 285      * @return {Array} result
 286      */
 287     getColumnsBy : function(fn, scope){
 288         var r = [];
 289         for(var i = 0, len = this.config.length; i < len; i++){
 290             var c = this.config[i];
 291             if(fn.call(scope||this, c, i) === true){
 292                 r[r.length] = c;
 293             }
 294         }
 295         return r;
 296     },
 297
 298     /**
 299      * Returns true if the specified column is sortable.
 300      * @param {Number} col The column index
 301      * @return {Boolean}
 302      */
 303     isSortable : function(col){
 304         if(typeof this.config[col].sortable == "undefined"){
 305             return this.defaultSortable;
 306         }
 307         return this.config[col].sortable;
 308     },
 309
 310     /**
 311      * Returns the rendering (formatting) function defined for the column.
 312      * @param {Number} col The column index.
 313      * @return {Function} The function used to render the cell. See {@link #setRenderer}.
 314      */
 315     getRenderer : function(col){
 316         if(!this.config[col].renderer){
 317             return Roo.grid.ColumnModel.defaultRenderer;
 318         }
 319         return this.config[col].renderer;
 320     },
 321
 322     /**
 323      * Sets the rendering (formatting) function for a column.
 324      * @param {Number} col The column index
 325      * @param {Function} fn The function to use to process the cell's raw data
 326      * to return HTML markup for the grid view. The render function is called with
 327      * the following parameters:<ul>
 328      * <li>Data value.</li>
 329      * <li>Cell metadata. An object in which you may set the following attributes:<ul>
 330      * <li>css A CSS style string to apply to the table cell.</li>
 331      * <li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>
 332      * <li>The {@link Roo.data.Record} from which the data was extracted.</li>
 333      * <li>Row index</li>
 334      * <li>Column index</li>
 335      * <li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>
 336      */
 337     setRenderer : function(col, fn){
 338         this.config[col].renderer = fn;
 339     },
 340
 341     /**
 342      * Returns the width for the specified column.
 343      * @param {Number} col The column index
 344      * @return {Number}
 345      */
 346     getColumnWidth : function(col){
 347         return this.config[col].width * 1 || this.defaultWidth;
 348     },
 349
 350     /**
 351      * Sets the width for a column.
 352      * @param {Number} col The column index
 353      * @param {Number} width The new width
 354      */
 355     setColumnWidth : function(col, width, suppressEvent){
 356         this.config[col].width = width;
 357         this.totalWidth = null;
 358         if(!suppressEvent){
 359              this.fireEvent("widthchange", this, col, width);
 360         }
 361     },
 362
 363     /**
 364      * Returns the total width of all columns.
 365      * @param {Boolean} includeHidden True to include hidden column widths
 366      * @return {Number}
 367      */
 368     getTotalWidth : function(includeHidden){
 369         if(!this.totalWidth){
 370             this.totalWidth = 0;
 371             for(var i = 0, len = this.config.length; i < len; i++){
 372                 if(includeHidden || !this.isHidden(i)){
 373                     this.totalWidth += this.getColumnWidth(i);
 374                 }
 375             }
 376         }
 377         return this.totalWidth;
 378     },
 379
 380     /**
 381      * Returns the header for the specified column.
 382      * @param {Number} col The column index
 383      * @return {String}
 384      */
 385     getColumnHeader : function(col){
 386         return this.config[col].header;
 387     },
 388
 389     /**
 390      * Sets the header for a column.
 391      * @param {Number} col The column index
 392      * @param {String} header The new header
 393      */
 394     setColumnHeader : function(col, header){
 395         this.config[col].header = header;
 396         this.fireEvent("headerchange", this, col, header);
 397     },
 398
 399     /**
 400      * Returns the tooltip for the specified column.
 401      * @param {Number} col The column index
 402      * @return {String}
 403      */
 404     getColumnTooltip : function(col){
 405             return this.config[col].tooltip;
 406     },
 407     /**
 408      * Sets the tooltip for a column.
 409      * @param {Number} col The column index
 410      * @param {String} tooltip The new tooltip
 411      */
 412     setColumnTooltip : function(col, tooltip){
 413             this.config[col].tooltip = tooltip;
 414     },
 415
 416     /**
 417      * Returns the dataIndex for the specified column.
 418      * @param {Number} col The column index
 419      * @return {Number}
 420      */
 421     getDataIndex : function(col){
 422         return this.config[col].dataIndex;
 423     },
 424
 425     /**
 426      * Sets the dataIndex for a column.
 427      * @param {Number} col The column index
 428      * @param {Number} dataIndex The new dataIndex
 429      */
 430     setDataIndex : function(col, dataIndex){
 431         this.config[col].dataIndex = dataIndex;
 432     },
 433
 434
 435
 436     /**
 437      * Returns true if the cell is editable.
 438      * @param {Number} colIndex The column index
 439      * @param {Number} rowIndex The row index
 440      * @return {Boolean}
 441      */
 442     isCellEditable : function(colIndex, rowIndex){
 443         return (this.config[colIndex].editable || (typeof this.config[colIndex].editable == "undefined" && this.config[colIndex].editor)) ? true : false;
 444     },
 445
 446     /**
 447      * Returns the editor defined for the cell/column.
 448      * return false or null to disable editing.
 449      * @param {Number} colIndex The column index
 450      * @param {Number} rowIndex The row index
 451      * @return {Object}
 452      */
 453     getCellEditor : function(colIndex, rowIndex){
 454         return this.config[colIndex].editor;
 455     },
 456
 457     /**
 458      * Sets if a column is editable.
 459      * @param {Number} col The column index
 460      * @param {Boolean} editable True if the column is editable
 461      */
 462     setEditable : function(col, editable){
 463         this.config[col].editable = editable;
 464     },
 465
 466
 467     /**
 468      * Returns true if the column is hidden.
 469      * @param {Number} colIndex The column index
 470      * @return {Boolean}
 471      */
 472     isHidden : function(colIndex){
 473         return this.config[colIndex].hidden;
 474     },
 475
 476
 477     /**
 478      * Returns true if the column width cannot be changed
 479      */
 480     isFixed : function(colIndex){
 481         return this.config[colIndex].fixed;
 482     },
 483
 484     /**
 485      * Returns true if the column can be resized
 486      * @return {Boolean}
 487      */
 488     isResizable : function(colIndex){
 489         return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true;
 490     },
 491     /**
 492      * Sets if a column is hidden.
 493      * @param {Number} colIndex The column index
 494      * @param {Boolean} hidden True if the column is hidden
 495      */
 496     setHidden : function(colIndex, hidden){
 497         this.config[colIndex].hidden = hidden;
 498         this.totalWidth = null;
 499         this.fireEvent("hiddenchange", this, colIndex, hidden);
 500     },
 501
 502     /**
 503      * Sets the editor for a column.
 504      * @param {Number} col The column index
 505      * @param {Object} editor The editor object
 506      */
 507     setEditor : function(col, editor){
 508         this.config[col].editor = editor;
 509     }
 510 });
 511
 512 Roo.grid.ColumnModel.defaultRenderer = function(value){
 513         if(typeof value == "string" && value.length < 1){
 514             return "&#160;";
 515         }
 516         return value;
 517 };
 518
 519 // Alias for backwards compatibility
 520 Roo.grid.DefaultColumnModel = Roo.grid.ColumnModel;