git.roojs.org Git - roojs1/blob - Roo/grid/Grid.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  * @class Roo.grid.Grid
  14  * @extends Roo.util.Observable
  15  * This class represents the primary interface of a component based grid control.
  16  * <br><br>Usage:<pre><code>
  17  var grid = new Roo.grid.Grid("my-container-id", {
  18      ds: myDataStore,
  19      cm: myColModel,
  20      selModel: mySelectionModel,
  21      autoSizeColumns: true,
  22      monitorWindowResize: false,
  23      trackMouseOver: true
  24  });
  25  // set any options
  26  grid.render();
  27  * </code></pre>
  28  * <b>Common Problems:</b><br/>
  29  * - Grid does not resize properly when going smaller: Setting overflow hidden on the container
  30  * element will correct this<br/>
  31  * - If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element
  32  * dimensions. The grid adapts to your container's size, if your container has no size defined then the results
  33  * are unpredictable.<br/>
  34  * - Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the
  35  * grid to calculate dimensions/offsets.<br/>
  36   * @constructor
  37  * @param {String/HTMLElement/Roo.Element} container The element into which this grid will be rendered -
  38  * The container MUST have some type of size defined for the grid to fill. The container will be
  39  * automatically set to position relative if it isn't already.
  40  * @param {Object} config A config object that sets properties on this grid.
  41  */
  42 Roo.grid.Grid = function(container, config){
  43         // initialize the container
  44         this.container = Roo.get(container);
  45         this.container.update("");
  46         this.container.setStyle("overflow", "hidden");
  47     this.container.addClass('x-grid-container');
  48
  49     this.id = this.container.id;
  50
  51     Roo.apply(this, config);
  52     // check and correct shorthanded configs
  53     if(this.ds){
  54         this.dataSource = this.ds;
  55         delete this.ds;
  56     }
  57     if(this.cm){
  58         this.colModel = this.cm;
  59         delete this.cm;
  60     }
  61     if(this.sm){
  62         this.selModel = this.sm;
  63         delete this.sm;
  64     }
  65
  66     if (this.selModel) {
  67         this.selModel = Roo.factory(this.selModel, Roo.grid);
  68         this.sm = this.selModel;
  69         this.sm.xmodule = this.xmodule || false;
  70     }
  71     if (typeof(this.colModel.config) == 'undefined') {
  72         this.colModel = new Roo.grid.ColumnModel(this.colModel);
  73         this.cm = this.colModel;
  74         this.cm.xmodule = this.xmodule || false;
  75     }
  76     if (this.dataSource) {
  77         this.dataSource= Roo.factory(this.dataSource, Roo.data);
  78         this.ds = this.dataSource;
  79         this.ds.xmodule = this.xmodule || false;
  80
  81     }
  82
  83
  84
  85     if(this.width){
  86         this.container.setWidth(this.width);
  87     }
  88
  89     if(this.height){
  90         this.container.setHeight(this.height);
  91     }
  92     /** @private */
  93         this.addEvents({
  94         // raw events
  95         /**
  96          * @event click
  97          * The raw click event for the entire grid.
  98          * @param {Roo.EventObject} e
  99          */
 100         "click" : true,
 101         /**
 102          * @event dblclick
 103          * The raw dblclick event for the entire grid.
 104          * @param {Roo.EventObject} e
 105          */
 106         "dblclick" : true,
 107         /**
 108          * @event contextmenu
 109          * The raw contextmenu event for the entire grid.
 110          * @param {Roo.EventObject} e
 111          */
 112         "contextmenu" : true,
 113         /**
 114          * @event mousedown
 115          * The raw mousedown event for the entire grid.
 116          * @param {Roo.EventObject} e
 117          */
 118         "mousedown" : true,
 119         /**
 120          * @event mouseup
 121          * The raw mouseup event for the entire grid.
 122          * @param {Roo.EventObject} e
 123          */
 124         "mouseup" : true,
 125         /**
 126          * @event mouseover
 127          * The raw mouseover event for the entire grid.
 128          * @param {Roo.EventObject} e
 129          */
 130         "mouseover" : true,
 131         /**
 132          * @event mouseout
 133          * The raw mouseout event for the entire grid.
 134          * @param {Roo.EventObject} e
 135          */
 136         "mouseout" : true,
 137         /**
 138          * @event keypress
 139          * The raw keypress event for the entire grid.
 140          * @param {Roo.EventObject} e
 141          */
 142         "keypress" : true,
 143         /**
 144          * @event keydown
 145          * The raw keydown event for the entire grid.
 146          * @param {Roo.EventObject} e
 147          */
 148         "keydown" : true,
 149
 150         // custom events
 151
 152         /**
 153          * @event cellclick
 154          * Fires when a cell is clicked
 155          * @param {Grid} this
 156          * @param {Number} rowIndex
 157          * @param {Number} columnIndex
 158          * @param {Roo.EventObject} e
 159          */
 160         "cellclick" : true,
 161         /**
 162          * @event celldblclick
 163          * Fires when a cell is double clicked
 164          * @param {Grid} this
 165          * @param {Number} rowIndex
 166          * @param {Number} columnIndex
 167          * @param {Roo.EventObject} e
 168          */
 169         "celldblclick" : true,
 170         /**
 171          * @event rowclick
 172          * Fires when a row is clicked
 173          * @param {Grid} this
 174          * @param {Number} rowIndex
 175          * @param {Roo.EventObject} e
 176          */
 177         "rowclick" : true,
 178         /**
 179          * @event rowdblclick
 180          * Fires when a row is double clicked
 181          * @param {Grid} this
 182          * @param {Number} rowIndex
 183          * @param {Roo.EventObject} e
 184          */
 185         "rowdblclick" : true,
 186         /**
 187          * @event headerclick
 188          * Fires when a header is clicked
 189          * @param {Grid} this
 190          * @param {Number} columnIndex
 191          * @param {Roo.EventObject} e
 192          */
 193         "headerclick" : true,
 194         /**
 195          * @event headerdblclick
 196          * Fires when a header cell is double clicked
 197          * @param {Grid} this
 198          * @param {Number} columnIndex
 199          * @param {Roo.EventObject} e
 200          */
 201         "headerdblclick" : true,
 202         /**
 203          * @event rowcontextmenu
 204          * Fires when a row is right clicked
 205          * @param {Grid} this
 206          * @param {Number} rowIndex
 207          * @param {Roo.EventObject} e
 208          */
 209         "rowcontextmenu" : true,
 210         /**
 211          * @event cellcontextmenu
 212          * Fires when a cell is right clicked
 213          * @param {Grid} this
 214          * @param {Number} rowIndex
 215          * @param {Number} cellIndex
 216          * @param {Roo.EventObject} e
 217          */
 218          "cellcontextmenu" : true,
 219         /**
 220          * @event headercontextmenu
 221          * Fires when a header is right clicked
 222          * @param {Grid} this
 223          * @param {Number} columnIndex
 224          * @param {Roo.EventObject} e
 225          */
 226         "headercontextmenu" : true,
 227         /**
 228          * @event bodyscroll
 229          * Fires when the body element is scrolled
 230          * @param {Number} scrollLeft
 231          * @param {Number} scrollTop
 232          */
 233         "bodyscroll" : true,
 234         /**
 235          * @event columnresize
 236          * Fires when the user resizes a column
 237          * @param {Number} columnIndex
 238          * @param {Number} newSize
 239          */
 240         "columnresize" : true,
 241         /**
 242          * @event columnmove
 243          * Fires when the user moves a column
 244          * @param {Number} oldIndex
 245          * @param {Number} newIndex
 246          */
 247         "columnmove" : true,
 248         /**
 249          * @event startdrag
 250          * Fires when row(s) start being dragged
 251          * @param {Grid} this
 252          * @param {Roo.GridDD} dd The drag drop object
 253          * @param {event} e The raw browser event
 254          */
 255         "startdrag" : true,
 256         /**
 257          * @event enddrag
 258          * Fires when a drag operation is complete
 259          * @param {Grid} this
 260          * @param {Roo.GridDD} dd The drag drop object
 261          * @param {event} e The raw browser event
 262          */
 263         "enddrag" : true,
 264         /**
 265          * @event dragdrop
 266          * Fires when dragged row(s) are dropped on a valid DD target
 267          * @param {Grid} this
 268          * @param {Roo.GridDD} dd The drag drop object
 269          * @param {String} targetId The target drag drop object
 270          * @param {event} e The raw browser event
 271          */
 272         "dragdrop" : true,
 273         /**
 274          * @event dragover
 275          * Fires while row(s) are being dragged. "targetId" is the id of the Yahoo.util.DD object the selected rows are being dragged over.
 276          * @param {Grid} this
 277          * @param {Roo.GridDD} dd The drag drop object
 278          * @param {String} targetId The target drag drop object
 279          * @param {event} e The raw browser event
 280          */
 281         "dragover" : true,
 282         /**
 283          * @event dragenter
 284          *  Fires when the dragged row(s) first cross another DD target while being dragged
 285          * @param {Grid} this
 286          * @param {Roo.GridDD} dd The drag drop object
 287          * @param {String} targetId The target drag drop object
 288          * @param {event} e The raw browser event
 289          */
 290         "dragenter" : true,
 291         /**
 292          * @event dragout
 293          * Fires when the dragged row(s) leave another DD target while being dragged
 294          * @param {Grid} this
 295          * @param {Roo.GridDD} dd The drag drop object
 296          * @param {String} targetId The target drag drop object
 297          * @param {event} e The raw browser event
 298          */
 299         "dragout" : true,
 300         /**
 301          * @event rowclass
 302          * Fires when a row is rendered, so you can change add a style to it.
 303          * @param {GridView} gridview   The grid view
 304          * @param {Object} rowcfg   contains record  rowIndex and rowClass - set rowClass to add a style.
 305          */
 306         'rowclass' : true,
 307
 308         /**
 309          * @event render
 310          * Fires when the grid is rendered
 311          * @param {Grid} grid
 312          */
 313         'render' : true
 314     });
 315
 316     Roo.grid.Grid.superclass.constructor.call(this);
 317 };
 318 Roo.extend(Roo.grid.Grid, Roo.util.Observable, {
 319
 320     /**
 321      * @cfg {String} ddGroup - drag drop group.
 322          */
 323
 324         /**
 325          * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Default is 25.
 326          */
 327         minColumnWidth : 25,
 328
 329         /**
 330          * @cfg {Boolean} autoSizeColumns True to automatically resize the columns to fit their content
 331          * <b>on initial render.</b> It is more efficient to explicitly size the columns
 332          * through the ColumnModel's {@link Roo.grid.ColumnModel#width} config option.  Default is false.
 333          */
 334         autoSizeColumns : false,
 335
 336         /**
 337          * @cfg {Boolean} autoSizeHeaders True to measure headers with column data when auto sizing columns. Default is true.
 338          */
 339         autoSizeHeaders : true,
 340
 341         /**
 342          * @cfg {Boolean} monitorWindowResize True to autoSize the grid when the window resizes. Default is true.
 343          */
 344         monitorWindowResize : true,
 345
 346         /**
 347          * @cfg {Boolean} maxRowsToMeasure If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of
 348          * rows measured to get a columns size. Default is 0 (all rows).
 349          */
 350         maxRowsToMeasure : 0,
 351
 352         /**
 353          * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is true.
 354          */
 355         trackMouseOver : true,
 356
 357     /**
 358          * @cfg {Boolean} enableDrag  True to enable drag of rows. Default is false. (double check if this is needed?)
 359          */
 360
 361         /**
 362          * @cfg {Boolean} enableDragDrop True to enable drag and drop of rows. Default is false.
 363          */
 364         enableDragDrop : false,
 365
 366         /**
 367          * @cfg {Boolean} enableColumnMove True to enable drag and drop reorder of columns. Default is true.
 368          */
 369         enableColumnMove : true,
 370
 371         /**
 372          * @cfg {Boolean} enableColumnHide True to enable hiding of columns with the header context menu. Default is true.
 373          */
 374         enableColumnHide : true,
 375
 376         /**
 377          * @cfg {Boolean} enableRowHeightSync True to manually sync row heights across locked and not locked rows. Default is false.
 378          */
 379         enableRowHeightSync : false,
 380
 381         /**
 382          * @cfg {Boolean} stripeRows True to stripe the rows.  Default is true.
 383          */
 384         stripeRows : true,
 385
 386         /**
 387          * @cfg {Boolean} autoHeight True to fit the height of the grid container to the height of the data. Default is false.
 388          */
 389         autoHeight : false,
 390
 391     /**
 392      * @cfg {String} autoExpandColumn The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.
 393      */
 394     autoExpandColumn : false,
 395
 396     /**
 397     * @cfg {Number} autoExpandMin The minimum width the autoExpandColumn can have (if enabled).
 398     * Default is 50.
 399     */
 400     autoExpandMin : 50,
 401
 402     /**
 403     * @cfg {Number} autoExpandMax The maximum width the autoExpandColumn can have (if enabled). Default is 1000.
 404     */
 405     autoExpandMax : 1000,
 406
 407     /**
 408          * @cfg {Object} view The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().
 409          */
 410         view : null,
 411
 412         /**
 413      * @cfg {Object} loadMask An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.
 414          */
 415         loadMask : false,
 416     /**
 417      * @cfg {Roo.dd.DropTarget} dragTarget An {@link Roo.dd.DragTarget} config
 418          */
 419         dropTarget: false,
 420     // private
 421     rendered : false,
 422
 423     /**
 424     * @cfg {Boolean} autoWidth True to set the grid's width to the default total width of the grid's columns instead
 425     * of a fixed width. Default is false.
 426     */
 427     /**
 428     * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if autoHeight is not on.
 429     */
 430     /**
 431      * Called once after all setup has been completed and the grid is ready to be rendered.
 432      * @return {Roo.grid.Grid} this
 433      */
 434     render : function(){
 435         var c = this.container;
 436         // try to detect autoHeight/width mode
 437         if((!c.dom.offsetHeight || c.dom.offsetHeight < 20) || c.getStyle("height") == "auto"){
 438             this.autoHeight = true;
 439         }
 440         var view = this.getView();
 441         view.init(this);
 442
 443         c.on("click", this.onClick, this);
 444         c.on("dblclick", this.onDblClick, this);
 445         c.on("contextmenu", this.onContextMenu, this);
 446         c.on("keydown", this.onKeyDown, this);
 447
 448         this.relayEvents(c, ["mousedown","mouseup","mouseover","mouseout","keypress"]);
 449
 450         this.getSelectionModel().init(this);
 451
 452         view.render();
 453
 454         if(this.loadMask){
 455             this.loadMask = new Roo.LoadMask(this.container,
 456                     Roo.apply({store:this.dataSource}, this.loadMask));
 457         }
 458
 459
 460         if (this.toolbar && this.toolbar.xtype) {
 461             this.toolbar.container = this.getView().getHeaderPanel(true);
 462             this.toolbar = new Ext.Toolbar(this.toolbar);
 463         }
 464         if (this.footer && this.footer.xtype) {
 465             this.footer.dataSource = this.getDataSource();
 466             this.footer.container = this.getView().getFooterPanel(true);
 467             this.footer = Roo.factory(this.footer, Roo);
 468         }
 469         if (this.dropTarget && this.dropTarget.xtype) {
 470             delete this.dropTarget.xtype;
 471             this.dropTarget =  new Ext.dd.DropTarget(this.getView().mainBody, this.dropTarget);
 472         }
 473
 474
 475         this.rendered = true;
 476         this.fireEvent('render', this);
 477         return this;
 478     },
 479
 480         /**
 481          * Reconfigures the grid to use a different Store and Column Model.
 482          * The View will be bound to the new objects and refreshed.
 483          * @param {Roo.data.Store} dataSource The new {@link Roo.data.Store} object
 484          * @param {Roo.grid.ColumnModel} The new {@link Roo.grid.ColumnModel} object
 485          */
 486     reconfigure : function(dataSource, colModel){
 487         if(this.loadMask){
 488             this.loadMask.destroy();
 489             this.loadMask = new Roo.LoadMask(this.container,
 490                     Roo.apply({store:dataSource}, this.loadMask));
 491         }
 492         this.view.bind(dataSource, colModel);
 493         this.dataSource = dataSource;
 494         this.colModel = colModel;
 495         this.view.refresh(true);
 496     },
 497
 498     // private
 499     onKeyDown : function(e){
 500         this.fireEvent("keydown", e);
 501     },
 502
 503     /**
 504      * Destroy this grid.
 505      * @param {Boolean} removeEl True to remove the element
 506      */
 507     destroy : function(removeEl, keepListeners){
 508         if(this.loadMask){
 509             this.loadMask.destroy();
 510         }
 511         var c = this.container;
 512         c.removeAllListeners();
 513         this.view.destroy();
 514         this.colModel.purgeListeners();
 515         if(!keepListeners){
 516             this.purgeListeners();
 517         }
 518         c.update("");
 519         if(removeEl === true){
 520             c.remove();
 521         }
 522     },
 523
 524     // private
 525     processEvent : function(name, e){
 526         this.fireEvent(name, e);
 527         var t = e.getTarget();
 528         var v = this.view;
 529         var header = v.findHeaderIndex(t);
 530         if(header !== false){
 531             this.fireEvent("header" + name, this, header, e);
 532         }else{
 533             var row = v.findRowIndex(t);
 534             var cell = v.findCellIndex(t);
 535             if(row !== false){
 536                 this.fireEvent("row" + name, this, row, e);
 537                 if(cell !== false){
 538                     this.fireEvent("cell" + name, this, row, cell, e);
 539                 }
 540             }
 541         }
 542     },
 543
 544     // private
 545     onClick : function(e){
 546         this.processEvent("click", e);
 547     },
 548
 549     // private
 550     onContextMenu : function(e, t){
 551         this.processEvent("contextmenu", e);
 552     },
 553
 554     // private
 555     onDblClick : function(e){
 556         this.processEvent("dblclick", e);
 557     },
 558
 559     // private
 560     walkCells : function(row, col, step, fn, scope){
 561         var cm = this.colModel, clen = cm.getColumnCount();
 562         var ds = this.dataSource, rlen = ds.getCount(), first = true;
 563         if(step < 0){
 564             if(col < 0){
 565                 row--;
 566                 first = false;
 567             }
 568             while(row >= 0){
 569                 if(!first){
 570                     col = clen-1;
 571                 }
 572                 first = false;
 573                 while(col >= 0){
 574                     if(fn.call(scope || this, row, col, cm) === true){
 575                         return [row, col];
 576                     }
 577                     col--;
 578                 }
 579                 row--;
 580             }
 581         } else {
 582             if(col >= clen){
 583                 row++;
 584                 first = false;
 585             }
 586             while(row < rlen){
 587                 if(!first){
 588                     col = 0;
 589                 }
 590                 first = false;
 591                 while(col < clen){
 592                     if(fn.call(scope || this, row, col, cm) === true){
 593                         return [row, col];
 594                     }
 595                     col++;
 596                 }
 597                 row++;
 598             }
 599         }
 600         return null;
 601     },
 602
 603     // private
 604     getSelections : function(){
 605         return this.selModel.getSelections();
 606     },
 607
 608     /**
 609      * Causes the grid to manually recalculate its dimensions. Generally this is done automatically,
 610      * but if manual update is required this method will initiate it.
 611      */
 612     autoSize : function(){
 613         if(this.rendered){
 614             this.view.layout();
 615             if(this.view.adjustForScroll){
 616                 this.view.adjustForScroll();
 617             }
 618         }
 619     },
 620
 621     /**
 622      * Returns the grid's underlying element.
 623      * @return {Element} The element
 624      */
 625     getGridEl : function(){
 626         return this.container;
 627     },
 628
 629     // private for compatibility, overridden by editor grid
 630     stopEditing : function(){},
 631
 632     /**
 633      * Returns the grid's SelectionModel.
 634      * @return {SelectionModel}
 635      */
 636     getSelectionModel : function(){
 637         if(!this.selModel){
 638             this.selModel = new Roo.grid.RowSelectionModel();
 639         }
 640         return this.selModel;
 641     },
 642
 643     /**
 644      * Returns the grid's DataSource.
 645      * @return {DataSource}
 646      */
 647     getDataSource : function(){
 648         return this.dataSource;
 649     },
 650
 651     /**
 652      * Returns the grid's ColumnModel.
 653      * @return {ColumnModel}
 654      */
 655     getColumnModel : function(){
 656         return this.colModel;
 657     },
 658
 659     /**
 660      * Returns the grid's GridView object.
 661      * @return {GridView}
 662      */
 663     getView : function(){
 664         if(!this.view){
 665             this.view = new Roo.grid.GridView(this.viewConfig);
 666         }
 667         return this.view;
 668     },
 669     /**
 670      * Called to get grid's drag proxy text, by default returns this.ddText.
 671      * @return {String}
 672      */
 673     getDragDropText : function(){
 674         var count = this.selModel.getCount();
 675         return String.format(this.ddText, count, count == 1 ? '' : 's');
 676     }
 677 });
 678 /**
 679  * Configures the text is the drag proxy (defaults to "%0 selected row(s)").
 680  * %0 is replaced with the number of selected rows.
 681  * @type String
 682  */
 683 Roo.grid.Grid.prototype.ddText = "{0} selected row{1}";