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      * @cfg {String} dragGroup - drag group (?? not sure if needed.)
 325      */
 326
 327     /**
 328      * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Default is 25.
 329      */
 330     minColumnWidth : 25,
 331
 332     /**
 333      * @cfg {Boolean} autoSizeColumns True to automatically resize the columns to fit their content
 334      * <b>on initial render.</b> It is more efficient to explicitly size the columns
 335      * through the ColumnModel's {@link Roo.grid.ColumnModel#width} config option.  Default is false.
 336      */
 337     autoSizeColumns : false,
 338
 339     /**
 340      * @cfg {Boolean} autoSizeHeaders True to measure headers with column data when auto sizing columns. Default is true.
 341      */
 342     autoSizeHeaders : true,
 343
 344     /**
 345      * @cfg {Boolean} monitorWindowResize True to autoSize the grid when the window resizes. Default is true.
 346      */
 347     monitorWindowResize : true,
 348
 349     /**
 350      * @cfg {Boolean} maxRowsToMeasure If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of
 351      * rows measured to get a columns size. Default is 0 (all rows).
 352      */
 353     maxRowsToMeasure : 0,
 354
 355     /**
 356      * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is true.
 357      */
 358     trackMouseOver : true,
 359
 360     /**
 361     * @cfg {Boolean} enableDrag  True to enable drag of rows. Default is false. (double check if this is needed?)
 362     */
 363       /**
 364     * @cfg {Boolean} enableDrop  True to enable drop of elements. Default is false. (double check if this is needed?)
 365     */
 366
 367     /**
 368     * @cfg {Boolean} enableDragDrop True to enable drag and drop of rows. Default is false.
 369     */
 370     enableDragDrop : false,
 371
 372     /**
 373     * @cfg {Boolean} enableColumnMove True to enable drag and drop reorder of columns. Default is true.
 374     */
 375     enableColumnMove : true,
 376
 377     /**
 378     * @cfg {Boolean} enableColumnHide True to enable hiding of columns with the header context menu. Default is true.
 379     */
 380     enableColumnHide : true,
 381
 382     /**
 383     * @cfg {Boolean} enableRowHeightSync True to manually sync row heights across locked and not locked rows. Default is false.
 384     */
 385     enableRowHeightSync : false,
 386
 387     /**
 388     * @cfg {Boolean} stripeRows True to stripe the rows.  Default is true.
 389     */
 390     stripeRows : true,
 391
 392     /**
 393     * @cfg {Boolean} autoHeight True to fit the height of the grid container to the height of the data. Default is false.
 394     */
 395     autoHeight : false,
 396
 397     /**
 398      * @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.
 399      */
 400     autoExpandColumn : false,
 401
 402     /**
 403     * @cfg {Number} autoExpandMin The minimum width the autoExpandColumn can have (if enabled).
 404     * Default is 50.
 405     */
 406     autoExpandMin : 50,
 407
 408     /**
 409     * @cfg {Number} autoExpandMax The maximum width the autoExpandColumn can have (if enabled). Default is 1000.
 410     */
 411     autoExpandMax : 1000,
 412
 413     /**
 414     * @cfg {Object} view The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().
 415     */
 416     view : null,
 417
 418     /**
 419     * @cfg {Object} loadMask An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.
 420     */
 421     loadMask : false,
 422     /**
 423     * @cfg {Roo.dd.DropTarget} dropTarget An {@link Roo.dd.DropTarget} config
 424     */
 425     dropTarget: false,
 426
 427
 428
 429     // private
 430     rendered : false,
 431
 432     /**
 433     * @cfg {Boolean} autoWidth True to set the grid's width to the default total width of the grid's columns instead
 434     * of a fixed width. Default is false.
 435     */
 436     /**
 437     * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if autoHeight is not on.
 438     */
 439
 440
 441     /**
 442     * @cfg {String} ddText Configures the text is the drag proxy (defaults to "%0 selected row(s)").
 443     * %0 is replaced with the number of selected rows.
 444     */
 445     ddText : "{0} selected row{1}",
 446
 447
 448     /**
 449      * Called once after all setup has been completed and the grid is ready to be rendered.
 450      * @return {Roo.grid.Grid} this
 451      */
 452     render : function()
 453     {
 454         var c = this.container;
 455         // try to detect autoHeight/width mode
 456         if((!c.dom.offsetHeight || c.dom.offsetHeight < 20) || c.getStyle("height") == "auto"){
 457             this.autoHeight = true;
 458         }
 459         var view = this.getView();
 460         view.init(this);
 461
 462         c.on("click", this.onClick, this);
 463         c.on("dblclick", this.onDblClick, this);
 464         c.on("contextmenu", this.onContextMenu, this);
 465         c.on("keydown", this.onKeyDown, this);
 466         if (Roo.isTouch) {
 467             c.on("touchstart", this.onTouchStart, this);
 468         }
 469
 470         this.relayEvents(c, ["mousedown","mouseup","mouseover","mouseout","keypress"]);
 471
 472         this.getSelectionModel().init(this);
 473
 474         view.render();
 475
 476         if(this.loadMask){
 477             this.loadMask = new Roo.LoadMask(this.container,
 478                     Roo.apply({store:this.dataSource}, this.loadMask));
 479         }
 480
 481
 482         if (this.toolbar && this.toolbar.xtype) {
 483             this.toolbar.container = this.getView().getHeaderPanel(true);
 484             this.toolbar = new Roo.Toolbar(this.toolbar);
 485         }
 486         if (this.footer && this.footer.xtype) {
 487             this.footer.dataSource = this.getDataSource();
 488             this.footer.container = this.getView().getFooterPanel(true);
 489             this.footer = Roo.factory(this.footer, Roo);
 490         }
 491         if (this.dropTarget && this.dropTarget.xtype) {
 492             delete this.dropTarget.xtype;
 493             this.dropTarget =  new Roo.dd.DropTarget(this.getView().mainBody, this.dropTarget);
 494         }
 495
 496
 497         this.rendered = true;
 498         this.fireEvent('render', this);
 499         return this;
 500     },
 501
 502     /**
 503      * Reconfigures the grid to use a different Store and Column Model.
 504      * The View will be bound to the new objects and refreshed.
 505      * @param {Roo.data.Store} dataSource The new {@link Roo.data.Store} object
 506      * @param {Roo.grid.ColumnModel} The new {@link Roo.grid.ColumnModel} object
 507      */
 508     reconfigure : function(dataSource, colModel){
 509         if(this.loadMask){
 510             this.loadMask.destroy();
 511             this.loadMask = new Roo.LoadMask(this.container,
 512                     Roo.apply({store:dataSource}, this.loadMask));
 513         }
 514         this.view.bind(dataSource, colModel);
 515         this.dataSource = dataSource;
 516         this.colModel = colModel;
 517         this.view.refresh(true);
 518     },
 519     /**
 520      * addColumns
 521      * Add's a column, default at the end..
 522
 523      * @param {int} position to add (default end)
 524      * @param {Array} of objects of column configuration see {@link Roo.grid.ColumnModel}
 525      */
 526     addColumns : function(pos, ar)
 527     {
 528
 529         for (var i =0;i< ar.length;i++) {
 530             var cfg = ar[i];
 531             cfg.id = typeof(cfg.id) == 'undefined' ? Roo.id() : cfg.id; // don't normally use this..
 532             this.cm.lookup[cfg.id] = cfg;
 533         }
 534
 535
 536         if (typeof(pos) == 'undefined' || pos >= this.cm.config.length) {
 537             pos = this.cm.config.length; //this.cm.config.push(cfg);
 538         }
 539         pos = Math.max(0,pos);
 540         ar.unshift(0);
 541         ar.unshift(pos);
 542         this.cm.config.splice.apply(this.cm.config, ar);
 543
 544
 545
 546         this.view.generateRules(this.cm);
 547         this.view.refresh(true);
 548
 549     },
 550
 551
 552
 553
 554     // private
 555     onKeyDown : function(e){
 556         this.fireEvent("keydown", e);
 557     },
 558
 559     /**
 560      * Destroy this grid.
 561      * @param {Boolean} removeEl True to remove the element
 562      */
 563     destroy : function(removeEl, keepListeners){
 564         if(this.loadMask){
 565             this.loadMask.destroy();
 566         }
 567         var c = this.container;
 568         c.removeAllListeners();
 569         this.view.destroy();
 570         this.colModel.purgeListeners();
 571         if(!keepListeners){
 572             this.purgeListeners();
 573         }
 574         c.update("");
 575         if(removeEl === true){
 576             c.remove();
 577         }
 578     },
 579
 580     // private
 581     processEvent : function(name, e){
 582         // does this fire select???
 583         //Roo.log('grid:processEvent '  + name);
 584
 585         if (name != 'touchstart' ) {
 586             this.fireEvent(name, e);
 587         }
 588
 589         var t = e.getTarget();
 590         var v = this.view;
 591         var header = v.findHeaderIndex(t);
 592         if(header !== false){
 593             var ename = name == 'touchstart' ? 'click' : name;
 594
 595             this.fireEvent("header" + ename, this, header, e);
 596         }else{
 597             var row = v.findRowIndex(t);
 598             var cell = v.findCellIndex(t);
 599             if (name == 'touchstart') {
 600                 // first touch is always a click.
 601                 // hopefull this happens after selection is updated.?
 602                 name = false;
 603
 604                 if (typeof(this.selModel.getSelectedCell) != 'undefined') {
 605                     var cs = this.selModel.getSelectedCell();
 606                     if (row == cs[0] && cell == cs[1]){
 607                         name = 'dblclick';
 608                     }
 609                 }
 610                 if (typeof(this.selModel.getSelections) != 'undefined') {
 611                     var cs = this.selModel.getSelections();
 612                     var ds = this.dataSource;
 613                     if (cs.length == 1 && ds.getAt(row) == cs[0]){
 614                         name = 'dblclick';
 615                     }
 616                 }
 617                 if (!name) {
 618                     return;
 619                 }
 620             }
 621
 622
 623             if(row !== false){
 624                 this.fireEvent("row" + name, this, row, e);
 625                 if(cell !== false){
 626                     this.fireEvent("cell" + name, this, row, cell, e);
 627                 }
 628             }
 629         }
 630     },
 631
 632     // private
 633     onClick : function(e){
 634         this.processEvent("click", e);
 635     },
 636    // private
 637     onTouchStart : function(e){
 638         this.processEvent("touchstart", e);
 639     },
 640
 641     // private
 642     onContextMenu : function(e, t){
 643         this.processEvent("contextmenu", e);
 644     },
 645
 646     // private
 647     onDblClick : function(e){
 648         this.processEvent("dblclick", e);
 649     },
 650
 651     // private
 652     walkCells : function(row, col, step, fn, scope){
 653         var cm = this.colModel, clen = cm.getColumnCount();
 654         var ds = this.dataSource, rlen = ds.getCount(), first = true;
 655         if(step < 0){
 656             if(col < 0){
 657                 row--;
 658                 first = false;
 659             }
 660             while(row >= 0){
 661                 if(!first){
 662                     col = clen-1;
 663                 }
 664                 first = false;
 665                 while(col >= 0){
 666                     if(fn.call(scope || this, row, col, cm) === true){
 667                         return [row, col];
 668                     }
 669                     col--;
 670                 }
 671                 row--;
 672             }
 673         } else {
 674             if(col >= clen){
 675                 row++;
 676                 first = false;
 677             }
 678             while(row < rlen){
 679                 if(!first){
 680                     col = 0;
 681                 }
 682                 first = false;
 683                 while(col < clen){
 684                     if(fn.call(scope || this, row, col, cm) === true){
 685                         return [row, col];
 686                     }
 687                     col++;
 688                 }
 689                 row++;
 690             }
 691         }
 692         return null;
 693     },
 694
 695     // private
 696     getSelections : function(){
 697         return this.selModel.getSelections();
 698     },
 699
 700     /**
 701      * Causes the grid to manually recalculate its dimensions. Generally this is done automatically,
 702      * but if manual update is required this method will initiate it.
 703      */
 704     autoSize : function(){
 705         if(this.rendered){
 706             this.view.layout();
 707             if(this.view.adjustForScroll){
 708                 this.view.adjustForScroll();
 709             }
 710         }
 711     },
 712
 713     /**
 714      * Returns the grid's underlying element.
 715      * @return {Element} The element
 716      */
 717     getGridEl : function(){
 718         return this.container;
 719     },
 720
 721     // private for compatibility, overridden by editor grid
 722     stopEditing : function(){},
 723
 724     /**
 725      * Returns the grid's SelectionModel.
 726      * @return {SelectionModel}
 727      */
 728     getSelectionModel : function(){
 729         if(!this.selModel){
 730             this.selModel = new Roo.grid.RowSelectionModel();
 731         }
 732         return this.selModel;
 733     },
 734
 735     /**
 736      * Returns the grid's DataSource.
 737      * @return {DataSource}
 738      */
 739     getDataSource : function(){
 740         return this.dataSource;
 741     },
 742
 743     /**
 744      * Returns the grid's ColumnModel.
 745      * @return {ColumnModel}
 746      */
 747     getColumnModel : function(){
 748         return this.colModel;
 749     },
 750
 751     /**
 752      * Returns the grid's GridView object.
 753      * @return {GridView}
 754      */
 755     getView : function(){
 756         if(!this.view){
 757             this.view = new Roo.grid.GridView(this.viewConfig);
 758         }
 759         return this.view;
 760     },
 761     /**
 762      * Called to get grid's drag proxy text, by default returns this.ddText.
 763      * Override this to put something different in the dragged text.
 764      * @return {String}
 765      */
 766     getDragDropText : function(){
 767         var count = this.selModel.getCount();
 768         return String.format(this.ddText, count, count == 1 ? '' : 's');
 769     }
 770 });