4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
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", {
20 selModel: mySelectionModel,
21 autoSizeColumns: true,
22 monitorWindowResize: false,
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/>
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.
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');
49 this.id = this.container.id;
51 Roo.apply(this, config);
52 // check and correct shorthanded configs
54 this.dataSource = this.ds;
58 this.colModel = this.cm;
62 this.selModel = this.sm;
67 this.selModel = Roo.factory(this.selModel, Roo.grid);
68 this.sm = this.selModel;
69 this.sm.xmodule = this.xmodule || false;
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;
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;
86 this.container.setWidth(this.width);
90 this.container.setHeight(this.height);
97 * The raw click event for the entire grid.
98 * @param {Roo.EventObject} e
103 * The raw dblclick event for the entire grid.
104 * @param {Roo.EventObject} e
109 * The raw contextmenu event for the entire grid.
110 * @param {Roo.EventObject} e
112 "contextmenu" : true,
115 * The raw mousedown event for the entire grid.
116 * @param {Roo.EventObject} e
121 * The raw mouseup event for the entire grid.
122 * @param {Roo.EventObject} e
127 * The raw mouseover event for the entire grid.
128 * @param {Roo.EventObject} e
133 * The raw mouseout event for the entire grid.
134 * @param {Roo.EventObject} e
139 * The raw keypress event for the entire grid.
140 * @param {Roo.EventObject} e
145 * The raw keydown event for the entire grid.
146 * @param {Roo.EventObject} e
154 * Fires when a cell is clicked
156 * @param {Number} rowIndex
157 * @param {Number} columnIndex
158 * @param {Roo.EventObject} e
162 * @event celldblclick
163 * Fires when a cell is double clicked
165 * @param {Number} rowIndex
166 * @param {Number} columnIndex
167 * @param {Roo.EventObject} e
169 "celldblclick" : true,
172 * Fires when a row is clicked
174 * @param {Number} rowIndex
175 * @param {Roo.EventObject} e
180 * Fires when a row is double clicked
182 * @param {Number} rowIndex
183 * @param {Roo.EventObject} e
185 "rowdblclick" : true,
188 * Fires when a header is clicked
190 * @param {Number} columnIndex
191 * @param {Roo.EventObject} e
193 "headerclick" : true,
195 * @event headerdblclick
196 * Fires when a header cell is double clicked
198 * @param {Number} columnIndex
199 * @param {Roo.EventObject} e
201 "headerdblclick" : true,
203 * @event rowcontextmenu
204 * Fires when a row is right clicked
206 * @param {Number} rowIndex
207 * @param {Roo.EventObject} e
209 "rowcontextmenu" : true,
211 * @event cellcontextmenu
212 * Fires when a cell is right clicked
214 * @param {Number} rowIndex
215 * @param {Number} cellIndex
216 * @param {Roo.EventObject} e
218 "cellcontextmenu" : true,
220 * @event headercontextmenu
221 * Fires when a header is right clicked
223 * @param {Number} columnIndex
224 * @param {Roo.EventObject} e
226 "headercontextmenu" : true,
229 * Fires when the body element is scrolled
230 * @param {Number} scrollLeft
231 * @param {Number} scrollTop
235 * @event columnresize
236 * Fires when the user resizes a column
237 * @param {Number} columnIndex
238 * @param {Number} newSize
240 "columnresize" : true,
243 * Fires when the user moves a column
244 * @param {Number} oldIndex
245 * @param {Number} newIndex
250 * Fires when row(s) start being dragged
252 * @param {Roo.GridDD} dd The drag drop object
253 * @param {event} e The raw browser event
258 * Fires when a drag operation is complete
260 * @param {Roo.GridDD} dd The drag drop object
261 * @param {event} e The raw browser event
266 * Fires when dragged row(s) are dropped on a valid DD target
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
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.
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
284 * Fires when the dragged row(s) first cross another DD target while being dragged
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
293 * Fires when the dragged row(s) leave another DD target while being dragged
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
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.
310 * Fires when the grid is rendered
316 Roo.grid.Grid.superclass.constructor.call(this);
318 Roo.extend(Roo.grid.Grid, Roo.util.Observable, {
321 * @cfg {String} ddGroup - drag drop group.
325 * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Default is 25.
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.
334 autoSizeColumns : false,
337 * @cfg {Boolean} autoSizeHeaders True to measure headers with column data when auto sizing columns. Default is true.
339 autoSizeHeaders : true,
342 * @cfg {Boolean} monitorWindowResize True to autoSize the grid when the window resizes. Default is true.
344 monitorWindowResize : true,
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).
350 maxRowsToMeasure : 0,
353 * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is true.
355 trackMouseOver : true,
358 * @cfg {Boolean} enableDrag True to enable drag of rows. Default is false. (double check if this is needed?)
362 * @cfg {Boolean} enableDragDrop True to enable drag and drop of rows. Default is false.
364 enableDragDrop : false,
367 * @cfg {Boolean} enableColumnMove True to enable drag and drop reorder of columns. Default is true.
369 enableColumnMove : true,
372 * @cfg {Boolean} enableColumnHide True to enable hiding of columns with the header context menu. Default is true.
374 enableColumnHide : true,
377 * @cfg {Boolean} enableRowHeightSync True to manually sync row heights across locked and not locked rows. Default is false.
379 enableRowHeightSync : false,
382 * @cfg {Boolean} stripeRows True to stripe the rows. Default is true.
387 * @cfg {Boolean} autoHeight True to fit the height of the grid container to the height of the data. Default is false.
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.
394 autoExpandColumn : false,
397 * @cfg {Number} autoExpandMin The minimum width the autoExpandColumn can have (if enabled).
403 * @cfg {Number} autoExpandMax The maximum width the autoExpandColumn can have (if enabled). Default is 1000.
405 autoExpandMax : 1000,
408 * @cfg {Object} view The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().
413 * @cfg {Object} loadMask An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.
417 * @cfg {Roo.dd.DropTarget} dragTarget An {@link Roo.dd.DragTarget} config
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.
428 * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if autoHeight is not on.
431 * Called once after all setup has been completed and the grid is ready to be rendered.
432 * @return {Roo.grid.Grid} this
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;
440 var view = this.getView();
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);
448 this.relayEvents(c, ["mousedown","mouseup","mouseover","mouseout","keypress"]);
450 this.getSelectionModel().init(this);
455 this.loadMask = new Roo.LoadMask(this.container,
456 Roo.apply({store:this.dataSource}, this.loadMask));
460 if (this.toolbar && this.toolbar.xtype) {
461 this.toolbar.container = this.getView().getHeaderPanel(true);
462 this.toolbar = new Ext.Toolbar(this.toolbar);
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);
469 if (this.dropTarget && this.dropTarget.xtype) {
470 delete this.dropTarget.xtype;
471 this.dropTarget = new Ext.dd.DropTarget(this.getView().mainBody, this.dropTarget);
475 this.rendered = true;
476 this.fireEvent('render', this);
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
486 reconfigure : function(dataSource, colModel){
488 this.loadMask.destroy();
489 this.loadMask = new Roo.LoadMask(this.container,
490 Roo.apply({store:dataSource}, this.loadMask));
492 this.view.bind(dataSource, colModel);
493 this.dataSource = dataSource;
494 this.colModel = colModel;
495 this.view.refresh(true);
499 onKeyDown : function(e){
500 this.fireEvent("keydown", e);
505 * @param {Boolean} removeEl True to remove the element
507 destroy : function(removeEl, keepListeners){
509 this.loadMask.destroy();
511 var c = this.container;
512 c.removeAllListeners();
514 this.colModel.purgeListeners();
516 this.purgeListeners();
519 if(removeEl === true){
525 processEvent : function(name, e){
526 this.fireEvent(name, e);
527 var t = e.getTarget();
529 var header = v.findHeaderIndex(t);
530 if(header !== false){
531 this.fireEvent("header" + name, this, header, e);
533 var row = v.findRowIndex(t);
534 var cell = v.findCellIndex(t);
536 this.fireEvent("row" + name, this, row, e);
538 this.fireEvent("cell" + name, this, row, cell, e);
545 onClick : function(e){
546 this.processEvent("click", e);
550 onContextMenu : function(e, t){
551 this.processEvent("contextmenu", e);
555 onDblClick : function(e){
556 this.processEvent("dblclick", e);
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;
574 if(fn.call(scope || this, row, col, cm) === true){
592 if(fn.call(scope || this, row, col, cm) === true){
604 getSelections : function(){
605 return this.selModel.getSelections();
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.
612 autoSize : function(){
615 if(this.view.adjustForScroll){
616 this.view.adjustForScroll();
622 * Returns the grid's underlying element.
623 * @return {Element} The element
625 getGridEl : function(){
626 return this.container;
629 // private for compatibility, overridden by editor grid
630 stopEditing : function(){},
633 * Returns the grid's SelectionModel.
634 * @return {SelectionModel}
636 getSelectionModel : function(){
638 this.selModel = new Roo.grid.RowSelectionModel();
640 return this.selModel;
644 * Returns the grid's DataSource.
645 * @return {DataSource}
647 getDataSource : function(){
648 return this.dataSource;
652 * Returns the grid's ColumnModel.
653 * @return {ColumnModel}
655 getColumnModel : function(){
656 return this.colModel;
660 * Returns the grid's GridView object.
663 getView : function(){
665 this.view = new Roo.grid.GridView(this.viewConfig);
670 * Called to get grid's drag proxy text, by default returns this.ddText.
673 getDragDropText : function(){
674 var count = this.selModel.getCount();
675 return String.format(this.ddText, count, count == 1 ? '' : 's');
679 * Configures the text is the drag proxy (defaults to "%0 selected row(s)").
680 * %0 is replaced with the number of selected rows.
683 Roo.grid.Grid.prototype.ddText = "{0} selected row{1}";