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