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