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. If an object is returned (bootstrap only)
 157      * then it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered
 158      */
 159        /**
 160      * @cfg {Roo.grid.GridEditor} editor (Optional) For grid editors - returns the grid editor
 161      */
 162     /**
 163      * @cfg {String} align (Optional) Set the CSS text-align property of the column.  Defaults to undefined.
 164      */
 165     /**
 166      * @cfg {String} cursor (Optional)
 167      */
 168     /**
 169      * @cfg {String} tooltip (Optional)
 170      */
 171     /**
 172      * Returns the id of the column at the specified index.
 173      * @param {Number} index The column index
 174      * @return {String} the id
 175      */
 176     getColumnId : function(index){
 177         return this.config[index].id;
 178     },
 179
 180     /**
 181      * Returns the column for a specified id.
 182      * @param {String} id The column id
 183      * @return {Object} the column
 184      */
 185     getColumnById : function(id){
 186         return this.lookup[id];
 187     },
 188
 189
 190     /**
 191      * Returns the column for a specified dataIndex.
 192      * @param {String} dataIndex The column dataIndex
 193      * @return {Object|Boolean} the column or false if not found
 194      */
 195     getColumnByDataIndex: function(dataIndex){
 196         var index = this.findColumnIndex(dataIndex);
 197         return index > -1 ? this.config[index] : false;
 198     },
 199
 200     /**
 201      * Returns the index for a specified column id.
 202      * @param {String} id The column id
 203      * @return {Number} the index, or -1 if not found
 204      */
 205     getIndexById : function(id){
 206         for(var i = 0, len = this.config.length; i < len; i++){
 207             if(this.config[i].id == id){
 208                 return i;
 209             }
 210         }
 211         return -1;
 212     },
 213
 214     /**
 215      * Returns the index for a specified column dataIndex.
 216      * @param {String} dataIndex The column dataIndex
 217      * @return {Number} the index, or -1 if not found
 218      */
 219
 220     findColumnIndex : function(dataIndex){
 221         for(var i = 0, len = this.config.length; i < len; i++){
 222             if(this.config[i].dataIndex == dataIndex){
 223                 return i;
 224             }
 225         }
 226         return -1;
 227     },
 228
 229
 230     moveColumn : function(oldIndex, newIndex){
 231         var c = this.config[oldIndex];
 232         this.config.splice(oldIndex, 1);
 233         this.config.splice(newIndex, 0, c);
 234         this.dataMap = null;
 235         this.fireEvent("columnmoved", this, oldIndex, newIndex);
 236     },
 237
 238     isLocked : function(colIndex){
 239         return this.config[colIndex].locked === true;
 240     },
 241
 242     setLocked : function(colIndex, value, suppressEvent){
 243         if(this.isLocked(colIndex) == value){
 244             return;
 245         }
 246         this.config[colIndex].locked = value;
 247         if(!suppressEvent){
 248             this.fireEvent("columnlockchange", this, colIndex, value);
 249         }
 250     },
 251
 252     getTotalLockedWidth : function(){
 253         var totalWidth = 0;
 254         for(var i = 0; i < this.config.length; i++){
 255             if(this.isLocked(i) && !this.isHidden(i)){
 256                 this.totalWidth += this.getColumnWidth(i);
 257             }
 258         }
 259         return totalWidth;
 260     },
 261
 262     getLockedCount : function(){
 263         for(var i = 0, len = this.config.length; i < len; i++){
 264             if(!this.isLocked(i)){
 265                 return i;
 266             }
 267         }
 268     },
 269
 270     /**
 271      * Returns the number of columns.
 272      * @return {Number}
 273      */
 274     getColumnCount : function(visibleOnly){
 275         if(visibleOnly === true){
 276             var c = 0;
 277             for(var i = 0, len = this.config.length; i < len; i++){
 278                 if(!this.isHidden(i)){
 279                     c++;
 280                 }
 281             }
 282             return c;
 283         }
 284         return this.config.length;
 285     },
 286
 287     /**
 288      * Returns the column configs that return true by the passed function that is called with (columnConfig, index)
 289      * @param {Function} fn
 290      * @param {Object} scope (optional)
 291      * @return {Array} result
 292      */
 293     getColumnsBy : function(fn, scope){
 294         var r = [];
 295         for(var i = 0, len = this.config.length; i < len; i++){
 296             var c = this.config[i];
 297             if(fn.call(scope||this, c, i) === true){
 298                 r[r.length] = c;
 299             }
 300         }
 301         return r;
 302     },
 303
 304     /**
 305      * Returns true if the specified column is sortable.
 306      * @param {Number} col The column index
 307      * @return {Boolean}
 308      */
 309     isSortable : function(col){
 310         if(typeof this.config[col].sortable == "undefined"){
 311             return this.defaultSortable;
 312         }
 313         return this.config[col].sortable;
 314     },
 315
 316     /**
 317      * Returns the rendering (formatting) function defined for the column.
 318      * @param {Number} col The column index.
 319      * @return {Function} The function used to render the cell. See {@link #setRenderer}.
 320      */
 321     getRenderer : function(col){
 322         if(!this.config[col].renderer){
 323             return Roo.grid.ColumnModel.defaultRenderer;
 324         }
 325         return this.config[col].renderer;
 326     },
 327
 328     /**
 329      * Sets the rendering (formatting) function for a column.
 330      * @param {Number} col The column index
 331      * @param {Function} fn The function to use to process the cell's raw data
 332      * to return HTML markup for the grid view. The render function is called with
 333      * the following parameters:<ul>
 334      * <li>Data value.</li>
 335      * <li>Cell metadata. An object in which you may set the following attributes:<ul>
 336      * <li>css A CSS style string to apply to the table cell.</li>
 337      * <li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>
 338      * <li>The {@link Roo.data.Record} from which the data was extracted.</li>
 339      * <li>Row index</li>
 340      * <li>Column index</li>
 341      * <li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>
 342      */
 343     setRenderer : function(col, fn){
 344         this.config[col].renderer = fn;
 345     },
 346
 347     /**
 348      * Returns the width for the specified column.
 349      * @param {Number} col The column index
 350      * @return {Number}
 351      */
 352     getColumnWidth : function(col){
 353         return this.config[col].width * 1 || this.defaultWidth;
 354     },
 355
 356     /**
 357      * Sets the width for a column.
 358      * @param {Number} col The column index
 359      * @param {Number} width The new width
 360      */
 361     setColumnWidth : function(col, width, suppressEvent){
 362         this.config[col].width = width;
 363         this.totalWidth = null;
 364         if(!suppressEvent){
 365              this.fireEvent("widthchange", this, col, width);
 366         }
 367     },
 368
 369     /**
 370      * Returns the total width of all columns.
 371      * @param {Boolean} includeHidden True to include hidden column widths
 372      * @return {Number}
 373      */
 374     getTotalWidth : function(includeHidden){
 375         if(!this.totalWidth){
 376             this.totalWidth = 0;
 377             for(var i = 0, len = this.config.length; i < len; i++){
 378                 if(includeHidden || !this.isHidden(i)){
 379                     this.totalWidth += this.getColumnWidth(i);
 380                 }
 381             }
 382         }
 383         return this.totalWidth;
 384     },
 385
 386     /**
 387      * Returns the header for the specified column.
 388      * @param {Number} col The column index
 389      * @return {String}
 390      */
 391     getColumnHeader : function(col){
 392         return this.config[col].header;
 393     },
 394
 395     /**
 396      * Sets the header for a column.
 397      * @param {Number} col The column index
 398      * @param {String} header The new header
 399      */
 400     setColumnHeader : function(col, header){
 401         this.config[col].header = header;
 402         this.fireEvent("headerchange", this, col, header);
 403     },
 404
 405     /**
 406      * Returns the tooltip for the specified column.
 407      * @param {Number} col The column index
 408      * @return {String}
 409      */
 410     getColumnTooltip : function(col){
 411             return this.config[col].tooltip;
 412     },
 413     /**
 414      * Sets the tooltip for a column.
 415      * @param {Number} col The column index
 416      * @param {String} tooltip The new tooltip
 417      */
 418     setColumnTooltip : function(col, tooltip){
 419             this.config[col].tooltip = tooltip;
 420     },
 421
 422     /**
 423      * Returns the dataIndex for the specified column.
 424      * @param {Number} col The column index
 425      * @return {Number}
 426      */
 427     getDataIndex : function(col){
 428         return this.config[col].dataIndex;
 429     },
 430
 431     /**
 432      * Sets the dataIndex for a column.
 433      * @param {Number} col The column index
 434      * @param {Number} dataIndex The new dataIndex
 435      */
 436     setDataIndex : function(col, dataIndex){
 437         this.config[col].dataIndex = dataIndex;
 438     },
 439
 440
 441
 442     /**
 443      * Returns true if the cell is editable.
 444      * @param {Number} colIndex The column index
 445      * @param {Number} rowIndex The row index
 446      * @return {Boolean}
 447      */
 448     isCellEditable : function(colIndex, rowIndex){
 449         return (this.config[colIndex].editable || (typeof this.config[colIndex].editable == "undefined" && this.config[colIndex].editor)) ? true : false;
 450     },
 451
 452     /**
 453      * Returns the editor defined for the cell/column.
 454      * return false or null to disable editing.
 455      * @param {Number} colIndex The column index
 456      * @param {Number} rowIndex The row index
 457      * @return {Object}
 458      */
 459     getCellEditor : function(colIndex, rowIndex){
 460         return this.config[colIndex].editor;
 461     },
 462
 463     /**
 464      * Sets if a column is editable.
 465      * @param {Number} col The column index
 466      * @param {Boolean} editable True if the column is editable
 467      */
 468     setEditable : function(col, editable){
 469         this.config[col].editable = editable;
 470     },
 471
 472
 473     /**
 474      * Returns true if the column is hidden.
 475      * @param {Number} colIndex The column index
 476      * @return {Boolean}
 477      */
 478     isHidden : function(colIndex){
 479         return this.config[colIndex].hidden;
 480     },
 481
 482
 483     /**
 484      * Returns true if the column width cannot be changed
 485      */
 486     isFixed : function(colIndex){
 487         return this.config[colIndex].fixed;
 488     },
 489
 490     /**
 491      * Returns true if the column can be resized
 492      * @return {Boolean}
 493      */
 494     isResizable : function(colIndex){
 495         return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true;
 496     },
 497     /**
 498      * Sets if a column is hidden.
 499      * @param {Number} colIndex The column index
 500      * @param {Boolean} hidden True if the column is hidden
 501      */
 502     setHidden : function(colIndex, hidden){
 503         this.config[colIndex].hidden = hidden;
 504         this.totalWidth = null;
 505         this.fireEvent("hiddenchange", this, colIndex, hidden);
 506     },
 507
 508     /**
 509      * Sets the editor for a column.
 510      * @param {Number} col The column index
 511      * @param {Object} editor The editor object
 512      */
 513     setEditor : function(col, editor){
 514         this.config[col].editor = editor;
 515     }
 516 });
 517
 518 Roo.grid.ColumnModel.defaultRenderer = function(value){
 519         if(typeof value == "string" && value.length < 1){
 520             return "&#160;";
 521         }
 522         return value;
 523 };
 524
 525 // Alias for backwards compatibility
 526 Roo.grid.DefaultColumnModel = Roo.grid.ColumnModel;