/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
*/
-/**\r
- * @class Ext.grid.GridPanel\r
- * @extends Ext.Panel\r
- * <p>This class represents the primary interface of a component based grid control to represent data\r
- * in a tabular format of rows and columns. The GridPanel is composed of the following:</p>\r
- * <div class="mdetail-params"><ul>\r
- * <li><b>{@link Ext.data.Store Store}</b> : The Model holding the data records (rows)\r
- * <div class="sub-desc"></div></li>\r
- * <li><b>{@link Ext.grid.ColumnModel Column model}</b> : Column makeup\r
- * <div class="sub-desc"></div></li>\r
- * <li><b>{@link Ext.grid.GridView View}</b> : Encapsulates the user interface \r
- * <div class="sub-desc"></div></li>\r
- * <li><b>{@link Ext.grid.AbstractSelectionModel selection model}</b> : Selection behavior \r
- * <div class="sub-desc"></div></li>\r
- * </ul></div>\r
- * <p>Example usage:</p>\r
- * <pre><code>\r
-var grid = new Ext.grid.GridPanel({\r
- {@link #store}: new {@link Ext.data.Store}({\r
- {@link Ext.data.Store#autoDestroy autoDestroy}: true,\r
- {@link Ext.data.Store#reader reader}: reader,\r
- {@link Ext.data.Store#data data}: xg.dummyData\r
- }),\r
- {@link #colModel}: new {@link Ext.grid.ColumnModel}({\r
- {@link Ext.grid.ColumnModel#defaults defaults}: {\r
- width: 120,\r
- sortable: true\r
- },\r
- {@link Ext.grid.ColumnModel#columns columns}: [\r
- {id: 'company', header: 'Company', width: 200, sortable: true, dataIndex: 'company'},\r
- {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price'},\r
- {header: 'Change', dataIndex: 'change'},\r
- {header: '% Change', dataIndex: 'pctChange'},\r
- // instead of specifying renderer: Ext.util.Format.dateRenderer('m/d/Y') use xtype\r
- {\r
- header: 'Last Updated', width: 135, dataIndex: 'lastChange',\r
- xtype: 'datecolumn', format: 'M d, Y'\r
- }\r
- ],\r
- }),\r
- {@link #viewConfig}: {\r
- {@link Ext.grid.GridView#forceFit forceFit}: true,\r
-\r
-// Return CSS class to apply to rows depending upon data values\r
- {@link Ext.grid.GridView#getRowClass getRowClass}: function(record, index) {\r
- var c = record.{@link Ext.data.Record#get get}('change');\r
- if (c < 0) {\r
- return 'price-fall';\r
- } else if (c > 0) {\r
- return 'price-rise';\r
- }\r
- }\r
- },\r
- {@link #sm}: new Ext.grid.RowSelectionModel({singleSelect:true}),\r
- width: 600,\r
- height: 300,\r
- frame: true,\r
- title: 'Framed with Row Selection and Horizontal Scrolling',\r
- iconCls: 'icon-grid'\r
-});\r
- * </code></pre>\r
- * <p><b><u>Notes:</u></b></p>\r
- * <div class="mdetail-params"><ul>\r
- * <li>Although this class inherits many configuration options from base classes, some of them\r
- * (such as autoScroll, autoWidth, layout, items, etc) are not used by this class, and will\r
- * have no effect.</li>\r
- * <li>A grid <b>requires</b> a width in which to scroll its columns, and a height in which to\r
- * scroll its rows. These dimensions can either be set explicitly through the\r
- * <tt>{@link Ext.BoxComponent#height height}</tt> and <tt>{@link Ext.BoxComponent#width width}</tt>\r
- * configuration options or implicitly set by using the grid as a child item of a\r
- * {@link Ext.Container Container} which will have a {@link Ext.Container#layout layout manager}\r
- * provide the sizing of its child items (for example the Container of the Grid may specify\r
- * <tt>{@link Ext.Container#layout layout}:'fit'</tt>).</li>\r
- * <li>To access the data in a Grid, it is necessary to use the data model encapsulated\r
- * by the {@link #store Store}. See the {@link #cellclick} event for more details.</li>\r
- * </ul></div>\r
- * @constructor\r
- * @param {Object} config The config object\r
- * @xtype grid\r
- */\r
-Ext.grid.GridPanel = Ext.extend(Ext.Panel, {\r
- /**\r
- * @cfg {String} autoExpandColumn\r
- * <p>The <tt>{@link Ext.grid.Column#id id}</tt> of a {@link Ext.grid.Column column} in\r
- * this grid that should expand to fill unused space. This value specified here can not\r
- * be <tt>0</tt>.</p>\r
- * <br><p><b>Note</b>: If the Grid's {@link Ext.grid.GridView view} is configured with\r
- * <tt>{@link Ext.grid.GridView#forceFit forceFit}=true</tt> the <tt>autoExpandColumn</tt>\r
- * is ignored. See {@link Ext.grid.Column}.<tt>{@link Ext.grid.Column#width width}</tt>\r
- * for additional details.</p>\r
- * <p>See <tt>{@link #autoExpandMax}</tt> and <tt>{@link #autoExpandMin}</tt> also.</p>\r
- */\r
- autoExpandColumn : false,\r
- /**\r
- * @cfg {Number} autoExpandMax The maximum width the <tt>{@link #autoExpandColumn}</tt>\r
- * can have (if enabled). Defaults to <tt>1000</tt>.\r
- */\r
- autoExpandMax : 1000,\r
- /**\r
- * @cfg {Number} autoExpandMin The minimum width the <tt>{@link #autoExpandColumn}</tt>\r
- * can have (if enabled). Defaults to <tt>50</tt>.\r
- */\r
- autoExpandMin : 50,\r
- /**\r
- * @cfg {Boolean} columnLines <tt>true</tt> to add css for column separation lines.\r
- * Default is <tt>false</tt>.\r
- */\r
- columnLines : false,\r
- /**\r
- * @cfg {Object} cm Shorthand for <tt>{@link #colModel}</tt>.\r
- */\r
- /**\r
- * @cfg {Object} colModel The {@link Ext.grid.ColumnModel} to use when rendering the grid (required).\r
- */\r
- /**\r
- * @cfg {Array} columns An array of {@link Ext.grid.Column columns} to auto create a\r
- * {@link Ext.grid.ColumnModel}. The ColumnModel may be explicitly created via the\r
- * <tt>{@link #colModel}</tt> configuration property.\r
- */\r
- /**\r
- * @cfg {String} ddGroup The DD group this GridPanel belongs to. Defaults to <tt>'GridDD'</tt> if not specified.\r
- */\r
- /**\r
- * @cfg {String} ddText\r
- * Configures the text in the drag proxy. Defaults to:\r
- * <pre><code>\r
- * ddText : '{0} selected row{1}'\r
- * </code></pre>\r
- * <tt>{0}</tt> is replaced with the number of selected rows.\r
- */\r
- ddText : '{0} selected row{1}',\r
- /**\r
- * @cfg {Boolean} deferRowRender <P>Defaults to <tt>true</tt> to enable deferred row rendering.</p>\r
- * <p>This allows the GridPanel to be initially rendered empty, with the expensive update of the row\r
- * structure deferred so that layouts with GridPanels appear more quickly.</p>\r
- */\r
- deferRowRender : true,\r
- /**\r
- * @cfg {Boolean} disableSelection <p><tt>true</tt> to disable selections in the grid. Defaults to <tt>false</tt>.</p>\r
- * <p>Ignored if a {@link #selModel SelectionModel} is specified.</p>\r
- */\r
- /**\r
- * @cfg {Boolean} enableColumnResize <tt>false</tt> to turn off column resizing for the whole grid. Defaults to <tt>true</tt>.\r
- */\r
- /**\r
- * @cfg {Boolean} enableColumnHide\r
- * Defaults to <tt>true</tt> to enable {@link Ext.grid.Column#hidden hiding of columns}\r
- * with the {@link #enableHdMenu header menu}.\r
- */\r
- enableColumnHide : true,\r
- /**\r
- * @cfg {Boolean} enableColumnMove Defaults to <tt>true</tt> to enable drag and drop reorder of columns. <tt>false</tt>\r
- * to turn off column reordering via drag drop.\r
- */\r
- enableColumnMove : true,\r
- /**\r
- * @cfg {Boolean} enableDragDrop <p>Enables dragging of the selected rows of the GridPanel. Defaults to <tt>false</tt>.</p>\r
- * <p>Setting this to <b><tt>true</tt></b> causes this GridPanel's {@link #getView GridView} to\r
- * create an instance of {@link Ext.grid.GridDragZone}. <b>Note</b>: this is available only <b>after</b>\r
- * the Grid has been rendered as the GridView's <tt>{@link Ext.grid.GridView#dragZone dragZone}</tt>\r
- * property.</p>\r
- * <p>A cooperating {@link Ext.dd.DropZone DropZone} must be created who's implementations of\r
- * {@link Ext.dd.DropZone#onNodeEnter onNodeEnter}, {@link Ext.dd.DropZone#onNodeOver onNodeOver},\r
- * {@link Ext.dd.DropZone#onNodeOut onNodeOut} and {@link Ext.dd.DropZone#onNodeDrop onNodeDrop} are able\r
- * to process the {@link Ext.grid.GridDragZone#getDragData data} which is provided.</p>\r
- */\r
- enableDragDrop : false,\r
- /**\r
- * @cfg {Boolean} enableHdMenu Defaults to <tt>true</tt> to enable the drop down button for menu in the headers.\r
- */\r
- enableHdMenu : true,\r
- /**\r
- * @cfg {Boolean} hideHeaders True to hide the grid's header. Defaults to <code>false</code>.\r
- */\r
- /**\r
- * @cfg {Object} loadMask An {@link Ext.LoadMask} config or true to mask the grid while\r
- * loading. Defaults to <code>false</code>.\r
- */\r
- loadMask : false,\r
- /**\r
- * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if <tt>autoHeight</tt> is not on.\r
- */\r
- /**\r
- * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Defaults to <tt>25</tt>.\r
- */\r
- minColumnWidth : 25,\r
- /**\r
- * @cfg {Object} sm Shorthand for <tt>{@link #selModel}</tt>.\r
- */\r
- /**\r
- * @cfg {Object} selModel Any subclass of {@link Ext.grid.AbstractSelectionModel} that will provide\r
- * the selection model for the grid (defaults to {@link Ext.grid.RowSelectionModel} if not specified).\r
- */\r
- /**\r
- * @cfg {Ext.data.Store} store The {@link Ext.data.Store} the grid should use as its data source (required).\r
- */\r
- /**\r
- * @cfg {Boolean} stripeRows <tt>true</tt> to stripe the rows. Default is <tt>false</tt>.\r
- * <p>This causes the CSS class <tt><b>x-grid3-row-alt</b></tt> to be added to alternate rows of\r
- * the grid. A default CSS rule is provided which sets a background colour, but you can override this\r
- * with a rule which either overrides the <b>background-color</b> style using the '!important'\r
- * modifier, or which uses a CSS selector of higher specificity.</p>\r
- */\r
- stripeRows : false,\r
- /**\r
- * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is <tt>true</tt>\r
- * for GridPanel, but <tt>false</tt> for EditorGridPanel.\r
- */\r
- trackMouseOver : true,\r
- /**\r
- * @cfg {Array} stateEvents\r
- * An array of events that, when fired, should trigger this component to save its state.\r
- * Defaults to:<pre><code>\r
- * stateEvents: ['columnmove', 'columnresize', 'sortchange']\r
- * </code></pre>\r
- * <p>These can be any types of events supported by this component, including browser or\r
- * custom events (e.g., <tt>['click', 'customerchange']</tt>).</p>\r
- * <p>See {@link Ext.Component#stateful} for an explanation of saving and restoring\r
- * Component state.</p>\r
- */\r
- stateEvents : ['columnmove', 'columnresize', 'sortchange'],\r
- /**\r
- * @cfg {Object} view The {@link Ext.grid.GridView} used by the grid. This can be set\r
- * before a call to {@link Ext.Component#render render()}.\r
- */\r
- view : null,\r
- \r
- /**\r
- * @cfg {Array} bubbleEvents\r
- * <p>An array of events that, when fired, should be bubbled to any parent container.\r
- * Defaults to <tt>[]</tt>.\r
- */\r
- bubbleEvents: [],\r
- \r
- /**\r
- * @cfg {Object} viewConfig A config object that will be applied to the grid's UI view. Any of\r
- * the config options available for {@link Ext.grid.GridView} can be specified here. This option\r
- * is ignored if <tt>{@link #view}</tt> is specified.\r
- */\r
-\r
- // private\r
- rendered : false,\r
- // private\r
- viewReady : false,\r
-\r
- // private\r
- initComponent : function(){\r
- Ext.grid.GridPanel.superclass.initComponent.call(this);\r
-\r
- if(this.columnLines){\r
- this.cls = (this.cls || '') + ' x-grid-with-col-lines';\r
- }\r
- // override any provided value since it isn't valid\r
- // and is causing too many bug reports ;)\r
- this.autoScroll = false;\r
- this.autoWidth = false;\r
-\r
- if(Ext.isArray(this.columns)){\r
- this.colModel = new Ext.grid.ColumnModel(this.columns);\r
- delete this.columns;\r
- }\r
-\r
- // check and correct shorthanded configs\r
- if(this.ds){\r
- this.store = this.ds;\r
- delete this.ds;\r
- }\r
- if(this.cm){\r
- this.colModel = this.cm;\r
- delete this.cm;\r
- }\r
- if(this.sm){\r
- this.selModel = this.sm;\r
- delete this.sm;\r
- }\r
- this.store = Ext.StoreMgr.lookup(this.store);\r
-\r
- this.addEvents(\r
- // raw events\r
- /**\r
- * @event click\r
- * The raw click event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'click',\r
- /**\r
- * @event dblclick\r
- * The raw dblclick event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'dblclick',\r
- /**\r
- * @event contextmenu\r
- * The raw contextmenu event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'contextmenu',\r
- /**\r
- * @event mousedown\r
- * The raw mousedown event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'mousedown',\r
- /**\r
- * @event mouseup\r
- * The raw mouseup event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'mouseup',\r
- /**\r
- * @event mouseover\r
- * The raw mouseover event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'mouseover',\r
- /**\r
- * @event mouseout\r
- * The raw mouseout event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'mouseout',\r
- /**\r
- * @event keypress\r
- * The raw keypress event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'keypress',\r
- /**\r
- * @event keydown\r
- * The raw keydown event for the entire grid.\r
- * @param {Ext.EventObject} e\r
- */\r
- 'keydown',\r
-\r
- // custom events\r
- /**\r
- * @event cellmousedown\r
- * Fires before a cell is clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'cellmousedown',\r
- /**\r
- * @event rowmousedown\r
- * Fires before a row is clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'rowmousedown',\r
- /**\r
- * @event headermousedown\r
- * Fires before a header is clicked\r
- * @param {Grid} this\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'headermousedown',\r
-\r
- /**\r
- * @event cellclick\r
- * Fires when a cell is clicked.\r
- * The data for the cell is drawn from the {@link Ext.data.Record Record}\r
- * for this row. To access the data in the listener function use the\r
- * following technique:\r
- * <pre><code>\r
-function(grid, rowIndex, columnIndex, e) {\r
- var record = grid.getStore().getAt(rowIndex); // Get the Record\r
- var fieldName = grid.getColumnModel().getDataIndex(columnIndex); // Get field name\r
- var data = record.get(fieldName);\r
-}\r
-</code></pre>\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'cellclick',\r
- /**\r
- * @event celldblclick\r
- * Fires when a cell is double clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'celldblclick',\r
- /**\r
- * @event rowclick\r
- * Fires when a row is clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'rowclick',\r
- /**\r
- * @event rowdblclick\r
- * Fires when a row is double clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'rowdblclick',\r
- /**\r
- * @event headerclick\r
- * Fires when a header is clicked\r
- * @param {Grid} this\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'headerclick',\r
- /**\r
- * @event headerdblclick\r
- * Fires when a header cell is double clicked\r
- * @param {Grid} this\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'headerdblclick',\r
- /**\r
- * @event rowcontextmenu\r
- * Fires when a row is right clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'rowcontextmenu',\r
- /**\r
- * @event cellcontextmenu\r
- * Fires when a cell is right clicked\r
- * @param {Grid} this\r
- * @param {Number} rowIndex\r
- * @param {Number} cellIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'cellcontextmenu',\r
- /**\r
- * @event headercontextmenu\r
- * Fires when a header is right clicked\r
- * @param {Grid} this\r
- * @param {Number} columnIndex\r
- * @param {Ext.EventObject} e\r
- */\r
- 'headercontextmenu',\r
- /**\r
- * @event bodyscroll\r
- * Fires when the body element is scrolled\r
- * @param {Number} scrollLeft\r
- * @param {Number} scrollTop\r
- */\r
- 'bodyscroll',\r
- /**\r
- * @event columnresize\r
- * Fires when the user resizes a column\r
- * @param {Number} columnIndex\r
- * @param {Number} newSize\r
- */\r
- 'columnresize',\r
- /**\r
- * @event columnmove\r
- * Fires when the user moves a column\r
- * @param {Number} oldIndex\r
- * @param {Number} newIndex\r
- */\r
- 'columnmove',\r
- /**\r
- * @event sortchange\r
- * Fires when the grid's store sort changes\r
- * @param {Grid} this\r
- * @param {Object} sortInfo An object with the keys field and direction\r
- */\r
- 'sortchange',\r
- /**\r
- * @event reconfigure\r
- * Fires when the grid is reconfigured with a new store and/or column model.\r
- * @param {Grid} this\r
- * @param {Ext.data.Store} store The new store\r
- * @param {Ext.grid.ColumnModel} colModel The new column model\r
- */\r
- 'reconfigure'\r
- );\r
- },\r
-\r
- // private\r
- onRender : function(ct, position){\r
- Ext.grid.GridPanel.superclass.onRender.apply(this, arguments);\r
-\r
- var c = this.getGridEl();\r
-\r
- this.el.addClass('x-grid-panel');\r
-\r
- this.mon(c, {\r
- scope: this,\r
- mousedown: this.onMouseDown,\r
- click: this.onClick,\r
- dblclick: this.onDblClick,\r
- contextmenu: this.onContextMenu\r
- });\r
-\r
- this.relayEvents(c, ['mousedown','mouseup','mouseover','mouseout','keypress', 'keydown']);\r
-\r
- var view = this.getView();\r
- view.init(this);\r
- view.render();\r
- this.getSelectionModel().init(this);\r
- },\r
-\r
- // private\r
- initEvents : function(){\r
- Ext.grid.GridPanel.superclass.initEvents.call(this);\r
-\r
- if(this.loadMask){\r
- this.loadMask = new Ext.LoadMask(this.bwrap,\r
- Ext.apply({store:this.store}, this.loadMask));\r
- }\r
- },\r
-\r
- initStateEvents : function(){\r
- Ext.grid.GridPanel.superclass.initStateEvents.call(this);\r
- this.mon(this.colModel, 'hiddenchange', this.saveState, this, {delay: 100});\r
- },\r
-\r
- applyState : function(state){\r
- var cm = this.colModel,\r
- cs = state.columns;\r
- if(cs){\r
- for(var i = 0, len = cs.length; i < len; i++){\r
- var s = cs[i];\r
- var c = cm.getColumnById(s.id);\r
- if(c){\r
- c.hidden = s.hidden;\r
- c.width = s.width;\r
- var oldIndex = cm.getIndexById(s.id);\r
- if(oldIndex != i){\r
- cm.moveColumn(oldIndex, i);\r
- }\r
- }\r
- }\r
- }\r
- if(state.sort && this.store){\r
- this.store[this.store.remoteSort ? 'setDefaultSort' : 'sort'](state.sort.field, state.sort.direction);\r
- }\r
- var o = Ext.apply({}, state);\r
- delete o.columns;\r
- delete o.sort;\r
- Ext.grid.GridPanel.superclass.applyState.call(this, o);\r
- },\r
-\r
- getState : function(){\r
- var o = {columns: []};\r
- for(var i = 0, c; (c = this.colModel.config[i]); i++){\r
- o.columns[i] = {\r
- id: c.id,\r
- width: c.width\r
- };\r
- if(c.hidden){\r
- o.columns[i].hidden = true;\r
- }\r
- }\r
- if(this.store){\r
- var ss = this.store.getSortState();\r
- if(ss){\r
- o.sort = ss;\r
- }\r
- }\r
- return o;\r
- },\r
-\r
- // private\r
- afterRender : function(){\r
- Ext.grid.GridPanel.superclass.afterRender.call(this);\r
- var v = this.view;\r
- this.on('bodyresize', v.layout, v);\r
- v.layout();\r
- if(this.deferRowRender){\r
- v.afterRender.defer(10, this.view);\r
- }else{\r
- v.afterRender();\r
- }\r
- this.viewReady = true;\r
- },\r
-\r
- /**\r
- * <p>Reconfigures the grid to use a different Store and Column Model\r
- * and fires the 'reconfigure' event. The View will be bound to the new\r
- * objects and refreshed.</p>\r
- * <p>Be aware that upon reconfiguring a GridPanel, certain existing settings <i>may</i> become\r
- * invalidated. For example the configured {@link #autoExpandColumn} may no longer exist in the\r
- * new ColumnModel. Also, an existing {@link Ext.PagingToolbar PagingToolbar} will still be bound\r
- * to the old Store, and will need rebinding. Any {@link #plugins} might also need reconfiguring\r
- * with the new data.</p>\r
- * @param {Ext.data.Store} store The new {@link Ext.data.Store} object\r
- * @param {Ext.grid.ColumnModel} colModel The new {@link Ext.grid.ColumnModel} object\r
- */\r
- reconfigure : function(store, colModel){\r
- if(this.loadMask){\r
- this.loadMask.destroy();\r
- this.loadMask = new Ext.LoadMask(this.bwrap,\r
- Ext.apply({}, {store:store}, this.initialConfig.loadMask));\r
- }\r
- this.view.initData(store, colModel);\r
- this.store = store;\r
- this.colModel = colModel;\r
- if(this.rendered){\r
- this.view.refresh(true);\r
- }\r
- this.fireEvent('reconfigure', this, store, colModel);\r
- },\r
-\r
- // private\r
- onDestroy : function(){\r
- if(this.rendered){\r
- var c = this.body;\r
- c.removeAllListeners();\r
- c.update('');\r
- Ext.destroy(this.view, this.loadMask);\r
- }else if(this.store && this.store.autoDestroy){\r
- this.store.destroy();\r
- }\r
- Ext.destroy(this.colModel, this.selModel);\r
- this.store = this.selModel = this.colModel = this.view = this.loadMask = null;\r
- Ext.grid.GridPanel.superclass.onDestroy.call(this);\r
- },\r
-\r
- // private\r
- processEvent : function(name, e){\r
- this.fireEvent(name, e);\r
- var t = e.getTarget();\r
- var v = this.view;\r
- var header = v.findHeaderIndex(t);\r
- if(header !== false){\r
- this.fireEvent('header' + name, this, header, e);\r
- }else{\r
- var row = v.findRowIndex(t);\r
- var cell = v.findCellIndex(t);\r
- if(row !== false){\r
- this.fireEvent('row' + name, this, row, e);\r
- if(cell !== false){\r
- this.fireEvent('cell' + name, this, row, cell, e);\r
- }\r
- }\r
- }\r
- },\r
-\r
- // private\r
- onClick : function(e){\r
- this.processEvent('click', e);\r
- },\r
-\r
- // private\r
- onMouseDown : function(e){\r
- this.processEvent('mousedown', e);\r
- },\r
-\r
- // private\r
- onContextMenu : function(e, t){\r
- this.processEvent('contextmenu', e);\r
- },\r
-\r
- // private\r
- onDblClick : function(e){\r
- this.processEvent('dblclick', e);\r
- },\r
-\r
- // private\r
- walkCells : function(row, col, step, fn, scope){\r
- var cm = this.colModel, clen = cm.getColumnCount();\r
- var ds = this.store, rlen = ds.getCount(), first = true;\r
- if(step < 0){\r
- if(col < 0){\r
- row--;\r
- first = false;\r
- }\r
- while(row >= 0){\r
- if(!first){\r
- col = clen-1;\r
- }\r
- first = false;\r
- while(col >= 0){\r
- if(fn.call(scope || this, row, col, cm) === true){\r
- return [row, col];\r
- }\r
- col--;\r
- }\r
- row--;\r
- }\r
- } else {\r
- if(col >= clen){\r
- row++;\r
- first = false;\r
- }\r
- while(row < rlen){\r
- if(!first){\r
- col = 0;\r
- }\r
- first = false;\r
- while(col < clen){\r
- if(fn.call(scope || this, row, col, cm) === true){\r
- return [row, col];\r
- }\r
- col++;\r
- }\r
- row++;\r
- }\r
- }\r
- return null;\r
- },\r
-\r
- // private\r
- onResize : function(){\r
- Ext.grid.GridPanel.superclass.onResize.apply(this, arguments);\r
- if(this.viewReady){\r
- this.view.layout();\r
- }\r
- },\r
-\r
- /**\r
- * Returns the grid's underlying element.\r
- * @return {Element} The element\r
- */\r
- getGridEl : function(){\r
- return this.body;\r
- },\r
-\r
- // private for compatibility, overridden by editor grid\r
- stopEditing : Ext.emptyFn,\r
-\r
- /**\r
- * Returns the grid's selection model configured by the <code>{@link #selModel}</code>\r
- * configuration option. If no selection model was configured, this will create\r
- * and return a {@link Ext.grid.RowSelectionModel RowSelectionModel}.\r
- * @return {SelectionModel}\r
- */\r
- getSelectionModel : function(){\r
- if(!this.selModel){\r
- this.selModel = new Ext.grid.RowSelectionModel(\r
- this.disableSelection ? {selectRow: Ext.emptyFn} : null);\r
- }\r
- return this.selModel;\r
- },\r
-\r
- /**\r
- * Returns the grid's data store.\r
- * @return {Ext.data.Store} The store\r
- */\r
- getStore : function(){\r
- return this.store;\r
- },\r
-\r
- /**\r
- * Returns the grid's ColumnModel.\r
- * @return {Ext.grid.ColumnModel} The column model\r
- */\r
- getColumnModel : function(){\r
- return this.colModel;\r
- },\r
-\r
- /**\r
- * Returns the grid's GridView object.\r
- * @return {Ext.grid.GridView} The grid view\r
- */\r
- getView : function(){\r
- if(!this.view){\r
- this.view = new Ext.grid.GridView(this.viewConfig);\r
- }\r
- return this.view;\r
- },\r
- /**\r
- * Called to get grid's drag proxy text, by default returns this.ddText.\r
- * @return {String} The text\r
- */\r
- getDragDropText : function(){\r
- var count = this.selModel.getCount();\r
- return String.format(this.ddText, count, count == 1 ? '' : 's');\r
- }\r
-\r
- /** \r
- * @cfg {String/Number} activeItem \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Boolean} autoDestroy \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Object/String/Function} autoLoad \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Boolean} autoWidth \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Boolean/Number} bufferResize \r
- * @hide \r
- */\r
- /** \r
- * @cfg {String} defaultType \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Object} defaults \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Boolean} hideBorders \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Mixed} items \r
- * @hide \r
- */\r
- /** \r
- * @cfg {String} layout \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Object} layoutConfig \r
- * @hide \r
- */\r
- /** \r
- * @cfg {Boolean} monitorResize \r
- * @hide \r
- */\r
- /** \r
- * @property items \r
- * @hide \r
- */\r
- /** \r
- * @method add \r
- * @hide \r
- */\r
- /** \r
- * @method cascade \r
- * @hide \r
- */\r
- /** \r
- * @method doLayout \r
- * @hide \r
- */\r
- /** \r
- * @method find \r
- * @hide \r
- */\r
- /** \r
- * @method findBy \r
- * @hide \r
- */\r
- /** \r
- * @method findById \r
- * @hide \r
- */\r
- /** \r
- * @method findByType \r
- * @hide \r
- */\r
- /** \r
- * @method getComponent \r
- * @hide \r
- */\r
- /** \r
- * @method getLayout \r
- * @hide \r
- */\r
- /** \r
- * @method getUpdater \r
- * @hide \r
- */\r
- /** \r
- * @method insert \r
- * @hide \r
- */\r
- /** \r
- * @method load \r
- * @hide \r
- */\r
- /** \r
- * @method remove \r
- * @hide \r
- */\r
- /** \r
- * @event add \r
- * @hide \r
- */\r
- /** \r
- * @event afterLayout \r
- * @hide \r
- */\r
- /** \r
- * @event beforeadd \r
- * @hide \r
- */\r
- /** \r
- * @event beforeremove \r
- * @hide \r
- */\r
- /** \r
- * @event remove \r
- * @hide \r
- */\r
-\r
-\r
-\r
- /**\r
- * @cfg {String} allowDomMove @hide\r
- */\r
- /**\r
- * @cfg {String} autoEl @hide\r
- */\r
- /**\r
- * @cfg {String} applyTo @hide\r
- */\r
- /**\r
- * @cfg {String} autoScroll @hide\r
- */\r
- /**\r
- * @cfg {String} bodyBorder @hide\r
- */\r
- /**\r
- * @cfg {String} bodyStyle @hide\r
- */\r
- /**\r
- * @cfg {String} contentEl @hide\r
- */\r
- /**\r
- * @cfg {String} disabledClass @hide\r
- */\r
- /**\r
- * @cfg {String} elements @hide\r
- */\r
- /**\r
- * @cfg {String} html @hide\r
- */\r
- /**\r
- * @cfg {Boolean} preventBodyReset\r
- * @hide\r
- */\r
- /**\r
- * @property disabled\r
- * @hide\r
- */\r
- /**\r
- * @method applyToMarkup\r
- * @hide\r
- */\r
- /**\r
- * @method enable\r
- * @hide\r
- */\r
- /**\r
- * @method disable\r
- * @hide\r
- */\r
- /**\r
- * @method setDisabled\r
- * @hide\r
- */\r
-});\r
-Ext.reg('grid', Ext.grid.GridPanel);/**
- * @class Ext.grid.GridView
- * @extends Ext.util.Observable
- * <p>This class encapsulates the user interface of an {@link Ext.grid.GridPanel}.
- * Methods of this class may be used to access user interface elements to enable
- * special display effects. Do not change the DOM structure of the user interface.</p>
- * <p>This class does not provide ways to manipulate the underlying data. The data
- * model of a Grid is held in an {@link Ext.data.Store}.</p>
+/**
+ * @class Ext.grid.GridPanel
+ * @extends Ext.Panel
+ * <p>This class represents the primary interface of a component based grid control to represent data
+ * in a tabular format of rows and columns. The GridPanel is composed of the following:</p>
+ * <div class="mdetail-params"><ul>
+ * <li><b>{@link Ext.data.Store Store}</b> : The Model holding the data records (rows)
+ * <div class="sub-desc"></div></li>
+ * <li><b>{@link Ext.grid.ColumnModel Column model}</b> : Column makeup
+ * <div class="sub-desc"></div></li>
+ * <li><b>{@link Ext.grid.GridView View}</b> : Encapsulates the user interface
+ * <div class="sub-desc"></div></li>
+ * <li><b>{@link Ext.grid.AbstractSelectionModel selection model}</b> : Selection behavior
+ * <div class="sub-desc"></div></li>
+ * </ul></div>
+ * <p>Example usage:</p>
+ * <pre><code>
+var grid = new Ext.grid.GridPanel({
+ {@link #store}: new {@link Ext.data.Store}({
+ {@link Ext.data.Store#autoDestroy autoDestroy}: true,
+ {@link Ext.data.Store#reader reader}: reader,
+ {@link Ext.data.Store#data data}: xg.dummyData
+ }),
+ {@link #colModel}: new {@link Ext.grid.ColumnModel}({
+ {@link Ext.grid.ColumnModel#defaults defaults}: {
+ width: 120,
+ sortable: true
+ },
+ {@link Ext.grid.ColumnModel#columns columns}: [
+ {id: 'company', header: 'Company', width: 200, sortable: true, dataIndex: 'company'},
+ {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price'},
+ {header: 'Change', dataIndex: 'change'},
+ {header: '% Change', dataIndex: 'pctChange'},
+ // instead of specifying renderer: Ext.util.Format.dateRenderer('m/d/Y') use xtype
+ {
+ header: 'Last Updated', width: 135, dataIndex: 'lastChange',
+ xtype: 'datecolumn', format: 'M d, Y'
+ }
+ ],
+ }),
+ {@link #viewConfig}: {
+ {@link Ext.grid.GridView#forceFit forceFit}: true,
+
+// Return CSS class to apply to rows depending upon data values
+ {@link Ext.grid.GridView#getRowClass getRowClass}: function(record, index) {
+ var c = record.{@link Ext.data.Record#get get}('change');
+ if (c < 0) {
+ return 'price-fall';
+ } else if (c > 0) {
+ return 'price-rise';
+ }
+ }
+ },
+ {@link #sm}: new Ext.grid.RowSelectionModel({singleSelect:true}),
+ width: 600,
+ height: 300,
+ frame: true,
+ title: 'Framed with Row Selection and Horizontal Scrolling',
+ iconCls: 'icon-grid'
+});
+ * </code></pre>
+ * <p><b><u>Notes:</u></b></p>
+ * <div class="mdetail-params"><ul>
+ * <li>Although this class inherits many configuration options from base classes, some of them
+ * (such as autoScroll, autoWidth, layout, items, etc) are not used by this class, and will
+ * have no effect.</li>
+ * <li>A grid <b>requires</b> a width in which to scroll its columns, and a height in which to
+ * scroll its rows. These dimensions can either be set explicitly through the
+ * <tt>{@link Ext.BoxComponent#height height}</tt> and <tt>{@link Ext.BoxComponent#width width}</tt>
+ * configuration options or implicitly set by using the grid as a child item of a
+ * {@link Ext.Container Container} which will have a {@link Ext.Container#layout layout manager}
+ * provide the sizing of its child items (for example the Container of the Grid may specify
+ * <tt>{@link Ext.Container#layout layout}:'fit'</tt>).</li>
+ * <li>To access the data in a Grid, it is necessary to use the data model encapsulated
+ * by the {@link #store Store}. See the {@link #cellclick} event for more details.</li>
+ * </ul></div>
* @constructor
- * @param {Object} config
+ * @param {Object} config The config object
+ * @xtype grid
*/
-Ext.grid.GridView = function(config){
- Ext.apply(this, config);
- // These events are only used internally by the grid components
- this.addEvents(
- /**
- * @event beforerowremoved
- * Internal UI Event. Fired before a row is removed.
- * @param {Ext.grid.GridView} view
- * @param {Number} rowIndex The index of the row to be removed.
- * @param {Ext.data.Record} record The Record to be removed
- */
- 'beforerowremoved',
- /**
- * @event beforerowsinserted
- * Internal UI Event. Fired before rows are inserted.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the first row to be inserted.
- * @param {Number} lastRow The index of the last row to be inserted.
- */
- 'beforerowsinserted',
- /**
- * @event beforerefresh
- * Internal UI Event. Fired before the view is refreshed.
- * @param {Ext.grid.GridView} view
- */
- 'beforerefresh',
- /**
- * @event rowremoved
- * Internal UI Event. Fired after a row is removed.
- * @param {Ext.grid.GridView} view
- * @param {Number} rowIndex The index of the row that was removed.
- * @param {Ext.data.Record} record The Record that was removed
- */
- 'rowremoved',
- /**
- * @event rowsinserted
- * Internal UI Event. Fired after rows are inserted.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the first inserted.
- * @param {Number} lastRow The index of the last row inserted.
- */
- 'rowsinserted',
- /**
- * @event rowupdated
- * Internal UI Event. Fired after a row has been updated.
- * @param {Ext.grid.GridView} view
- * @param {Number} firstRow The index of the row updated.
- * @param {Ext.data.record} record The Record backing the row updated.
- */
- 'rowupdated',
- /**
- * @event refresh
- * Internal UI Event. Fired after the GridView's body has been refreshed.
- * @param {Ext.grid.GridView} view
- */
- 'refresh'
- );
- Ext.grid.GridView.superclass.constructor.call(this);
-};
-
-Ext.extend(Ext.grid.GridView, Ext.util.Observable, {
+Ext.grid.GridPanel = Ext.extend(Ext.Panel, {
/**
- * Override this function to apply custom CSS classes to rows during rendering. You can also supply custom
- * parameters to the row template for the current row to customize how it is rendered using the <b>rowParams</b>
- * parameter. This function should return the CSS class name (or empty string '' for none) that will be added
- * to the row's wrapping div. To apply multiple class names, simply return them space-delimited within the string
- * (e.g., 'my-class another-class'). Example usage:
- <pre><code>
-viewConfig: {
- forceFit: true,
- showPreview: true, // custom property
- enableRowBody: true, // required to create a second, full-width row to show expanded Record data
- getRowClass: function(record, rowIndex, rp, ds){ // rp = rowParams
- if(this.showPreview){
- rp.body = '<p>'+record.data.excerpt+'</p>';
- return 'x-grid3-row-expanded';
- }
- return 'x-grid3-row-collapsed';
- }
-},
- </code></pre>
- * @param {Record} record The {@link Ext.data.Record} corresponding to the current row.
- * @param {Number} index The row index.
- * @param {Object} rowParams A config object that is passed to the row template during rendering that allows
- * customization of various aspects of a grid row.
- * <p>If {@link #enableRowBody} is configured <b><tt></tt>true</b>, then the following properties may be set
- * by this function, and will be used to render a full-width expansion row below each grid row:</p>
- * <ul>
- * <li><code>body</code> : String <div class="sub-desc">An HTML fragment to be used as the expansion row's body content (defaults to '').</div></li>
- * <li><code>bodyStyle</code> : String <div class="sub-desc">A CSS style specification that will be applied to the expansion row's <tr> element. (defaults to '').</div></li>
- * </ul>
- * The following property will be passed in, and may be appended to:
- * <ul>
- * <li><code>tstyle</code> : String <div class="sub-desc">A CSS style specification that willl be applied to the <table> element which encapsulates
- * both the standard grid row, and any expansion row.</div></li>
- * </ul>
- * @param {Store} store The {@link Ext.data.Store} this grid is bound to
- * @method getRowClass
- * @return {String} a CSS class name to add to the row.
+ * @cfg {String} autoExpandColumn
+ * <p>The <tt>{@link Ext.grid.Column#id id}</tt> of a {@link Ext.grid.Column column} in
+ * this grid that should expand to fill unused space. This value specified here can not
+ * be <tt>0</tt>.</p>
+ * <br><p><b>Note</b>: If the Grid's {@link Ext.grid.GridView view} is configured with
+ * <tt>{@link Ext.grid.GridView#forceFit forceFit}=true</tt> the <tt>autoExpandColumn</tt>
+ * is ignored. See {@link Ext.grid.Column}.<tt>{@link Ext.grid.Column#width width}</tt>
+ * for additional details.</p>
+ * <p>See <tt>{@link #autoExpandMax}</tt> and <tt>{@link #autoExpandMin}</tt> also.</p>
*/
+ autoExpandColumn : false,
+
/**
- * @cfg {Boolean} enableRowBody True to add a second TR element per row that can be used to provide a row body
- * that spans beneath the data row. Use the {@link #getRowClass} method's rowParams config to customize the row body.
+ * @cfg {Number} autoExpandMax The maximum width the <tt>{@link #autoExpandColumn}</tt>
+ * can have (if enabled). Defaults to <tt>1000</tt>.
*/
+ autoExpandMax : 1000,
+
/**
- * @cfg {String} emptyText Default text (html tags are accepted) to display in the grid body when no rows
- * are available (defaults to ''). This value will be used to update the <tt>{@link #mainBody}</tt>:
- <pre><code>
- this.mainBody.update('<div class="x-grid-empty">' + this.emptyText + '</div>');
- </code></pre>
+ * @cfg {Number} autoExpandMin The minimum width the <tt>{@link #autoExpandColumn}</tt>
+ * can have (if enabled). Defaults to <tt>50</tt>.
*/
+ autoExpandMin : 50,
+
/**
- * @cfg {Boolean} headersDisabled True to disable the grid column headers (defaults to <tt>false</tt>).
- * Use the {@link Ext.grid.ColumnModel ColumnModel} <tt>{@link Ext.grid.ColumnModel#menuDisabled menuDisabled}</tt>
- * config to disable the <i>menu</i> for individual columns. While this config is true the
- * following will be disabled:<div class="mdetail-params"><ul>
- * <li>clicking on header to sort</li>
- * <li>the trigger to reveal the menu.</li>
- * </ul></div>
+ * @cfg {Boolean} columnLines <tt>true</tt> to add css for column separation lines.
+ * Default is <tt>false</tt>.
*/
+ columnLines : false,
+
/**
- * <p>A customized implementation of a {@link Ext.dd.DragZone DragZone} which provides default implementations
- * of the template methods of DragZone to enable dragging of the selected rows of a GridPanel.
- * See {@link Ext.grid.GridDragZone} for details.</p>
- * <p>This will <b>only</b> be present:<div class="mdetail-params"><ul>
- * <li><i>if</i> the owning GridPanel was configured with {@link Ext.grid.GridPanel#enableDragDrop enableDragDrop}: <tt>true</tt>.</li>
- * <li><i>after</i> the owning GridPanel has been rendered.</li>
- * </ul></div>
- * @property dragZone
- * @type {Ext.grid.GridDragZone}
+ * @cfg {Object} cm Shorthand for <tt>{@link #colModel}</tt>.
*/
/**
- * @cfg {Boolean} deferEmptyText True to defer <tt>{@link #emptyText}</tt> being applied until the store's
- * first load (defaults to <tt>true</tt>).
+ * @cfg {Object} colModel The {@link Ext.grid.ColumnModel} to use when rendering the grid (required).
*/
- deferEmptyText : true,
/**
- * @cfg {Number} scrollOffset The amount of space to reserve for the vertical scrollbar
- * (defaults to <tt>undefined</tt>). If an explicit value isn't specified, this will be automatically
- * calculated.
+ * @cfg {Array} columns An array of {@link Ext.grid.Column columns} to auto create a
+ * {@link Ext.grid.ColumnModel}. The ColumnModel may be explicitly created via the
+ * <tt>{@link #colModel}</tt> configuration property.
*/
- scrollOffset : undefined,
/**
- * @cfg {Boolean} autoFill
- * Defaults to <tt>false</tt>. Specify <tt>true</tt> to have the column widths re-proportioned
- * when the grid is <b>initially rendered</b>. The
- * {@link Ext.grid.Column#width initially configured width}</tt> of each column will be adjusted
- * to fit the grid width and prevent horizontal scrolling. If columns are later resized (manually
- * or programmatically), the other columns in the grid will <b>not</b> be resized to fit the grid width.
- * See <tt>{@link #forceFit}</tt> also.
+ * @cfg {String} ddGroup The DD group this GridPanel belongs to. Defaults to <tt>'GridDD'</tt> if not specified.
*/
- autoFill : false,
/**
- * @cfg {Boolean} forceFit
- * Defaults to <tt>false</tt>. Specify <tt>true</tt> to have the column widths re-proportioned
- * at <b>all times</b>. The {@link Ext.grid.Column#width initially configured width}</tt> of each
- * column will be adjusted to fit the grid width and prevent horizontal scrolling. If columns are
- * later resized (manually or programmatically), the other columns in the grid <b>will</b> be resized
- * to fit the grid width. See <tt>{@link #autoFill}</tt> also.
+ * @cfg {String} ddText
+ * Configures the text in the drag proxy. Defaults to:
+ * <pre><code>
+ * ddText : '{0} selected row{1}'
+ * </code></pre>
+ * <tt>{0}</tt> is replaced with the number of selected rows.
*/
- forceFit : false,
+ ddText : '{0} selected row{1}',
+
/**
- * @cfg {Array} sortClasses The CSS classes applied to a header when it is sorted. (defaults to <tt>['sort-asc', 'sort-desc']</tt>)
+ * @cfg {Boolean} deferRowRender <P>Defaults to <tt>true</tt> to enable deferred row rendering.</p>
+ * <p>This allows the GridPanel to be initially rendered empty, with the expensive update of the row
+ * structure deferred so that layouts with GridPanels appear more quickly.</p>
*/
- sortClasses : ['sort-asc', 'sort-desc'],
+ deferRowRender : true,
+
/**
- * @cfg {String} sortAscText The text displayed in the 'Sort Ascending' menu item (defaults to <tt>'Sort Ascending'</tt>)
+ * @cfg {Boolean} disableSelection <p><tt>true</tt> to disable selections in the grid. Defaults to <tt>false</tt>.</p>
+ * <p>Ignored if a {@link #selModel SelectionModel} is specified.</p>
*/
- sortAscText : 'Sort Ascending',
/**
- * @cfg {String} sortDescText The text displayed in the 'Sort Descending' menu item (defaults to <tt>'Sort Descending'</tt>)
+ * @cfg {Boolean} enableColumnResize <tt>false</tt> to turn off column resizing for the whole grid. Defaults to <tt>true</tt>.
*/
- sortDescText : 'Sort Descending',
/**
- * @cfg {String} columnsText The text displayed in the 'Columns' menu item (defaults to <tt>'Columns'</tt>)
+ * @cfg {Boolean} enableColumnHide
+ * Defaults to <tt>true</tt> to enable {@link Ext.grid.Column#hidden hiding of columns}
+ * with the {@link #enableHdMenu header menu}.
*/
- columnsText : 'Columns',
-
+ enableColumnHide : true,
+
/**
- * @cfg {String} selectedRowClass The CSS class applied to a selected row (defaults to <tt>'x-grid3-row-selected'</tt>). An
- * example overriding the default styling:
- <pre><code>
- .x-grid3-row-selected {background-color: yellow;}
- </code></pre>
- * Note that this only controls the row, and will not do anything for the text inside it. To style inner
- * facets (like text) use something like:
- <pre><code>
- .x-grid3-row-selected .x-grid3-cell-inner {
- color: #FFCC00;
- }
- </code></pre>
- * @type String
+ * @cfg {Boolean} enableColumnMove Defaults to <tt>true</tt> to enable drag and drop reorder of columns. <tt>false</tt>
+ * to turn off column reordering via drag drop.
*/
- selectedRowClass : 'x-grid3-row-selected',
-
- // private
- borderWidth : 2,
- tdClass : 'x-grid3-cell',
- hdCls : 'x-grid3-hd',
- markDirty : true,
-
+ enableColumnMove : true,
+
/**
- * @cfg {Number} cellSelectorDepth The number of levels to search for cells in event delegation (defaults to <tt>4</tt>)
+ * @cfg {Boolean} enableDragDrop <p>Enables dragging of the selected rows of the GridPanel. Defaults to <tt>false</tt>.</p>
+ * <p>Setting this to <b><tt>true</tt></b> causes this GridPanel's {@link #getView GridView} to
+ * create an instance of {@link Ext.grid.GridDragZone}. <b>Note</b>: this is available only <b>after</b>
+ * the Grid has been rendered as the GridView's <tt>{@link Ext.grid.GridView#dragZone dragZone}</tt>
+ * property.</p>
+ * <p>A cooperating {@link Ext.dd.DropZone DropZone} must be created who's implementations of
+ * {@link Ext.dd.DropZone#onNodeEnter onNodeEnter}, {@link Ext.dd.DropZone#onNodeOver onNodeOver},
+ * {@link Ext.dd.DropZone#onNodeOut onNodeOut} and {@link Ext.dd.DropZone#onNodeDrop onNodeDrop} are able
+ * to process the {@link Ext.grid.GridDragZone#getDragData data} which is provided.</p>
*/
- cellSelectorDepth : 4,
+ enableDragDrop : false,
+
/**
- * @cfg {Number} rowSelectorDepth The number of levels to search for rows in event delegation (defaults to <tt>10</tt>)
+ * @cfg {Boolean} enableHdMenu Defaults to <tt>true</tt> to enable the drop down button for menu in the headers.
*/
- rowSelectorDepth : 10,
+ enableHdMenu : true,
+
+ /**
+ * @cfg {Boolean} hideHeaders True to hide the grid's header. Defaults to <code>false</code>.
+ */
+ /**
+ * @cfg {Object} loadMask An {@link Ext.LoadMask} config or true to mask the grid while
+ * loading. Defaults to <code>false</code>.
+ */
+ loadMask : false,
+
+ /**
+ * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if <tt>autoHeight</tt> is not on.
+ */
+ /**
+ * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Defaults to <tt>25</tt>.
+ */
+ minColumnWidth : 25,
+
+ /**
+ * @cfg {Object} sm Shorthand for <tt>{@link #selModel}</tt>.
+ */
+ /**
+ * @cfg {Object} selModel Any subclass of {@link Ext.grid.AbstractSelectionModel} that will provide
+ * the selection model for the grid (defaults to {@link Ext.grid.RowSelectionModel} if not specified).
+ */
+ /**
+ * @cfg {Ext.data.Store} store The {@link Ext.data.Store} the grid should use as its data source (required).
+ */
+ /**
+ * @cfg {Boolean} stripeRows <tt>true</tt> to stripe the rows. Default is <tt>false</tt>.
+ * <p>This causes the CSS class <tt><b>x-grid3-row-alt</b></tt> to be added to alternate rows of
+ * the grid. A default CSS rule is provided which sets a background colour, but you can override this
+ * with a rule which either overrides the <b>background-color</b> style using the '!important'
+ * modifier, or which uses a CSS selector of higher specificity.</p>
+ */
+ stripeRows : false,
+
+ /**
+ * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is <tt>true</tt>
+ * for GridPanel, but <tt>false</tt> for EditorGridPanel.
+ */
+ trackMouseOver : true,
+
+ /**
+ * @cfg {Array} stateEvents
+ * An array of events that, when fired, should trigger this component to save its state.
+ * Defaults to:<pre><code>
+ * stateEvents: ['columnmove', 'columnresize', 'sortchange', 'groupchange']
+ * </code></pre>
+ * <p>These can be any types of events supported by this component, including browser or
+ * custom events (e.g., <tt>['click', 'customerchange']</tt>).</p>
+ * <p>See {@link Ext.Component#stateful} for an explanation of saving and restoring
+ * Component state.</p>
+ */
+ stateEvents : ['columnmove', 'columnresize', 'sortchange', 'groupchange'],
+
+ /**
+ * @cfg {Object} view The {@link Ext.grid.GridView} used by the grid. This can be set
+ * before a call to {@link Ext.Component#render render()}.
+ */
+ view : null,
/**
- * @cfg {String} cellSelector The selector used to find cells internally (defaults to <tt>'td.x-grid3-cell'</tt>)
+ * @cfg {Array} bubbleEvents
+ * <p>An array of events that, when fired, should be bubbled to any parent container.
+ * See {@link Ext.util.Observable#enableBubble}.
+ * Defaults to <tt>[]</tt>.
*/
- cellSelector : 'td.x-grid3-cell',
+ bubbleEvents: [],
+
/**
- * @cfg {String} rowSelector The selector used to find rows internally (defaults to <tt>'div.x-grid3-row'</tt>)
+ * @cfg {Object} viewConfig A config object that will be applied to the grid's UI view. Any of
+ * the config options available for {@link Ext.grid.GridView} can be specified here. This option
+ * is ignored if <tt>{@link #view}</tt> is specified.
*/
- rowSelector : 'div.x-grid3-row',
+
+ // private
+ rendered : false,
// private
- firstRowCls: 'x-grid3-row-first',
- lastRowCls: 'x-grid3-row-last',
- rowClsRe: /(?:^|\s+)x-grid3-row-(first|last|alt)(?:\s+|$)/g,
-
- /* -------------------------------- UI Specific ----------------------------- */
+ viewReady : false,
// private
- initTemplates : function(){
- var ts = this.templates || {};
- if(!ts.master){
- ts.master = new Ext.Template(
- '<div class="x-grid3" hidefocus="true">',
- '<div class="x-grid3-viewport">',
- '<div class="x-grid3-header"><div class="x-grid3-header-inner"><div class="x-grid3-header-offset" style="{ostyle}">{header}</div></div><div class="x-clear"></div></div>',
- '<div class="x-grid3-scroller"><div class="x-grid3-body" style="{bstyle}">{body}</div><a href="#" class="x-grid3-focus" tabIndex="-1"></a></div>',
- '</div>',
- '<div class="x-grid3-resize-marker"> </div>',
- '<div class="x-grid3-resize-proxy"> </div>',
- '</div>'
- );
- }
-
- if(!ts.header){
- ts.header = new Ext.Template(
- '<table border="0" cellspacing="0" cellpadding="0" style="{tstyle}">',
- '<thead><tr class="x-grid3-hd-row">{cells}</tr></thead>',
- '</table>'
- );
- }
-
- if(!ts.hcell){
- ts.hcell = new Ext.Template(
- '<td class="x-grid3-hd x-grid3-cell x-grid3-td-{id} {css}" style="{style}"><div {tooltip} {attr} class="x-grid3-hd-inner x-grid3-hd-{id}" unselectable="on" style="{istyle}">', this.grid.enableHdMenu ? '<a class="x-grid3-hd-btn" href="#"></a>' : '',
- '{value}<img class="x-grid3-sort-icon" src="', Ext.BLANK_IMAGE_URL, '" />',
- '</div></td>'
- );
- }
-
- if(!ts.body){
- ts.body = new Ext.Template('{rows}');
- }
-
- if(!ts.row){
- ts.row = new Ext.Template(
- '<div class="x-grid3-row {alt}" style="{tstyle}"><table class="x-grid3-row-table" border="0" cellspacing="0" cellpadding="0" style="{tstyle}">',
- '<tbody><tr>{cells}</tr>',
- (this.enableRowBody ? '<tr class="x-grid3-row-body-tr" style="{bodyStyle}"><td colspan="{cols}" class="x-grid3-body-cell" tabIndex="0" hidefocus="on"><div class="x-grid3-row-body">{body}</div></td></tr>' : ''),
- '</tbody></table></div>'
- );
- }
-
- if(!ts.cell){
- ts.cell = new Ext.Template(
- '<td class="x-grid3-col x-grid3-cell x-grid3-td-{id} {css}" style="{style}" tabIndex="0" {cellAttr}>',
- '<div class="x-grid3-cell-inner x-grid3-col-{id}" unselectable="on" {attr}>{value}</div>',
- '</td>'
- );
- }
-
- for(var k in ts){
- var t = ts[k];
- if(t && typeof t.compile == 'function' && !t.compiled){
- t.disableFormats = true;
- t.compile();
- }
+ initComponent : function() {
+ Ext.grid.GridPanel.superclass.initComponent.call(this);
+
+ if (this.columnLines) {
+ this.cls = (this.cls || '') + ' x-grid-with-col-lines';
}
+ // override any provided value since it isn't valid
+ // and is causing too many bug reports ;)
+ this.autoScroll = false;
+ this.autoWidth = false;
- this.templates = ts;
- this.colRe = new RegExp('x-grid3-td-([^\\s]+)', '');
- },
+ if(Ext.isArray(this.columns)){
+ this.colModel = new Ext.grid.ColumnModel(this.columns);
+ delete this.columns;
+ }
- // private
- fly : function(el){
- if(!this._flyweight){
- this._flyweight = new Ext.Element.Flyweight(document.body);
+ // check and correct shorthanded configs
+ if(this.ds){
+ this.store = this.ds;
+ delete this.ds;
}
- this._flyweight.dom = el;
- return this._flyweight;
+ if(this.cm){
+ this.colModel = this.cm;
+ delete this.cm;
+ }
+ if(this.sm){
+ this.selModel = this.sm;
+ delete this.sm;
+ }
+ this.store = Ext.StoreMgr.lookup(this.store);
+
+ this.addEvents(
+ // raw events
+ /**
+ * @event click
+ * The raw click event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'click',
+ /**
+ * @event dblclick
+ * The raw dblclick event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'dblclick',
+ /**
+ * @event contextmenu
+ * The raw contextmenu event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'contextmenu',
+ /**
+ * @event mousedown
+ * The raw mousedown event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'mousedown',
+ /**
+ * @event mouseup
+ * The raw mouseup event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'mouseup',
+ /**
+ * @event mouseover
+ * The raw mouseover event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'mouseover',
+ /**
+ * @event mouseout
+ * The raw mouseout event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'mouseout',
+ /**
+ * @event keypress
+ * The raw keypress event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'keypress',
+ /**
+ * @event keydown
+ * The raw keydown event for the entire grid.
+ * @param {Ext.EventObject} e
+ */
+ 'keydown',
+
+ // custom events
+ /**
+ * @event cellmousedown
+ * Fires before a cell is clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'cellmousedown',
+ /**
+ * @event rowmousedown
+ * Fires before a row is clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowmousedown',
+ /**
+ * @event headermousedown
+ * Fires before a header is clicked
+ * @param {Grid} this
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'headermousedown',
+
+ /**
+ * @event groupmousedown
+ * Fires before a group header is clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.
+ * @param {Grid} this
+ * @param {String} groupField
+ * @param {String} groupValue
+ * @param {Ext.EventObject} e
+ */
+ 'groupmousedown',
+
+ /**
+ * @event rowbodymousedown
+ * Fires before the row body is clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowbodymousedown',
+
+ /**
+ * @event containermousedown
+ * Fires before the container is clicked. The container consists of any part of the grid body that is not covered by a row.
+ * @param {Grid} this
+ * @param {Ext.EventObject} e
+ */
+ 'containermousedown',
+
+ /**
+ * @event cellclick
+ * Fires when a cell is clicked.
+ * The data for the cell is drawn from the {@link Ext.data.Record Record}
+ * for this row. To access the data in the listener function use the
+ * following technique:
+ * <pre><code>
+function(grid, rowIndex, columnIndex, e) {
+ var record = grid.getStore().getAt(rowIndex); // Get the Record
+ var fieldName = grid.getColumnModel().getDataIndex(columnIndex); // Get field name
+ var data = record.get(fieldName);
+}
+</code></pre>
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'cellclick',
+ /**
+ * @event celldblclick
+ * Fires when a cell is double clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'celldblclick',
+ /**
+ * @event rowclick
+ * Fires when a row is clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowclick',
+ /**
+ * @event rowdblclick
+ * Fires when a row is double clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowdblclick',
+ /**
+ * @event headerclick
+ * Fires when a header is clicked
+ * @param {Grid} this
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'headerclick',
+ /**
+ * @event headerdblclick
+ * Fires when a header cell is double clicked
+ * @param {Grid} this
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'headerdblclick',
+ /**
+ * @event groupclick
+ * Fires when group header is clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.
+ * @param {Grid} this
+ * @param {String} groupField
+ * @param {String} groupValue
+ * @param {Ext.EventObject} e
+ */
+ 'groupclick',
+ /**
+ * @event groupdblclick
+ * Fires when group header is double clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.
+ * @param {Grid} this
+ * @param {String} groupField
+ * @param {String} groupValue
+ * @param {Ext.EventObject} e
+ */
+ 'groupdblclick',
+ /**
+ * @event containerclick
+ * Fires when the container is clicked. The container consists of any part of the grid body that is not covered by a row.
+ * @param {Grid} this
+ * @param {Ext.EventObject} e
+ */
+ 'containerclick',
+ /**
+ * @event containerdblclick
+ * Fires when the container is double clicked. The container consists of any part of the grid body that is not covered by a row.
+ * @param {Grid} this
+ * @param {Ext.EventObject} e
+ */
+ 'containerdblclick',
+
+ /**
+ * @event rowbodyclick
+ * Fires when the row body is clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowbodyclick',
+ /**
+ * @event rowbodydblclick
+ * Fires when the row body is double clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowbodydblclick',
+
+ /**
+ * @event rowcontextmenu
+ * Fires when a row is right clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowcontextmenu',
+ /**
+ * @event cellcontextmenu
+ * Fires when a cell is right clicked
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Number} cellIndex
+ * @param {Ext.EventObject} e
+ */
+ 'cellcontextmenu',
+ /**
+ * @event headercontextmenu
+ * Fires when a header is right clicked
+ * @param {Grid} this
+ * @param {Number} columnIndex
+ * @param {Ext.EventObject} e
+ */
+ 'headercontextmenu',
+ /**
+ * @event groupcontextmenu
+ * Fires when group header is right clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.
+ * @param {Grid} this
+ * @param {String} groupField
+ * @param {String} groupValue
+ * @param {Ext.EventObject} e
+ */
+ 'groupcontextmenu',
+ /**
+ * @event containercontextmenu
+ * Fires when the container is right clicked. The container consists of any part of the grid body that is not covered by a row.
+ * @param {Grid} this
+ * @param {Ext.EventObject} e
+ */
+ 'containercontextmenu',
+ /**
+ * @event rowbodycontextmenu
+ * Fires when the row body is right clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>
+ * @param {Grid} this
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'rowbodycontextmenu',
+ /**
+ * @event bodyscroll
+ * Fires when the body element is scrolled
+ * @param {Number} scrollLeft
+ * @param {Number} scrollTop
+ */
+ 'bodyscroll',
+ /**
+ * @event columnresize
+ * Fires when the user resizes a column
+ * @param {Number} columnIndex
+ * @param {Number} newSize
+ */
+ 'columnresize',
+ /**
+ * @event columnmove
+ * Fires when the user moves a column
+ * @param {Number} oldIndex
+ * @param {Number} newIndex
+ */
+ 'columnmove',
+ /**
+ * @event sortchange
+ * Fires when the grid's store sort changes
+ * @param {Grid} this
+ * @param {Object} sortInfo An object with the keys field and direction
+ */
+ 'sortchange',
+ /**
+ * @event groupchange
+ * Fires when the grid's grouping changes (only applies for grids with a {@link Ext.grid.GroupingView GroupingView})
+ * @param {Grid} this
+ * @param {String} groupField A string with the grouping field, null if the store is not grouped.
+ */
+ 'groupchange',
+ /**
+ * @event reconfigure
+ * Fires when the grid is reconfigured with a new store and/or column model.
+ * @param {Grid} this
+ * @param {Ext.data.Store} store The new store
+ * @param {Ext.grid.ColumnModel} colModel The new column model
+ */
+ 'reconfigure',
+ /**
+ * @event viewready
+ * Fires when the grid view is available (use this for selecting a default row).
+ * @param {Grid} this
+ */
+ 'viewready'
+ );
},
// private
- getEditorParent : function(){
- return this.scroller.dom;
- },
+ onRender : function(ct, position){
+ Ext.grid.GridPanel.superclass.onRender.apply(this, arguments);
- // private
- initElements : function(){
- var E = Ext.Element;
+ var c = this.getGridEl();
- var el = this.grid.getGridEl().dom.firstChild;
- var cs = el.childNodes;
+ this.el.addClass('x-grid-panel');
- this.el = new E(el);
+ this.mon(c, {
+ scope: this,
+ mousedown: this.onMouseDown,
+ click: this.onClick,
+ dblclick: this.onDblClick,
+ contextmenu: this.onContextMenu
+ });
- this.mainWrap = new E(cs[0]);
- this.mainHd = new E(this.mainWrap.dom.firstChild);
+ this.relayEvents(c, ['mousedown','mouseup','mouseover','mouseout','keypress', 'keydown']);
- if(this.grid.hideHeaders){
- this.mainHd.setDisplayed(false);
- }
+ var view = this.getView();
+ view.init(this);
+ view.render();
+ this.getSelectionModel().init(this);
+ },
- this.innerHd = this.mainHd.dom.firstChild;
- this.scroller = new E(this.mainWrap.dom.childNodes[1]);
- if(this.forceFit){
- this.scroller.setStyle('overflow-x', 'hidden');
+ // private
+ initEvents : function(){
+ Ext.grid.GridPanel.superclass.initEvents.call(this);
+
+ if(this.loadMask){
+ this.loadMask = new Ext.LoadMask(this.bwrap,
+ Ext.apply({store:this.store}, this.loadMask));
+ }
+ },
+
+ initStateEvents : function(){
+ Ext.grid.GridPanel.superclass.initStateEvents.call(this);
+ this.mon(this.colModel, 'hiddenchange', this.saveState, this, {delay: 100});
+ },
+
+ applyState : function(state){
+ var cm = this.colModel,
+ cs = state.columns,
+ store = this.store,
+ s,
+ c,
+ colIndex;
+
+ if(cs){
+ for(var i = 0, len = cs.length; i < len; i++){
+ s = cs[i];
+ c = cm.getColumnById(s.id);
+ if(c){
+ colIndex = cm.getIndexById(s.id);
+ cm.setState(colIndex, {
+ hidden: s.hidden,
+ width: s.width,
+ sortable: s.sortable
+ });
+ if(colIndex != i){
+ cm.moveColumn(colIndex, i);
+ }
+ }
+ }
}
- /**
- * <i>Read-only</i>. The GridView's body Element which encapsulates all rows in the Grid.
- * This {@link Ext.Element Element} is only available after the GridPanel has been rendered.
- * @type Ext.Element
- * @property mainBody
- */
- this.mainBody = new E(this.scroller.dom.firstChild);
-
- this.focusEl = new E(this.scroller.dom.childNodes[1]);
- this.focusEl.swallowEvent('click', true);
+ if(store){
+ s = state.sort;
+ if(s){
+ store[store.remoteSort ? 'setDefaultSort' : 'sort'](s.field, s.direction);
+ }
+ s = state.group;
+ if(store.groupBy){
+ if(s){
+ store.groupBy(s);
+ }else{
+ store.clearGrouping();
+ }
+ }
- this.resizeMarker = new E(cs[1]);
- this.resizeProxy = new E(cs[2]);
+ }
+ var o = Ext.apply({}, state);
+ delete o.columns;
+ delete o.sort;
+ Ext.grid.GridPanel.superclass.applyState.call(this, o);
},
- // private
- getRows : function(){
- return this.hasRows() ? this.mainBody.dom.childNodes : [];
- },
+ getState : function(){
+ var o = {columns: []},
+ store = this.store,
+ ss,
+ gs;
- // finder methods, used with delegation
+ for(var i = 0, c; (c = this.colModel.config[i]); i++){
+ o.columns[i] = {
+ id: c.id,
+ width: c.width
+ };
+ if(c.hidden){
+ o.columns[i].hidden = true;
+ }
+ if(c.sortable){
+ o.columns[i].sortable = true;
+ }
+ }
+ if(store){
+ ss = store.getSortState();
+ if(ss){
+ o.sort = ss;
+ }
+ if(store.getGroupState){
+ gs = store.getGroupState();
+ if(gs){
+ o.group = gs;
+ }
+ }
+ }
+ return o;
+ },
// private
- findCell : function(el){
- if(!el){
- return false;
+ afterRender : function(){
+ Ext.grid.GridPanel.superclass.afterRender.call(this);
+ var v = this.view;
+ this.on('bodyresize', v.layout, v);
+ v.layout(true);
+ if(this.deferRowRender){
+ if (!this.deferRowRenderTask){
+ this.deferRowRenderTask = new Ext.util.DelayedTask(v.afterRender, this.view);
+ }
+ this.deferRowRenderTask.delay(10);
+ }else{
+ v.afterRender();
}
- return this.fly(el).findParent(this.cellSelector, this.cellSelectorDepth);
+ this.viewReady = true;
},
/**
- * <p>Return the index of the grid column which contains the passed HTMLElement.</p>
- * See also {@link #findRowIndex}
- * @param {HTMLElement} el The target element
- * @return {Number} The column index, or <b>false</b> if the target element is not within a row of this GridView.
+ * <p>Reconfigures the grid to use a different Store and Column Model
+ * and fires the 'reconfigure' event. The View will be bound to the new
+ * objects and refreshed.</p>
+ * <p>Be aware that upon reconfiguring a GridPanel, certain existing settings <i>may</i> become
+ * invalidated. For example the configured {@link #autoExpandColumn} may no longer exist in the
+ * new ColumnModel. Also, an existing {@link Ext.PagingToolbar PagingToolbar} will still be bound
+ * to the old Store, and will need rebinding. Any {@link #plugins} might also need reconfiguring
+ * with the new data.</p>
+ * @param {Ext.data.Store} store The new {@link Ext.data.Store} object
+ * @param {Ext.grid.ColumnModel} colModel The new {@link Ext.grid.ColumnModel} object
*/
- findCellIndex : function(el, requiredCls){
- var cell = this.findCell(el);
- if(cell && (!requiredCls || this.fly(cell).hasClass(requiredCls))){
- return this.getCellIndex(cell);
- }
- return false;
- },
-
- // private
- getCellIndex : function(el){
- if(el){
- var m = el.className.match(this.colRe);
- if(m && m[1]){
- return this.cm.getIndexById(m[1]);
+ reconfigure : function(store, colModel){
+ var rendered = this.rendered;
+ if(rendered){
+ if(this.loadMask){
+ this.loadMask.destroy();
+ this.loadMask = new Ext.LoadMask(this.bwrap,
+ Ext.apply({}, {store:store}, this.initialConfig.loadMask));
}
}
- return false;
- },
-
- // private
- findHeaderCell : function(el){
- var cell = this.findCell(el);
- return cell && this.fly(cell).hasClass(this.hdCls) ? cell : null;
- },
-
- // private
- findHeaderIndex : function(el){
- return this.findCellIndex(el, this.hdCls);
- },
-
- /**
- * Return the HtmlElement representing the grid row which contains the passed element.
- * @param {HTMLElement} el The target HTMLElement
- * @return {HTMLElement} The row element, or null if the target element is not within a row of this GridView.
- */
- findRow : function(el){
- if(!el){
- return false;
+ if(this.view){
+ this.view.initData(store, colModel);
}
- return this.fly(el).findParent(this.rowSelector, this.rowSelectorDepth);
- },
-
- /**
- * <p>Return the index of the grid row which contains the passed HTMLElement.</p>
- * See also {@link #findCellIndex}
- * @param {HTMLElement} el The target HTMLElement
- * @return {Number} The row index, or <b>false</b> if the target element is not within a row of this GridView.
- */
- findRowIndex : function(el){
- var r = this.findRow(el);
- return r ? r.rowIndex : false;
- },
-
- // getter methods for fetching elements dynamically in the grid
-
- /**
- * Return the <tt><div></tt> HtmlElement which represents a Grid row for the specified index.
- * @param {Number} index The row index
- * @return {HtmlElement} The div element.
- */
- getRow : function(row){
- return this.getRows()[row];
- },
-
- /**
- * Returns the grid's <tt><td></tt> HtmlElement at the specified coordinates.
- * @param {Number} row The row index in which to find the cell.
- * @param {Number} col The column index of the cell.
- * @return {HtmlElement} The td at the specified coordinates.
- */
- getCell : function(row, col){
- return this.getRow(row).getElementsByTagName('td')[col];
- },
-
- /**
- * Return the <tt><td></tt> HtmlElement which represents the Grid's header cell for the specified column index.
- * @param {Number} index The column index
- * @return {HtmlElement} The td element.
- */
- getHeaderCell : function(index){
- return this.mainHd.dom.getElementsByTagName('td')[index];
- },
-
- // manipulating elements
-
- // private - use getRowClass to apply custom row classes
- addRowClass : function(row, cls){
- var r = this.getRow(row);
- if(r){
- this.fly(r).addClass(cls);
+ this.store = store;
+ this.colModel = colModel;
+ if(rendered){
+ this.view.refresh(true);
}
+ this.fireEvent('reconfigure', this, store, colModel);
},
// private
- removeRowClass : function(row, cls){
- var r = this.getRow(row);
- if(r){
- this.fly(r).removeClass(cls);
+ onDestroy : function(){
+ if (this.deferRowRenderTask && this.deferRowRenderTask.cancel){
+ this.deferRowRenderTask.cancel();
}
- },
-
- // private
- removeRow : function(row){
- Ext.removeNode(this.getRow(row));
- this.syncFocusEl(row);
- },
-
- // private
- removeRows : function(firstRow, lastRow){
- var bd = this.mainBody.dom;
- for(var rowIndex = firstRow; rowIndex <= lastRow; rowIndex++){
- Ext.removeNode(bd.childNodes[firstRow]);
+ if(this.rendered){
+ Ext.destroy(this.view, this.loadMask);
+ }else if(this.store && this.store.autoDestroy){
+ this.store.destroy();
}
- this.syncFocusEl(firstRow);
- },
-
- // scrolling stuff
-
- // private
- getScrollState : function(){
- var sb = this.scroller.dom;
- return {left: sb.scrollLeft, top: sb.scrollTop};
- },
-
- // private
- restoreScroll : function(state){
- var sb = this.scroller.dom;
- sb.scrollLeft = state.left;
- sb.scrollTop = state.top;
- },
-
- /**
- * Scrolls the grid to the top
- */
- scrollToTop : function(){
- this.scroller.dom.scrollTop = 0;
- this.scroller.dom.scrollLeft = 0;
+ Ext.destroy(this.colModel, this.selModel);
+ this.store = this.selModel = this.colModel = this.view = this.loadMask = null;
+ Ext.grid.GridPanel.superclass.onDestroy.call(this);
},
// private
- syncScroll : function(){
- this.syncHeaderScroll();
- var mb = this.scroller.dom;
- this.grid.fireEvent('bodyscroll', mb.scrollLeft, mb.scrollTop);
+ processEvent : function(name, e){
+ this.view.processEvent(name, e);
},
// private
- syncHeaderScroll : function(){
- var mb = this.scroller.dom;
- this.innerHd.scrollLeft = mb.scrollLeft;
- this.innerHd.scrollLeft = mb.scrollLeft; // second time for IE (1/2 time first fails, other browsers ignore)
+ onClick : function(e){
+ this.processEvent('click', e);
},
// private
- updateSortIcon : function(col, dir){
- var sc = this.sortClasses;
- var hds = this.mainHd.select('td').removeClass(sc);
- hds.item(col).addClass(sc[dir == 'DESC' ? 1 : 0]);
+ onMouseDown : function(e){
+ this.processEvent('mousedown', e);
},
// private
- updateAllColumnWidths : function(){
- var tw = this.getTotalWidth(),
- clen = this.cm.getColumnCount(),
- ws = [],
- len,
- i;
- for(i = 0; i < clen; i++){
- ws[i] = this.getColumnWidth(i);
- }
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = tw;
- this.mainBody.dom.style.width = tw;
- for(i = 0; i < clen; i++){
- var hd = this.getHeaderCell(i);
- hd.style.width = ws[i];
- }
-
- var ns = this.getRows(), row, trow;
- for(i = 0, len = ns.length; i < len; i++){
- row = ns[i];
- row.style.width = tw;
- if(row.firstChild){
- row.firstChild.style.width = tw;
- trow = row.firstChild.rows[0];
- for (var j = 0; j < clen; j++) {
- trow.childNodes[j].style.width = ws[j];
- }
- }
- }
-
- this.onAllColumnWidthsUpdated(ws, tw);
+ onContextMenu : function(e, t){
+ this.processEvent('contextmenu', e);
},
// private
- updateColumnWidth : function(col, width){
- var w = this.getColumnWidth(col);
- var tw = this.getTotalWidth();
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = tw;
- this.mainBody.dom.style.width = tw;
- var hd = this.getHeaderCell(col);
- hd.style.width = w;
-
- var ns = this.getRows(), row;
- for(var i = 0, len = ns.length; i < len; i++){
- row = ns[i];
- row.style.width = tw;
- if(row.firstChild){
- row.firstChild.style.width = tw;
- row.firstChild.rows[0].childNodes[col].style.width = w;
- }
- }
-
- this.onColumnWidthUpdated(col, w, tw);
+ onDblClick : function(e){
+ this.processEvent('dblclick', e);
},
// private
- updateColumnHidden : function(col, hidden){
- var tw = this.getTotalWidth();
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = tw;
- this.mainBody.dom.style.width = tw;
- var display = hidden ? 'none' : '';
-
- var hd = this.getHeaderCell(col);
- hd.style.display = display;
-
- var ns = this.getRows(), row;
- for(var i = 0, len = ns.length; i < len; i++){
- row = ns[i];
- row.style.width = tw;
- if(row.firstChild){
- row.firstChild.style.width = tw;
- row.firstChild.rows[0].childNodes[col].style.display = display;
+ walkCells : function(row, col, step, fn, scope){
+ var cm = this.colModel,
+ clen = cm.getColumnCount(),
+ ds = this.store,
+ rlen = ds.getCount(),
+ first = true;
+
+ if(step < 0){
+ if(col < 0){
+ row--;
+ first = false;
}
- }
-
- this.onColumnHiddenUpdated(col, hidden, tw);
- delete this.lastViewWidth; // force recalc
- this.layout();
- },
-
- // private
- doRender : function(cs, rs, ds, startRow, colCount, stripe){
- var ts = this.templates, ct = ts.cell, rt = ts.row, last = colCount-1;
- var tstyle = 'width:'+this.getTotalWidth()+';';
- // buffers
- var buf = [], cb, c, p = {}, rp = {tstyle: tstyle}, r;
- for(var j = 0, len = rs.length; j < len; j++){
- r = rs[j]; cb = [];
- var rowIndex = (j+startRow);
- for(var i = 0; i < colCount; i++){
- c = cs[i];
- p.id = c.id;
- p.css = i === 0 ? 'x-grid3-cell-first ' : (i == last ? 'x-grid3-cell-last ' : '');
- p.attr = p.cellAttr = '';
- p.value = c.renderer(r.data[c.name], p, r, rowIndex, i, ds);
- p.style = c.style;
- if(Ext.isEmpty(p.value)){
- p.value = ' ';
+ while(row >= 0){
+ if(!first){
+ col = clen-1;
}
- if(this.markDirty && r.dirty && typeof r.modified[c.name] !== 'undefined'){
- p.css += ' x-grid3-dirty-cell';
+ first = false;
+ while(col >= 0){
+ if(fn.call(scope || this, row, col, cm) === true){
+ return [row, col];
+ }
+ col--;
}
- cb[cb.length] = ct.apply(p);
- }
- var alt = [];
- if(stripe && ((rowIndex+1) % 2 === 0)){
- alt[0] = 'x-grid3-row-alt';
+ row--;
}
- if(r.dirty){
- alt[1] = ' x-grid3-dirty-row';
- }
- rp.cols = colCount;
- if(this.getRowClass){
- alt[2] = this.getRowClass(r, rowIndex, rp, ds);
+ } else {
+ if(col >= clen){
+ row++;
+ first = false;
}
- rp.alt = alt.join(' ');
- rp.cells = cb.join('');
- buf[buf.length] = rt.apply(rp);
- }
- return buf.join('');
- },
-
- // private
- processRows : function(startRow, skipStripe){
- if(!this.ds || this.ds.getCount() < 1){
- return;
- }
- var rows = this.getRows();
- skipStripe = skipStripe || !this.grid.stripeRows;
- startRow = startRow || 0;
- Ext.each(rows, function(row, idx){
- row.rowIndex = idx;
- if(!skipStripe){
- row.className = row.className.replace(this.rowClsRe, ' ');
- if ((idx + 1) % 2 === 0){
- row.className += ' x-grid3-row-alt';
+ while(row < rlen){
+ if(!first){
+ col = 0;
+ }
+ first = false;
+ while(col < clen){
+ if(fn.call(scope || this, row, col, cm) === true){
+ return [row, col];
+ }
+ col++;
}
+ row++;
}
- }, this);
- // add first/last-row classes
- if(startRow === 0){
- Ext.fly(rows[0]).addClass(this.firstRowCls);
- }
- Ext.fly(rows[rows.length - 1]).addClass(this.lastRowCls);
- },
-
- afterRender : function(){
- if(!this.ds || !this.cm){
- return;
- }
- this.mainBody.dom.innerHTML = this.renderRows() || ' ';
- this.processRows(0, true);
-
- if(this.deferEmptyText !== true){
- this.applyEmptyText();
}
+ return null;
},
- // private
- renderUI : function(){
-
- var header = this.renderHeaders();
- var body = this.templates.body.apply({rows:' '});
-
-
- var html = this.templates.master.apply({
- body: body,
- header: header,
- ostyle: 'width:'+this.getOffsetWidth()+';',
- bstyle: 'width:'+this.getTotalWidth()+';'
- });
-
- var g = this.grid;
-
- g.getGridEl().dom.innerHTML = html;
-
- this.initElements();
-
- // get mousedowns early
- Ext.fly(this.innerHd).on('click', this.handleHdDown, this);
- this.mainHd.on({
- scope: this,
- mouseover: this.handleHdOver,
- mouseout: this.handleHdOut,
- mousemove: this.handleHdMove
- });
-
- this.scroller.on('scroll', this.syncScroll, this);
- if(g.enableColumnResize !== false){
- this.splitZone = new Ext.grid.GridView.SplitDragZone(g, this.mainHd.dom);
- }
-
- if(g.enableColumnMove){
- this.columnDrag = new Ext.grid.GridView.ColumnDragZone(g, this.innerHd);
- this.columnDrop = new Ext.grid.HeaderDropZone(g, this.mainHd.dom);
- }
-
- if(g.enableHdMenu !== false){
- this.hmenu = new Ext.menu.Menu({id: g.id + '-hctx'});
- this.hmenu.add(
- {itemId:'asc', text: this.sortAscText, cls: 'xg-hmenu-sort-asc'},
- {itemId:'desc', text: this.sortDescText, cls: 'xg-hmenu-sort-desc'}
- );
- if(g.enableColumnHide !== false){
- this.colMenu = new Ext.menu.Menu({id:g.id + '-hcols-menu'});
- this.colMenu.on({
- scope: this,
- beforeshow: this.beforeColMenuShow,
- itemclick: this.handleHdMenuClick
- });
- this.hmenu.add('-', {
- itemId:'columns',
- hideOnClick: false,
- text: this.columnsText,
- menu: this.colMenu,
- iconCls: 'x-cols-icon'
- });
- }
- this.hmenu.on('itemclick', this.handleHdMenuClick, this);
- }
-
- if(g.trackMouseOver){
- this.mainBody.on({
- scope: this,
- mouseover: this.onRowOver,
- mouseout: this.onRowOut
- });
- }
-
- if(g.enableDragDrop || g.enableDrag){
- this.dragZone = new Ext.grid.GridDragZone(g, {
- ddGroup : g.ddGroup || 'GridDD'
- });
- }
-
- this.updateHeaderSortState();
-
+ /**
+ * Returns the grid's underlying element.
+ * @return {Element} The element
+ */
+ getGridEl : function(){
+ return this.body;
},
- // private
- layout : function(){
- if(!this.mainBody){
- return; // not rendered
- }
- var g = this.grid;
- var c = g.getGridEl();
- var csize = c.getSize(true);
- var vw = csize.width;
-
- if(!g.hideHeaders && (vw < 20 || csize.height < 20)){ // display: none?
- return;
- }
-
- if(g.autoHeight){
- this.scroller.dom.style.overflow = 'visible';
- if(Ext.isWebKit){
- this.scroller.dom.style.position = 'static';
- }
- }else{
- this.el.setSize(csize.width, csize.height);
-
- var hdHeight = this.mainHd.getHeight();
- var vh = csize.height - (hdHeight);
+ // private for compatibility, overridden by editor grid
+ stopEditing : Ext.emptyFn,
- this.scroller.setSize(vw, vh);
- if(this.innerHd){
- this.innerHd.style.width = (vw)+'px';
- }
- }
- if(this.forceFit){
- if(this.lastViewWidth != vw){
- this.fitColumns(false, false);
- this.lastViewWidth = vw;
- }
- }else {
- this.autoExpand();
- this.syncHeaderScroll();
+ /**
+ * Returns the grid's selection model configured by the <code>{@link #selModel}</code>
+ * configuration option. If no selection model was configured, this will create
+ * and return a {@link Ext.grid.RowSelectionModel RowSelectionModel}.
+ * @return {SelectionModel}
+ */
+ getSelectionModel : function(){
+ if(!this.selModel){
+ this.selModel = new Ext.grid.RowSelectionModel(
+ this.disableSelection ? {selectRow: Ext.emptyFn} : null);
}
- this.onLayout(vw, vh);
- },
-
- // template functions for subclasses and plugins
- // these functions include precalculated values
- onLayout : function(vw, vh){
- // do nothing
- },
-
- onColumnWidthUpdated : function(col, w, tw){
- //template method
- },
-
- onAllColumnWidthsUpdated : function(ws, tw){
- //template method
- },
-
- onColumnHiddenUpdated : function(col, hidden, tw){
- // template method
- },
-
- updateColumnText : function(col, text){
- // template method
+ return this.selModel;
},
- afterMove : function(colIndex){
- // template method
- },
-
- /* ----------------------------------- Core Specific -------------------------------------------*/
- // private
- init : function(grid){
- this.grid = grid;
-
- this.initTemplates();
- this.initData(grid.store, grid.colModel);
- this.initUI(grid);
+ /**
+ * Returns the grid's data store.
+ * @return {Ext.data.Store} The store
+ */
+ getStore : function(){
+ return this.store;
},
- // private
- getColumnId : function(index){
- return this.cm.getColumnId(index);
- },
-
- // private
- getOffsetWidth : function() {
- return (this.cm.getTotalWidth() + this.getScrollOffset()) + 'px';
- },
-
- getScrollOffset: function(){
- return Ext.num(this.scrollOffset, Ext.getScrollBarWidth());
+ /**
+ * Returns the grid's ColumnModel.
+ * @return {Ext.grid.ColumnModel} The column model
+ */
+ getColumnModel : function(){
+ return this.colModel;
},
- // private
- renderHeaders : function(){
- var cm = this.cm,
- ts = this.templates,
- ct = ts.hcell,
- cb = [],
- p = {},
- len = cm.getColumnCount(),
- last = len - 1;
-
- for(var i = 0; i < len; i++){
- p.id = cm.getColumnId(i);
- p.value = cm.getColumnHeader(i) || '';
- p.style = this.getColumnStyle(i, true);
- p.tooltip = this.getColumnTooltip(i);
- p.css = i === 0 ? 'x-grid3-cell-first ' : (i == last ? 'x-grid3-cell-last ' : '');
- if(cm.config[i].align == 'right'){
- p.istyle = 'padding-right:16px';
- } else {
- delete p.istyle;
- }
- cb[cb.length] = ct.apply(p);
+ /**
+ * Returns the grid's GridView object.
+ * @return {Ext.grid.GridView} The grid view
+ */
+ getView : function() {
+ if (!this.view) {
+ this.view = new Ext.grid.GridView(this.viewConfig);
}
- return ts.header.apply({cells: cb.join(''), tstyle:'width:'+this.getTotalWidth()+';'});
+
+ return this.view;
},
-
+ /**
+ * Called to get grid's drag proxy text, by default returns this.ddText.
+ * @return {String} The text
+ */
+ getDragDropText : function(){
+ var count = this.selModel.getCount();
+ return String.format(this.ddText, count, count == 1 ? '' : 's');
+ }
+
+ /**
+ * @cfg {String/Number} activeItem
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} autoDestroy
+ * @hide
+ */
+ /**
+ * @cfg {Object/String/Function} autoLoad
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} autoWidth
+ * @hide
+ */
+ /**
+ * @cfg {Boolean/Number} bufferResize
+ * @hide
+ */
+ /**
+ * @cfg {String} defaultType
+ * @hide
+ */
+ /**
+ * @cfg {Object} defaults
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} hideBorders
+ * @hide
+ */
+ /**
+ * @cfg {Mixed} items
+ * @hide
+ */
+ /**
+ * @cfg {String} layout
+ * @hide
+ */
+ /**
+ * @cfg {Object} layoutConfig
+ * @hide
+ */
+ /**
+ * @cfg {Boolean} monitorResize
+ * @hide
+ */
+ /**
+ * @property items
+ * @hide
+ */
+ /**
+ * @method add
+ * @hide
+ */
+ /**
+ * @method cascade
+ * @hide
+ */
+ /**
+ * @method doLayout
+ * @hide
+ */
+ /**
+ * @method find
+ * @hide
+ */
+ /**
+ * @method findBy
+ * @hide
+ */
+ /**
+ * @method findById
+ * @hide
+ */
+ /**
+ * @method findByType
+ * @hide
+ */
+ /**
+ * @method getComponent
+ * @hide
+ */
+ /**
+ * @method getLayout
+ * @hide
+ */
+ /**
+ * @method getUpdater
+ * @hide
+ */
+ /**
+ * @method insert
+ * @hide
+ */
+ /**
+ * @method load
+ * @hide
+ */
+ /**
+ * @method remove
+ * @hide
+ */
+ /**
+ * @event add
+ * @hide
+ */
+ /**
+ * @event afterlayout
+ * @hide
+ */
+ /**
+ * @event beforeadd
+ * @hide
+ */
+ /**
+ * @event beforeremove
+ * @hide
+ */
+ /**
+ * @event remove
+ * @hide
+ */
+
+
+
+ /**
+ * @cfg {String} allowDomMove @hide
+ */
+ /**
+ * @cfg {String} autoEl @hide
+ */
+ /**
+ * @cfg {String} applyTo @hide
+ */
+ /**
+ * @cfg {String} autoScroll @hide
+ */
+ /**
+ * @cfg {String} bodyBorder @hide
+ */
+ /**
+ * @cfg {String} bodyStyle @hide
+ */
+ /**
+ * @cfg {String} contentEl @hide
+ */
+ /**
+ * @cfg {String} disabledClass @hide
+ */
+ /**
+ * @cfg {String} elements @hide
+ */
+ /**
+ * @cfg {String} html @hide
+ */
+ /**
+ * @cfg {Boolean} preventBodyReset
+ * @hide
+ */
+ /**
+ * @property disabled
+ * @hide
+ */
+ /**
+ * @method applyToMarkup
+ * @hide
+ */
+ /**
+ * @method enable
+ * @hide
+ */
+ /**
+ * @method disable
+ * @hide
+ */
+ /**
+ * @method setDisabled
+ * @hide
+ */
+});
+Ext.reg('grid', Ext.grid.GridPanel);/**
+ * @class Ext.grid.PivotGrid
+ * @extends Ext.grid.GridPanel
+ * <p>The PivotGrid component enables rapid summarization of large data sets. It provides a way to reduce a large set of
+ * data down into a format where trends and insights become more apparent. A classic example is in sales data; a company
+ * will often have a record of all sales it makes for a given period - this will often encompass thousands of rows of
+ * data. The PivotGrid allows you to see how well each salesperson performed, which cities generate the most revenue,
+ * how products perform between cities and so on.</p>
+ * <p>A PivotGrid is composed of two axes (left and top), one {@link #measure} and one {@link #aggregator aggregation}
+ * function. Each axis can contain one or more {@link #dimension}, which are ordered into a hierarchy. Dimensions on the
+ * left axis can also specify a width. Each dimension in each axis can specify its sort ordering, defaulting to "ASC",
+ * and must specify one of the fields in the {@link Ext.data.Record Record} used by the PivotGrid's
+ * {@link Ext.data.Store Store}.</p>
+<pre><code>
+// This is the record representing a single sale
+var SaleRecord = Ext.data.Record.create([
+ {name: 'person', type: 'string'},
+ {name: 'product', type: 'string'},
+ {name: 'city', type: 'string'},
+ {name: 'state', type: 'string'},
+ {name: 'year', type: 'int'},
+ {name: 'value', type: 'int'}
+]);
+
+// A simple store that loads SaleRecord data from a url
+var myStore = new Ext.data.Store({
+ url: 'data.json',
+ autoLoad: true,
+ reader: new Ext.data.JsonReader({
+ root: 'rows',
+ idProperty: 'id'
+ }, SaleRecord)
+});
+
+// Create the PivotGrid itself, referencing the store
+var pivot = new Ext.grid.PivotGrid({
+ store : myStore,
+ aggregator: 'sum',
+ measure : 'value',
+
+ leftAxis: [
+ {
+ width: 60,
+ dataIndex: 'product'
+ },
+ {
+ width: 120,
+ dataIndex: 'person',
+ direction: 'DESC'
+ }
+ ],
+
+ topAxis: [
+ {
+ dataIndex: 'year'
+ }
+ ]
+});
+</code></pre>
+ * <p>The specified {@link #measure} is the field from SaleRecord that is extracted from each combination
+ * of product and person (on the left axis) and year on the top axis. There may be several SaleRecords in the
+ * data set that share this combination, so an array of measure fields is produced. This array is then
+ * aggregated using the {@link #aggregator} function.</p>
+ * <p>The default aggregator function is sum, which simply adds up all of the extracted measure values. Other
+ * built-in aggregator functions are count, avg, min and max. In addition, you can specify your own function.
+ * In this example we show the code used to sum the measures, but you can return any value you like. See
+ * {@link #aggregator} for more details.</p>
+<pre><code>
+new Ext.grid.PivotGrid({
+ aggregator: function(records, measure) {
+ var length = records.length,
+ total = 0,
+ i;
+
+ for (i = 0; i < length; i++) {
+ total += records[i].get(measure);
+ }
+
+ return total;
+ },
+
+ renderer: function(value) {
+ return Math.round(value);
+ },
+
+ //your normal config here
+});
+</code></pre>
+ * <p><u>Renderers</u></p>
+ * <p>PivotGrid optionally accepts a {@link #renderer} function which can modify the data in each cell before it
+ * is rendered. The renderer is passed the value that would usually be placed in the cell and is expected to return
+ * the new value. For example let's imagine we had height data expressed as a decimal - here's how we might use a
+ * renderer to display the data in feet and inches notation:</p>
+<pre><code>
+new Ext.grid.PivotGrid({
+ //in each case the value is a decimal number of feet
+ renderer : function(value) {
+ var feet = Math.floor(value),
+ inches = Math.round((value - feet) * 12);
+
+ return String.format("{0}' {1}\"", feet, inches);
+ },
+ //normal config here
+});
+</code></pre>
+ * <p><u>Reconfiguring</u></p>
+ * <p>All aspects PivotGrid's configuration can be updated at runtime. It is easy to change the {@link #setMeasure measure},
+ * {@link #setAggregator aggregation function}, {@link #setLeftAxis left} and {@link #setTopAxis top} axes and refresh the grid.</p>
+ * <p>In this case we reconfigure the PivotGrid to have city and year as the top axis dimensions, rendering the average sale
+ * value into the cells:</p>
+<pre><code>
+//the left axis can also be changed
+pivot.topAxis.setDimensions([
+ {dataIndex: 'city', direction: 'DESC'},
+ {dataIndex: 'year', direction: 'ASC'}
+]);
+
+pivot.setMeasure('value');
+pivot.setAggregator('avg');
+
+pivot.view.refresh(true);
+</code></pre>
+ * <p>See the {@link Ext.grid.PivotAxis PivotAxis} documentation for further detail on reconfiguring axes.</p>
+ */
+Ext.grid.PivotGrid = Ext.extend(Ext.grid.GridPanel, {
+
+ /**
+ * @cfg {String|Function} aggregator The aggregation function to use to combine the measures extracted
+ * for each dimension combination. Can be any of the built-in aggregators (sum, count, avg, min, max).
+ * Can also be a function which accepts two arguments (an array of Records to aggregate, and the measure
+ * to aggregate them on) and should return a String.
+ */
+ aggregator: 'sum',
+
+ /**
+ * @cfg {Function} renderer Optional renderer to pass values through before they are rendered to the dom. This
+ * gives an opportunity to modify cell contents after the value has been computed.
+ */
+ renderer: undefined,
+
+ /**
+ * @cfg {String} measure The field to extract from each Record when pivoting around the two axes. See the class
+ * introduction docs for usage
+ */
+
+ /**
+ * @cfg {Array|Ext.grid.PivotAxis} leftAxis Either and array of {@link #dimension} to use on the left axis, or
+ * a {@link Ext.grid.PivotAxis} instance. If an array is passed, it is turned into a PivotAxis internally.
+ */
+
+ /**
+ * @cfg {Array|Ext.grid.PivotAxis} topAxis Either and array of {@link #dimension} to use on the top axis, or
+ * a {@link Ext.grid.PivotAxis} instance. If an array is passed, it is turned into a PivotAxis internally.
+ */
+
+ //inherit docs
+ initComponent: function() {
+ Ext.grid.PivotGrid.superclass.initComponent.apply(this, arguments);
+
+ this.initAxes();
+
+ //no resizing of columns is allowed yet in PivotGrid
+ this.enableColumnResize = false;
+
+ this.viewConfig = Ext.apply(this.viewConfig || {}, {
+ forceFit: true
+ });
+
+ //TODO: dummy col model that is never used - GridView is too tightly integrated with ColumnModel
+ //in 3.x to remove this altogether.
+ this.colModel = new Ext.grid.ColumnModel({});
+ },
+
+ /**
+ * Returns the function currently used to aggregate the records in each Pivot cell
+ * @return {Function} The current aggregator function
+ */
+ getAggregator: function() {
+ if (typeof this.aggregator == 'string') {
+ return Ext.grid.PivotAggregatorMgr.types[this.aggregator];
+ } else {
+ return this.aggregator;
+ }
+ },
+
+ /**
+ * Sets the function to use when aggregating data for each cell.
+ * @param {String|Function} aggregator The new aggregator function or named function string
+ */
+ setAggregator: function(aggregator) {
+ this.aggregator = aggregator;
+ },
+
+ /**
+ * Sets the field name to use as the Measure in this Pivot Grid
+ * @param {String} measure The field to make the measure
+ */
+ setMeasure: function(measure) {
+ this.measure = measure;
+ },
+
+ /**
+ * Sets the left axis of this pivot grid. Optionally refreshes the grid afterwards.
+ * @param {Ext.grid.PivotAxis} axis The pivot axis
+ * @param {Boolean} refresh True to immediately refresh the grid and its axes (defaults to false)
+ */
+ setLeftAxis: function(axis, refresh) {
+ /**
+ * The configured {@link Ext.grid.PivotAxis} used as the left Axis for this Pivot Grid
+ * @property leftAxis
+ * @type Ext.grid.PivotAxis
+ */
+ this.leftAxis = axis;
+
+ if (refresh) {
+ this.view.refresh();
+ }
+ },
+
+ /**
+ * Sets the top axis of this pivot grid. Optionally refreshes the grid afterwards.
+ * @param {Ext.grid.PivotAxis} axis The pivot axis
+ * @param {Boolean} refresh True to immediately refresh the grid and its axes (defaults to false)
+ */
+ setTopAxis: function(axis, refresh) {
+ /**
+ * The configured {@link Ext.grid.PivotAxis} used as the top Axis for this Pivot Grid
+ * @property topAxis
+ * @type Ext.grid.PivotAxis
+ */
+ this.topAxis = axis;
+
+ if (refresh) {
+ this.view.refresh();
+ }
+ },
+
+ /**
+ * @private
+ * Creates the top and left axes. Should usually only need to be called once from initComponent
+ */
+ initAxes: function() {
+ var PivotAxis = Ext.grid.PivotAxis;
+
+ if (!(this.leftAxis instanceof PivotAxis)) {
+ this.setLeftAxis(new PivotAxis({
+ orientation: 'vertical',
+ dimensions : this.leftAxis || [],
+ store : this.store
+ }));
+ };
+
+ if (!(this.topAxis instanceof PivotAxis)) {
+ this.setTopAxis(new PivotAxis({
+ orientation: 'horizontal',
+ dimensions : this.topAxis || [],
+ store : this.store
+ }));
+ };
+ },
+
+ /**
+ * @private
+ * @return {Array} 2-dimensional array of cell data
+ */
+ extractData: function() {
+ var records = this.store.data.items,
+ recCount = records.length,
+ cells = [],
+ record, i, j, k;
+
+ if (recCount == 0) {
+ return [];
+ }
+
+ var leftTuples = this.leftAxis.getTuples(),
+ leftCount = leftTuples.length,
+ topTuples = this.topAxis.getTuples(),
+ topCount = topTuples.length,
+ aggregator = this.getAggregator();
+
+ for (i = 0; i < recCount; i++) {
+ record = records[i];
+
+ for (j = 0; j < leftCount; j++) {
+ cells[j] = cells[j] || [];
+
+ if (leftTuples[j].matcher(record) === true) {
+ for (k = 0; k < topCount; k++) {
+ cells[j][k] = cells[j][k] || [];
+
+ if (topTuples[k].matcher(record)) {
+ cells[j][k].push(record);
+ }
+ }
+ }
+ }
+ }
+
+ var rowCount = cells.length,
+ colCount, row;
+
+ for (i = 0; i < rowCount; i++) {
+ row = cells[i];
+ colCount = row.length;
+
+ for (j = 0; j < colCount; j++) {
+ cells[i][j] = aggregator(cells[i][j], this.measure);
+ }
+ }
+
+ return cells;
+ },
+
+ /**
+ * Returns the grid's GridView object.
+ * @return {Ext.grid.PivotGridView} The grid view
+ */
+ getView: function() {
+ if (!this.view) {
+ this.view = new Ext.grid.PivotGridView(this.viewConfig);
+ }
+
+ return this.view;
+ }
+});
+
+Ext.reg('pivotgrid', Ext.grid.PivotGrid);
+
+
+Ext.grid.PivotAggregatorMgr = new Ext.AbstractManager();
+
+Ext.grid.PivotAggregatorMgr.registerType('sum', function(records, measure) {
+ var length = records.length,
+ total = 0,
+ i;
+
+ for (i = 0; i < length; i++) {
+ total += records[i].get(measure);
+ }
+
+ return total;
+});
+
+Ext.grid.PivotAggregatorMgr.registerType('avg', function(records, measure) {
+ var length = records.length,
+ total = 0,
+ i;
+
+ for (i = 0; i < length; i++) {
+ total += records[i].get(measure);
+ }
+
+ return (total / length) || 'n/a';
+});
+
+Ext.grid.PivotAggregatorMgr.registerType('min', function(records, measure) {
+ var data = [],
+ length = records.length,
+ i;
+
+ for (i = 0; i < length; i++) {
+ data.push(records[i].get(measure));
+ }
+
+ return Math.min.apply(this, data) || 'n/a';
+});
+
+Ext.grid.PivotAggregatorMgr.registerType('max', function(records, measure) {
+ var data = [],
+ length = records.length,
+ i;
+
+ for (i = 0; i < length; i++) {
+ data.push(records[i].get(measure));
+ }
+
+ return Math.max.apply(this, data) || 'n/a';
+});
+
+Ext.grid.PivotAggregatorMgr.registerType('count', function(records, measure) {
+ return records.length;
+});/**
+ * @class Ext.grid.GridView
+ * @extends Ext.util.Observable
+ * <p>This class encapsulates the user interface of an {@link Ext.grid.GridPanel}.
+ * Methods of this class may be used to access user interface elements to enable
+ * special display effects. Do not change the DOM structure of the user interface.</p>
+ * <p>This class does not provide ways to manipulate the underlying data. The data
+ * model of a Grid is held in an {@link Ext.data.Store}.</p>
+ * @constructor
+ * @param {Object} config
+ */
+Ext.grid.GridView = Ext.extend(Ext.util.Observable, {
+ /**
+ * Override this function to apply custom CSS classes to rows during rendering. You can also supply custom
+ * parameters to the row template for the current row to customize how it is rendered using the <b>rowParams</b>
+ * parameter. This function should return the CSS class name (or empty string '' for none) that will be added
+ * to the row's wrapping div. To apply multiple class names, simply return them space-delimited within the string
+ * (e.g., 'my-class another-class'). Example usage:
+ <pre><code>
+viewConfig: {
+ forceFit: true,
+ showPreview: true, // custom property
+ enableRowBody: true, // required to create a second, full-width row to show expanded Record data
+ getRowClass: function(record, rowIndex, rp, ds){ // rp = rowParams
+ if(this.showPreview){
+ rp.body = '<p>'+record.data.excerpt+'</p>';
+ return 'x-grid3-row-expanded';
+ }
+ return 'x-grid3-row-collapsed';
+ }
+},
+ </code></pre>
+ * @param {Record} record The {@link Ext.data.Record} corresponding to the current row.
+ * @param {Number} index The row index.
+ * @param {Object} rowParams A config object that is passed to the row template during rendering that allows
+ * customization of various aspects of a grid row.
+ * <p>If {@link #enableRowBody} is configured <b><tt></tt>true</b>, then the following properties may be set
+ * by this function, and will be used to render a full-width expansion row below each grid row:</p>
+ * <ul>
+ * <li><code>body</code> : String <div class="sub-desc">An HTML fragment to be used as the expansion row's body content (defaults to '').</div></li>
+ * <li><code>bodyStyle</code> : String <div class="sub-desc">A CSS style specification that will be applied to the expansion row's <tr> element. (defaults to '').</div></li>
+ * </ul>
+ * The following property will be passed in, and may be appended to:
+ * <ul>
+ * <li><code>tstyle</code> : String <div class="sub-desc">A CSS style specification that willl be applied to the <table> element which encapsulates
+ * both the standard grid row, and any expansion row.</div></li>
+ * </ul>
+ * @param {Store} store The {@link Ext.data.Store} this grid is bound to
+ * @method getRowClass
+ * @return {String} a CSS class name to add to the row.
+ */
+
+ /**
+ * @cfg {Boolean} enableRowBody True to add a second TR element per row that can be used to provide a row body
+ * that spans beneath the data row. Use the {@link #getRowClass} method's rowParams config to customize the row body.
+ */
+
+ /**
+ * @cfg {String} emptyText Default text (html tags are accepted) to display in the grid body when no rows
+ * are available (defaults to ''). This value will be used to update the <tt>{@link #mainBody}</tt>:
+ <pre><code>
+ this.mainBody.update('<div class="x-grid-empty">' + this.emptyText + '</div>');
+ </code></pre>
+ */
+
+ /**
+ * @cfg {Boolean} headersDisabled True to disable the grid column headers (defaults to <tt>false</tt>).
+ * Use the {@link Ext.grid.ColumnModel ColumnModel} <tt>{@link Ext.grid.ColumnModel#menuDisabled menuDisabled}</tt>
+ * config to disable the <i>menu</i> for individual columns. While this config is true the
+ * following will be disabled:<div class="mdetail-params"><ul>
+ * <li>clicking on header to sort</li>
+ * <li>the trigger to reveal the menu.</li>
+ * </ul></div>
+ */
+
+ /**
+ * <p>A customized implementation of a {@link Ext.dd.DragZone DragZone} which provides default implementations
+ * of the template methods of DragZone to enable dragging of the selected rows of a GridPanel.
+ * See {@link Ext.grid.GridDragZone} for details.</p>
+ * <p>This will <b>only</b> be present:<div class="mdetail-params"><ul>
+ * <li><i>if</i> the owning GridPanel was configured with {@link Ext.grid.GridPanel#enableDragDrop enableDragDrop}: <tt>true</tt>.</li>
+ * <li><i>after</i> the owning GridPanel has been rendered.</li>
+ * </ul></div>
+ * @property dragZone
+ * @type {Ext.grid.GridDragZone}
+ */
+
+ /**
+ * @cfg {Boolean} deferEmptyText True to defer <tt>{@link #emptyText}</tt> being applied until the store's
+ * first load (defaults to <tt>true</tt>).
+ */
+ deferEmptyText : true,
+
+ /**
+ * @cfg {Number} scrollOffset The amount of space to reserve for the vertical scrollbar
+ * (defaults to <tt>undefined</tt>). If an explicit value isn't specified, this will be automatically
+ * calculated.
+ */
+ scrollOffset : undefined,
+
+ /**
+ * @cfg {Boolean} autoFill
+ * Defaults to <tt>false</tt>. Specify <tt>true</tt> to have the column widths re-proportioned
+ * when the grid is <b>initially rendered</b>. The
+ * {@link Ext.grid.Column#width initially configured width}</tt> of each column will be adjusted
+ * to fit the grid width and prevent horizontal scrolling. If columns are later resized (manually
+ * or programmatically), the other columns in the grid will <b>not</b> be resized to fit the grid width.
+ * See <tt>{@link #forceFit}</tt> also.
+ */
+ autoFill : false,
+
+ /**
+ * @cfg {Boolean} forceFit
+ * <p>Defaults to <tt>false</tt>. Specify <tt>true</tt> to have the column widths re-proportioned
+ * at <b>all times</b>.</p>
+ * <p>The {@link Ext.grid.Column#width initially configured width}</tt> of each
+ * column will be adjusted to fit the grid width and prevent horizontal scrolling. If columns are
+ * later resized (manually or programmatically), the other columns in the grid <b>will</b> be resized
+ * to fit the grid width.</p>
+ * <p>Columns which are configured with <code>fixed: true</code> are omitted from being resized.</p>
+ * <p>See <tt>{@link #autoFill}</tt>.</p>
+ */
+ forceFit : false,
+
+ /**
+ * @cfg {Array} sortClasses The CSS classes applied to a header when it is sorted. (defaults to <tt>['sort-asc', 'sort-desc']</tt>)
+ */
+ sortClasses : ['sort-asc', 'sort-desc'],
+
+ /**
+ * @cfg {String} sortAscText The text displayed in the 'Sort Ascending' menu item (defaults to <tt>'Sort Ascending'</tt>)
+ */
+ sortAscText : 'Sort Ascending',
+
+ /**
+ * @cfg {String} sortDescText The text displayed in the 'Sort Descending' menu item (defaults to <tt>'Sort Descending'</tt>)
+ */
+ sortDescText : 'Sort Descending',
+
+ /**
+ * @cfg {String} columnsText The text displayed in the 'Columns' menu item (defaults to <tt>'Columns'</tt>)
+ */
+ columnsText : 'Columns',
+
+ /**
+ * @cfg {String} selectedRowClass The CSS class applied to a selected row (defaults to <tt>'x-grid3-row-selected'</tt>). An
+ * example overriding the default styling:
+ <pre><code>
+ .x-grid3-row-selected {background-color: yellow;}
+ </code></pre>
+ * Note that this only controls the row, and will not do anything for the text inside it. To style inner
+ * facets (like text) use something like:
+ <pre><code>
+ .x-grid3-row-selected .x-grid3-cell-inner {
+ color: #FFCC00;
+ }
+ </code></pre>
+ * @type String
+ */
+ selectedRowClass : 'x-grid3-row-selected',
+
+ // private
+ borderWidth : 2,
+ tdClass : 'x-grid3-cell',
+ hdCls : 'x-grid3-hd',
+
+
+ /**
+ * @cfg {Boolean} markDirty True to show the dirty cell indicator when a cell has been modified. Defaults to <tt>true</tt>.
+ */
+ markDirty : true,
+
+ /**
+ * @cfg {Number} cellSelectorDepth The number of levels to search for cells in event delegation (defaults to <tt>4</tt>)
+ */
+ cellSelectorDepth : 4,
+
+ /**
+ * @cfg {Number} rowSelectorDepth The number of levels to search for rows in event delegation (defaults to <tt>10</tt>)
+ */
+ rowSelectorDepth : 10,
+
+ /**
+ * @cfg {Number} rowBodySelectorDepth The number of levels to search for row bodies in event delegation (defaults to <tt>10</tt>)
+ */
+ rowBodySelectorDepth : 10,
+
+ /**
+ * @cfg {String} cellSelector The selector used to find cells internally (defaults to <tt>'td.x-grid3-cell'</tt>)
+ */
+ cellSelector : 'td.x-grid3-cell',
+
+ /**
+ * @cfg {String} rowSelector The selector used to find rows internally (defaults to <tt>'div.x-grid3-row'</tt>)
+ */
+ rowSelector : 'div.x-grid3-row',
+
+ /**
+ * @cfg {String} rowBodySelector The selector used to find row bodies internally (defaults to <tt>'div.x-grid3-row'</tt>)
+ */
+ rowBodySelector : 'div.x-grid3-row-body',
+
+ // private
+ firstRowCls: 'x-grid3-row-first',
+ lastRowCls: 'x-grid3-row-last',
+ rowClsRe: /(?:^|\s+)x-grid3-row-(first|last|alt)(?:\s+|$)/g,
+
+ /**
+ * @cfg {String} headerMenuOpenCls The CSS class to add to the header cell when its menu is visible. Defaults to 'x-grid3-hd-menu-open'
+ */
+ headerMenuOpenCls: 'x-grid3-hd-menu-open',
+
+ /**
+ * @cfg {String} rowOverCls The CSS class added to each row when it is hovered over. Defaults to 'x-grid3-row-over'
+ */
+ rowOverCls: 'x-grid3-row-over',
+
+ constructor : function(config) {
+ Ext.apply(this, config);
+
+ // These events are only used internally by the grid components
+ this.addEvents(
+ /**
+ * @event beforerowremoved
+ * Internal UI Event. Fired before a row is removed.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} rowIndex The index of the row to be removed.
+ * @param {Ext.data.Record} record The Record to be removed
+ */
+ 'beforerowremoved',
+
+ /**
+ * @event beforerowsinserted
+ * Internal UI Event. Fired before rows are inserted.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} firstRow The index of the first row to be inserted.
+ * @param {Number} lastRow The index of the last row to be inserted.
+ */
+ 'beforerowsinserted',
+
+ /**
+ * @event beforerefresh
+ * Internal UI Event. Fired before the view is refreshed.
+ * @param {Ext.grid.GridView} view
+ */
+ 'beforerefresh',
+
+ /**
+ * @event rowremoved
+ * Internal UI Event. Fired after a row is removed.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} rowIndex The index of the row that was removed.
+ * @param {Ext.data.Record} record The Record that was removed
+ */
+ 'rowremoved',
+
+ /**
+ * @event rowsinserted
+ * Internal UI Event. Fired after rows are inserted.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} firstRow The index of the first inserted.
+ * @param {Number} lastRow The index of the last row inserted.
+ */
+ 'rowsinserted',
+
+ /**
+ * @event rowupdated
+ * Internal UI Event. Fired after a row has been updated.
+ * @param {Ext.grid.GridView} view
+ * @param {Number} firstRow The index of the row updated.
+ * @param {Ext.data.record} record The Record backing the row updated.
+ */
+ 'rowupdated',
+
+ /**
+ * @event refresh
+ * Internal UI Event. Fired after the GridView's body has been refreshed.
+ * @param {Ext.grid.GridView} view
+ */
+ 'refresh'
+ );
+
+ Ext.grid.GridView.superclass.constructor.call(this);
+ },
+
+ /* -------------------------------- UI Specific ----------------------------- */
+
+ /**
+ * The master template to use when rendering the GridView. Has a default template
+ * @property Ext.Template
+ * @type masterTpl
+ */
+ masterTpl: new Ext.Template(
+ '<div class="x-grid3" hidefocus="true">',
+ '<div class="x-grid3-viewport">',
+ '<div class="x-grid3-header">',
+ '<div class="x-grid3-header-inner">',
+ '<div class="x-grid3-header-offset" style="{ostyle}">{header}</div>',
+ '</div>',
+ '<div class="x-clear"></div>',
+ '</div>',
+ '<div class="x-grid3-scroller">',
+ '<div class="x-grid3-body" style="{bstyle}">{body}</div>',
+ '<a href="#" class="x-grid3-focus" tabIndex="-1"></a>',
+ '</div>',
+ '</div>',
+ '<div class="x-grid3-resize-marker"> </div>',
+ '<div class="x-grid3-resize-proxy"> </div>',
+ '</div>'
+ ),
+
+ /**
+ * The template to use when rendering headers. Has a default template
+ * @property headerTpl
+ * @type Ext.Template
+ */
+ headerTpl: new Ext.Template(
+ '<table border="0" cellspacing="0" cellpadding="0" style="{tstyle}">',
+ '<thead>',
+ '<tr class="x-grid3-hd-row">{cells}</tr>',
+ '</thead>',
+ '</table>'
+ ),
+
+ /**
+ * The template to use when rendering the body. Has a default template
+ * @property bodyTpl
+ * @type Ext.Template
+ */
+ bodyTpl: new Ext.Template('{rows}'),
+
+ /**
+ * The template to use to render each cell. Has a default template
+ * @property cellTpl
+ * @type Ext.Template
+ */
+ cellTpl: new Ext.Template(
+ '<td class="x-grid3-col x-grid3-cell x-grid3-td-{id} {css}" style="{style}" tabIndex="0" {cellAttr}>',
+ '<div class="x-grid3-cell-inner x-grid3-col-{id}" unselectable="on" {attr}>{value}</div>',
+ '</td>'
+ ),
+
+ /**
+ * @private
+ * Provides default templates if they are not given for this particular instance. Most of the templates are defined on
+ * the prototype, the ones defined inside this function are done so because they are based on Grid or GridView configuration
+ */
+ initTemplates : function() {
+ var templates = this.templates || {},
+ template, name,
+
+ headerCellTpl = new Ext.Template(
+ '<td class="x-grid3-hd x-grid3-cell x-grid3-td-{id} {css}" style="{style}">',
+ '<div {tooltip} {attr} class="x-grid3-hd-inner x-grid3-hd-{id}" unselectable="on" style="{istyle}">',
+ this.grid.enableHdMenu ? '<a class="x-grid3-hd-btn" href="#"></a>' : '',
+ '{value}',
+ '<img alt="" class="x-grid3-sort-icon" src="', Ext.BLANK_IMAGE_URL, '" />',
+ '</div>',
+ '</td>'
+ ),
+
+ rowBodyText = [
+ '<tr class="x-grid3-row-body-tr" style="{bodyStyle}">',
+ '<td colspan="{cols}" class="x-grid3-body-cell" tabIndex="0" hidefocus="on">',
+ '<div class="x-grid3-row-body">{body}</div>',
+ '</td>',
+ '</tr>'
+ ].join(""),
+
+ innerText = [
+ '<table class="x-grid3-row-table" border="0" cellspacing="0" cellpadding="0" style="{tstyle}">',
+ '<tbody>',
+ '<tr>{cells}</tr>',
+ this.enableRowBody ? rowBodyText : '',
+ '</tbody>',
+ '</table>'
+ ].join("");
+
+ Ext.applyIf(templates, {
+ hcell : headerCellTpl,
+ cell : this.cellTpl,
+ body : this.bodyTpl,
+ header : this.headerTpl,
+ master : this.masterTpl,
+ row : new Ext.Template('<div class="x-grid3-row {alt}" style="{tstyle}">' + innerText + '</div>'),
+ rowInner: new Ext.Template(innerText)
+ });
+
+ for (name in templates) {
+ template = templates[name];
+
+ if (template && Ext.isFunction(template.compile) && !template.compiled) {
+ template.disableFormats = true;
+ template.compile();
+ }
+ }
+
+ this.templates = templates;
+ this.colRe = new RegExp('x-grid3-td-([^\\s]+)', '');
+ },
+
+ /**
+ * @private
+ * Each GridView has its own private flyweight, accessed through this method
+ */
+ fly : function(el) {
+ if (!this._flyweight) {
+ this._flyweight = new Ext.Element.Flyweight(document.body);
+ }
+ this._flyweight.dom = el;
+ return this._flyweight;
+ },
+
+ // private
+ getEditorParent : function() {
+ return this.scroller.dom;
+ },
+
+ /**
+ * @private
+ * Finds and stores references to important elements
+ */
+ initElements : function() {
+ var Element = Ext.Element,
+ el = Ext.get(this.grid.getGridEl().dom.firstChild),
+ mainWrap = new Element(el.child('div.x-grid3-viewport')),
+ mainHd = new Element(mainWrap.child('div.x-grid3-header')),
+ scroller = new Element(mainWrap.child('div.x-grid3-scroller'));
+
+ if (this.grid.hideHeaders) {
+ mainHd.setDisplayed(false);
+ }
+
+ if (this.forceFit) {
+ scroller.setStyle('overflow-x', 'hidden');
+ }
+
+ /**
+ * <i>Read-only</i>. The GridView's body Element which encapsulates all rows in the Grid.
+ * This {@link Ext.Element Element} is only available after the GridPanel has been rendered.
+ * @type Ext.Element
+ * @property mainBody
+ */
+
+ Ext.apply(this, {
+ el : el,
+ mainWrap: mainWrap,
+ scroller: scroller,
+ mainHd : mainHd,
+ innerHd : mainHd.child('div.x-grid3-header-inner').dom,
+ mainBody: new Element(Element.fly(scroller).child('div.x-grid3-body')),
+ focusEl : new Element(Element.fly(scroller).child('a')),
+
+ resizeMarker: new Element(el.child('div.x-grid3-resize-marker')),
+ resizeProxy : new Element(el.child('div.x-grid3-resize-proxy'))
+ });
+
+ this.focusEl.swallowEvent('click', true);
+ },
+
+ // private
+ getRows : function() {
+ return this.hasRows() ? this.mainBody.dom.childNodes : [];
+ },
+
+ // finder methods, used with delegation
+
+ // private
+ findCell : function(el) {
+ if (!el) {
+ return false;
+ }
+ return this.fly(el).findParent(this.cellSelector, this.cellSelectorDepth);
+ },
+
+ /**
+ * <p>Return the index of the grid column which contains the passed HTMLElement.</p>
+ * See also {@link #findRowIndex}
+ * @param {HTMLElement} el The target element
+ * @return {Number} The column index, or <b>false</b> if the target element is not within a row of this GridView.
+ */
+ findCellIndex : function(el, requiredCls) {
+ var cell = this.findCell(el),
+ hasCls;
+
+ if (cell) {
+ hasCls = this.fly(cell).hasClass(requiredCls);
+ if (!requiredCls || hasCls) {
+ return this.getCellIndex(cell);
+ }
+ }
+ return false;
+ },
+
+ // private
+ getCellIndex : function(el) {
+ if (el) {
+ var match = el.className.match(this.colRe);
+
+ if (match && match[1]) {
+ return this.cm.getIndexById(match[1]);
+ }
+ }
+ return false;
+ },
+
+ // private
+ findHeaderCell : function(el) {
+ var cell = this.findCell(el);
+ return cell && this.fly(cell).hasClass(this.hdCls) ? cell : null;
+ },
+
+ // private
+ findHeaderIndex : function(el){
+ return this.findCellIndex(el, this.hdCls);
+ },
+
+ /**
+ * Return the HtmlElement representing the grid row which contains the passed element.
+ * @param {HTMLElement} el The target HTMLElement
+ * @return {HTMLElement} The row element, or null if the target element is not within a row of this GridView.
+ */
+ findRow : function(el) {
+ if (!el) {
+ return false;
+ }
+ return this.fly(el).findParent(this.rowSelector, this.rowSelectorDepth);
+ },
+
+ /**
+ * Return the index of the grid row which contains the passed HTMLElement.
+ * See also {@link #findCellIndex}
+ * @param {HTMLElement} el The target HTMLElement
+ * @return {Number} The row index, or <b>false</b> if the target element is not within a row of this GridView.
+ */
+ findRowIndex : function(el) {
+ var row = this.findRow(el);
+ return row ? row.rowIndex : false;
+ },
+
+ /**
+ * Return the HtmlElement representing the grid row body which contains the passed element.
+ * @param {HTMLElement} el The target HTMLElement
+ * @return {HTMLElement} The row body element, or null if the target element is not within a row body of this GridView.
+ */
+ findRowBody : function(el) {
+ if (!el) {
+ return false;
+ }
+
+ return this.fly(el).findParent(this.rowBodySelector, this.rowBodySelectorDepth);
+ },
+
+ // getter methods for fetching elements dynamically in the grid
+
+ /**
+ * Return the <tt><div></tt> HtmlElement which represents a Grid row for the specified index.
+ * @param {Number} index The row index
+ * @return {HtmlElement} The div element.
+ */
+ getRow : function(row) {
+ return this.getRows()[row];
+ },
+
+ /**
+ * Returns the grid's <tt><td></tt> HtmlElement at the specified coordinates.
+ * @param {Number} row The row index in which to find the cell.
+ * @param {Number} col The column index of the cell.
+ * @return {HtmlElement} The td at the specified coordinates.
+ */
+ getCell : function(row, col) {
+ return Ext.fly(this.getRow(row)).query(this.cellSelector)[col];
+ },
+
+ /**
+ * Return the <tt><td></tt> HtmlElement which represents the Grid's header cell for the specified column index.
+ * @param {Number} index The column index
+ * @return {HtmlElement} The td element.
+ */
+ getHeaderCell : function(index) {
+ return this.mainHd.dom.getElementsByTagName('td')[index];
+ },
+
+ // manipulating elements
+
+ // private - use getRowClass to apply custom row classes
+ addRowClass : function(rowId, cls) {
+ var row = this.getRow(rowId);
+ if (row) {
+ this.fly(row).addClass(cls);
+ }
+ },
+
+ // private
+ removeRowClass : function(row, cls) {
+ var r = this.getRow(row);
+ if(r){
+ this.fly(r).removeClass(cls);
+ }
+ },
+
+ // private
+ removeRow : function(row) {
+ Ext.removeNode(this.getRow(row));
+ this.syncFocusEl(row);
+ },
+
+ // private
+ removeRows : function(firstRow, lastRow) {
+ var bd = this.mainBody.dom,
+ rowIndex;
+
+ for (rowIndex = firstRow; rowIndex <= lastRow; rowIndex++){
+ Ext.removeNode(bd.childNodes[firstRow]);
+ }
+
+ this.syncFocusEl(firstRow);
+ },
+
+ /* ----------------------------------- Scrolling functions -------------------------------------------*/
+
+ // private
+ getScrollState : function() {
+ var sb = this.scroller.dom;
+
+ return {
+ left: sb.scrollLeft,
+ top : sb.scrollTop
+ };
+ },
+
+ // private
+ restoreScroll : function(state) {
+ var sb = this.scroller.dom;
+ sb.scrollLeft = state.left;
+ sb.scrollTop = state.top;
+ },
+
+ /**
+ * Scrolls the grid to the top
+ */
+ scrollToTop : function() {
+ var dom = this.scroller.dom;
+
+ dom.scrollTop = 0;
+ dom.scrollLeft = 0;
+ },
+
+ // private
+ syncScroll : function() {
+ this.syncHeaderScroll();
+ var mb = this.scroller.dom;
+ this.grid.fireEvent('bodyscroll', mb.scrollLeft, mb.scrollTop);
+ },
+
+ // private
+ syncHeaderScroll : function() {
+ var innerHd = this.innerHd,
+ scrollLeft = this.scroller.dom.scrollLeft;
+
+ innerHd.scrollLeft = scrollLeft;
+ innerHd.scrollLeft = scrollLeft; // second time for IE (1/2 time first fails, other browsers ignore)
+ },
+
+ /**
+ * @private
+ * Ensures the given column has the given icon class
+ */
+ updateSortIcon : function(col, dir) {
+ var sortClasses = this.sortClasses,
+ sortClass = sortClasses[dir == "DESC" ? 1 : 0],
+ headers = this.mainHd.select('td').removeClass(sortClasses);
+
+ headers.item(col).addClass(sortClass);
+ },
+
+ /**
+ * @private
+ * Updates the size of every column and cell in the grid
+ */
+ updateAllColumnWidths : function() {
+ var totalWidth = this.getTotalWidth(),
+ colCount = this.cm.getColumnCount(),
+ rows = this.getRows(),
+ rowCount = rows.length,
+ widths = [],
+ row, rowFirstChild, trow, i, j;
+
+ for (i = 0; i < colCount; i++) {
+ widths[i] = this.getColumnWidth(i);
+ this.getHeaderCell(i).style.width = widths[i];
+ }
+
+ this.updateHeaderWidth();
+
+ for (i = 0; i < rowCount; i++) {
+ row = rows[i];
+ row.style.width = totalWidth;
+ rowFirstChild = row.firstChild;
+
+ if (rowFirstChild) {
+ rowFirstChild.style.width = totalWidth;
+ trow = rowFirstChild.rows[0];
+
+ for (j = 0; j < colCount; j++) {
+ trow.childNodes[j].style.width = widths[j];
+ }
+ }
+ }
+
+ this.onAllColumnWidthsUpdated(widths, totalWidth);
+ },
+
+ /**
+ * @private
+ * Called after a column's width has been updated, this resizes all of the cells for that column in each row
+ * @param {Number} column The column index
+ */
+ updateColumnWidth : function(column, width) {
+ var columnWidth = this.getColumnWidth(column),
+ totalWidth = this.getTotalWidth(),
+ headerCell = this.getHeaderCell(column),
+ nodes = this.getRows(),
+ nodeCount = nodes.length,
+ row, i, firstChild;
+
+ this.updateHeaderWidth();
+ headerCell.style.width = columnWidth;
+
+ for (i = 0; i < nodeCount; i++) {
+ row = nodes[i];
+ firstChild = row.firstChild;
+
+ row.style.width = totalWidth;
+ if (firstChild) {
+ firstChild.style.width = totalWidth;
+ firstChild.rows[0].childNodes[column].style.width = columnWidth;
+ }
+ }
+
+ this.onColumnWidthUpdated(column, columnWidth, totalWidth);
+ },
+
+ /**
+ * @private
+ * Sets the hidden status of a given column.
+ * @param {Number} col The column index
+ * @param {Boolean} hidden True to make the column hidden
+ */
+ updateColumnHidden : function(col, hidden) {
+ var totalWidth = this.getTotalWidth(),
+ display = hidden ? 'none' : '',
+ headerCell = this.getHeaderCell(col),
+ nodes = this.getRows(),
+ nodeCount = nodes.length,
+ row, rowFirstChild, i;
+
+ this.updateHeaderWidth();
+ headerCell.style.display = display;
+
+ for (i = 0; i < nodeCount; i++) {
+ row = nodes[i];
+ row.style.width = totalWidth;
+ rowFirstChild = row.firstChild;
+
+ if (rowFirstChild) {
+ rowFirstChild.style.width = totalWidth;
+ rowFirstChild.rows[0].childNodes[col].style.display = display;
+ }
+ }
+
+ this.onColumnHiddenUpdated(col, hidden, totalWidth);
+ delete this.lastViewWidth; //recalc
+ this.layout();
+ },
+
+ /**
+ * @private
+ * Renders all of the rows to a string buffer and returns the string. This is called internally
+ * by renderRows and performs the actual string building for the rows - it does not inject HTML into the DOM.
+ * @param {Array} columns The column data acquired from getColumnData.
+ * @param {Array} records The array of records to render
+ * @param {Ext.data.Store} store The store to render the rows from
+ * @param {Number} startRow The index of the first row being rendered. Sometimes we only render a subset of
+ * the rows so this is used to maintain logic for striping etc
+ * @param {Number} colCount The total number of columns in the column model
+ * @param {Boolean} stripe True to stripe the rows
+ * @return {String} A string containing the HTML for the rendered rows
+ */
+ doRender : function(columns, records, store, startRow, colCount, stripe) {
+ var templates = this.templates,
+ cellTemplate = templates.cell,
+ rowTemplate = templates.row,
+ last = colCount - 1,
+ tstyle = 'width:' + this.getTotalWidth() + ';',
+ // buffers
+ rowBuffer = [],
+ colBuffer = [],
+ rowParams = {tstyle: tstyle},
+ meta = {},
+ len = records.length,
+ alt,
+ column,
+ record, i, j, rowIndex;
+
+ //build up each row's HTML
+ for (j = 0; j < len; j++) {
+ record = records[j];
+ colBuffer = [];
+
+ rowIndex = j + startRow;
+
+ //build up each column's HTML
+ for (i = 0; i < colCount; i++) {
+ column = columns[i];
+
+ meta.id = column.id;
+ meta.css = i === 0 ? 'x-grid3-cell-first ' : (i == last ? 'x-grid3-cell-last ' : '');
+ meta.attr = meta.cellAttr = '';
+ meta.style = column.style;
+ meta.value = column.renderer.call(column.scope, record.data[column.name], meta, record, rowIndex, i, store);
+
+ if (Ext.isEmpty(meta.value)) {
+ meta.value = ' ';
+ }
+
+ if (this.markDirty && record.dirty && typeof record.modified[column.name] != 'undefined') {
+ meta.css += ' x-grid3-dirty-cell';
+ }
+
+ colBuffer[colBuffer.length] = cellTemplate.apply(meta);
+ }
+
+ alt = [];
+ //set up row striping and row dirtiness CSS classes
+ if (stripe && ((rowIndex + 1) % 2 === 0)) {
+ alt[0] = 'x-grid3-row-alt';
+ }
+
+ if (record.dirty) {
+ alt[1] = ' x-grid3-dirty-row';
+ }
+
+ rowParams.cols = colCount;
+
+ if (this.getRowClass) {
+ alt[2] = this.getRowClass(record, rowIndex, rowParams, store);
+ }
+
+ rowParams.alt = alt.join(' ');
+ rowParams.cells = colBuffer.join('');
+
+ rowBuffer[rowBuffer.length] = rowTemplate.apply(rowParams);
+ }
+
+ return rowBuffer.join('');
+ },
+
+ /**
+ * @private
+ * Adds CSS classes and rowIndex to each row
+ * @param {Number} startRow The row to start from (defaults to 0)
+ */
+ processRows : function(startRow, skipStripe) {
+ if (!this.ds || this.ds.getCount() < 1) {
+ return;
+ }
+
+ var rows = this.getRows(),
+ length = rows.length,
+ row, i;
+
+ skipStripe = skipStripe || !this.grid.stripeRows;
+ startRow = startRow || 0;
+
+ for (i = 0; i < length; i++) {
+ row = rows[i];
+ if (row) {
+ row.rowIndex = i;
+ if (!skipStripe) {
+ row.className = row.className.replace(this.rowClsRe, ' ');
+ if ((i + 1) % 2 === 0){
+ row.className += ' x-grid3-row-alt';
+ }
+ }
+ }
+ }
+
+ // add first/last-row classes
+ if (startRow === 0) {
+ Ext.fly(rows[0]).addClass(this.firstRowCls);
+ }
+
+ Ext.fly(rows[length - 1]).addClass(this.lastRowCls);
+ },
+
+ /**
+ * @private
+ */
+ afterRender : function() {
+ if (!this.ds || !this.cm) {
+ return;
+ }
+
+ this.mainBody.dom.innerHTML = this.renderBody() || ' ';
+ this.processRows(0, true);
+
+ if (this.deferEmptyText !== true) {
+ this.applyEmptyText();
+ }
+
+ this.grid.fireEvent('viewready', this.grid);
+ },
+
+ /**
+ * @private
+ * This is always intended to be called after renderUI. Sets up listeners on the UI elements
+ * and sets up options like column menus, moving and resizing.
+ */
+ afterRenderUI: function() {
+ var grid = this.grid;
+
+ this.initElements();
+
+ // get mousedowns early
+ Ext.fly(this.innerHd).on('click', this.handleHdDown, this);
+
+ this.mainHd.on({
+ scope : this,
+ mouseover: this.handleHdOver,
+ mouseout : this.handleHdOut,
+ mousemove: this.handleHdMove
+ });
+
+ this.scroller.on('scroll', this.syncScroll, this);
+
+ if (grid.enableColumnResize !== false) {
+ this.splitZone = new Ext.grid.GridView.SplitDragZone(grid, this.mainHd.dom);
+ }
+
+ if (grid.enableColumnMove) {
+ this.columnDrag = new Ext.grid.GridView.ColumnDragZone(grid, this.innerHd);
+ this.columnDrop = new Ext.grid.HeaderDropZone(grid, this.mainHd.dom);
+ }
+
+ if (grid.enableHdMenu !== false) {
+ this.hmenu = new Ext.menu.Menu({id: grid.id + '-hctx'});
+ this.hmenu.add(
+ {itemId:'asc', text: this.sortAscText, cls: 'xg-hmenu-sort-asc'},
+ {itemId:'desc', text: this.sortDescText, cls: 'xg-hmenu-sort-desc'}
+ );
+
+ if (grid.enableColumnHide !== false) {
+ this.colMenu = new Ext.menu.Menu({id:grid.id + '-hcols-menu'});
+ this.colMenu.on({
+ scope : this,
+ beforeshow: this.beforeColMenuShow,
+ itemclick : this.handleHdMenuClick
+ });
+ this.hmenu.add('-', {
+ itemId:'columns',
+ hideOnClick: false,
+ text: this.columnsText,
+ menu: this.colMenu,
+ iconCls: 'x-cols-icon'
+ });
+ }
+
+ this.hmenu.on('itemclick', this.handleHdMenuClick, this);
+ }
+
+ if (grid.trackMouseOver) {
+ this.mainBody.on({
+ scope : this,
+ mouseover: this.onRowOver,
+ mouseout : this.onRowOut
+ });
+ }
+
+ if (grid.enableDragDrop || grid.enableDrag) {
+ this.dragZone = new Ext.grid.GridDragZone(grid, {
+ ddGroup : grid.ddGroup || 'GridDD'
+ });
+ }
+
+ this.updateHeaderSortState();
+ },
+
+ /**
+ * @private
+ * Renders each of the UI elements in turn. This is called internally, once, by this.render. It does not
+ * render rows from the store, just the surrounding UI elements.
+ */
+ renderUI : function() {
+ var templates = this.templates;
+
+ return templates.master.apply({
+ body : templates.body.apply({rows:' '}),
+ header: this.renderHeaders(),
+ ostyle: 'width:' + this.getOffsetWidth() + ';',
+ bstyle: 'width:' + this.getTotalWidth() + ';'
+ });
+ },
+
// private
- getColumnTooltip : function(i){
- var tt = this.cm.getColumnTooltip(i);
- if(tt){
- if(Ext.QuickTips.isEnabled()){
- return 'ext:qtip="'+tt+'"';
- }else{
- return 'title="'+tt+'"';
+ processEvent : function(name, e) {
+ var target = e.getTarget(),
+ grid = this.grid,
+ header = this.findHeaderIndex(target),
+ row, cell, col, body;
+
+ grid.fireEvent(name, e);
+
+ if (header !== false) {
+ grid.fireEvent('header' + name, grid, header, e);
+ } else {
+ row = this.findRowIndex(target);
+
+// Grid's value-added events must bubble correctly to allow cancelling via returning false: cell->column->row
+// We must allow a return of false at any of these levels to cancel the event processing.
+// Particularly allowing rowmousedown to be cancellable by prior handlers which need to prevent selection.
+ if (row !== false) {
+ cell = this.findCellIndex(target);
+ if (cell !== false) {
+ col = grid.colModel.getColumnAt(cell);
+ if (grid.fireEvent('cell' + name, grid, row, cell, e) !== false) {
+ if (!col || (col.processEvent && (col.processEvent(name, e, grid, row, cell) !== false))) {
+ grid.fireEvent('row' + name, grid, row, e);
+ }
+ }
+ } else {
+ if (grid.fireEvent('row' + name, grid, row, e) !== false) {
+ (body = this.findRowBody(target)) && grid.fireEvent('rowbody' + name, grid, row, e);
+ }
+ }
+ } else {
+ grid.fireEvent('container' + name, grid, e);
+ }
+ }
+ },
+
+ /**
+ * @private
+ * Sizes the grid's header and body elements
+ */
+ layout : function(initial) {
+ if (!this.mainBody) {
+ return; // not rendered
+ }
+
+ var grid = this.grid,
+ gridEl = grid.getGridEl(),
+ gridSize = gridEl.getSize(true),
+ gridWidth = gridSize.width,
+ gridHeight = gridSize.height,
+ scroller = this.scroller,
+ scrollStyle, headerHeight, scrollHeight;
+
+ if (gridWidth < 20 || gridHeight < 20) {
+ return;
+ }
+
+ if (grid.autoHeight) {
+ scrollStyle = scroller.dom.style;
+ scrollStyle.overflow = 'visible';
+
+ if (Ext.isWebKit) {
+ scrollStyle.position = 'static';
+ }
+ } else {
+ this.el.setSize(gridWidth, gridHeight);
+
+ headerHeight = this.mainHd.getHeight();
+ scrollHeight = gridHeight - headerHeight;
+
+ scroller.setSize(gridWidth, scrollHeight);
+
+ if (this.innerHd) {
+ this.innerHd.style.width = (gridWidth) + "px";
+ }
+ }
+
+ if (this.forceFit || (initial === true && this.autoFill)) {
+ if (this.lastViewWidth != gridWidth) {
+ this.fitColumns(false, false);
+ this.lastViewWidth = gridWidth;
+ }
+ } else {
+ this.autoExpand();
+ this.syncHeaderScroll();
+ }
+
+ this.onLayout(gridWidth, scrollHeight);
+ },
+
+ // template functions for subclasses and plugins
+ // these functions include precalculated values
+ onLayout : function(vw, vh) {
+ // do nothing
+ },
+
+ onColumnWidthUpdated : function(col, w, tw) {
+ //template method
+ },
+
+ onAllColumnWidthsUpdated : function(ws, tw) {
+ //template method
+ },
+
+ onColumnHiddenUpdated : function(col, hidden, tw) {
+ // template method
+ },
+
+ updateColumnText : function(col, text) {
+ // template method
+ },
+
+ afterMove : function(colIndex) {
+ // template method
+ },
+
+ /* ----------------------------------- Core Specific -------------------------------------------*/
+ // private
+ init : function(grid) {
+ this.grid = grid;
+
+ this.initTemplates();
+ this.initData(grid.store, grid.colModel);
+ this.initUI(grid);
+ },
+
+ // private
+ getColumnId : function(index){
+ return this.cm.getColumnId(index);
+ },
+
+ // private
+ getOffsetWidth : function() {
+ return (this.cm.getTotalWidth() + this.getScrollOffset()) + 'px';
+ },
+
+ // private
+ getScrollOffset: function() {
+ return Ext.num(this.scrollOffset, Ext.getScrollBarWidth());
+ },
+
+ /**
+ * @private
+ * Renders the header row using the 'header' template. Does not inject the HTML into the DOM, just
+ * returns a string.
+ * @return {String} Rendered header row
+ */
+ renderHeaders : function() {
+ var colModel = this.cm,
+ templates = this.templates,
+ headerTpl = templates.hcell,
+ properties = {},
+ colCount = colModel.getColumnCount(),
+ last = colCount - 1,
+ cells = [],
+ i, cssCls;
+
+ for (i = 0; i < colCount; i++) {
+ if (i == 0) {
+ cssCls = 'x-grid3-cell-first ';
+ } else {
+ cssCls = i == last ? 'x-grid3-cell-last ' : '';
+ }
+
+ properties = {
+ id : colModel.getColumnId(i),
+ value : colModel.getColumnHeader(i) || '',
+ style : this.getColumnStyle(i, true),
+ css : cssCls,
+ tooltip: this.getColumnTooltip(i)
+ };
+
+ if (colModel.config[i].align == 'right') {
+ properties.istyle = 'padding-right: 16px;';
+ } else {
+ delete properties.istyle;
+ }
+
+ cells[i] = headerTpl.apply(properties);
+ }
+
+ return templates.header.apply({
+ cells : cells.join(""),
+ tstyle: String.format("width: {0};", this.getTotalWidth())
+ });
+ },
+
+ /**
+ * @private
+ */
+ getColumnTooltip : function(i) {
+ var tooltip = this.cm.getColumnTooltip(i);
+ if (tooltip) {
+ if (Ext.QuickTips.isEnabled()) {
+ return 'ext:qtip="' + tooltip + '"';
+ } else {
+ return 'title="' + tooltip + '"';
+ }
+ }
+
+ return '';
+ },
+
+ // private
+ beforeUpdate : function() {
+ this.grid.stopEditing(true);
+ },
+
+ /**
+ * @private
+ * Re-renders the headers and ensures they are sized correctly
+ */
+ updateHeaders : function() {
+ this.innerHd.firstChild.innerHTML = this.renderHeaders();
+
+ this.updateHeaderWidth(false);
+ },
+
+ /**
+ * @private
+ * Ensures that the header is sized to the total width available to it
+ * @param {Boolean} updateMain True to update the mainBody's width also (defaults to true)
+ */
+ updateHeaderWidth: function(updateMain) {
+ var innerHdChild = this.innerHd.firstChild,
+ totalWidth = this.getTotalWidth();
+
+ innerHdChild.style.width = this.getOffsetWidth();
+ innerHdChild.firstChild.style.width = totalWidth;
+
+ if (updateMain !== false) {
+ this.mainBody.dom.style.width = totalWidth;
+ }
+ },
+
+ /**
+ * Focuses the specified row.
+ * @param {Number} row The row index
+ */
+ focusRow : function(row) {
+ this.focusCell(row, 0, false);
+ },
+
+ /**
+ * Focuses the specified cell.
+ * @param {Number} row The row index
+ * @param {Number} col The column index
+ */
+ focusCell : function(row, col, hscroll) {
+ this.syncFocusEl(this.ensureVisible(row, col, hscroll));
+
+ var focusEl = this.focusEl;
+
+ if (Ext.isGecko) {
+ focusEl.focus();
+ } else {
+ focusEl.focus.defer(1, focusEl);
+ }
+ },
+
+ /**
+ * @private
+ * Finds the Elements corresponding to the given row and column indexes
+ */
+ resolveCell : function(row, col, hscroll) {
+ if (!Ext.isNumber(row)) {
+ row = row.rowIndex;
+ }
+
+ if (!this.ds) {
+ return null;
+ }
+
+ if (row < 0 || row >= this.ds.getCount()) {
+ return null;
+ }
+ col = (col !== undefined ? col : 0);
+
+ var rowEl = this.getRow(row),
+ colModel = this.cm,
+ colCount = colModel.getColumnCount(),
+ cellEl;
+
+ if (!(hscroll === false && col === 0)) {
+ while (col < colCount && colModel.isHidden(col)) {
+ col++;
}
+
+ cellEl = this.getCell(row, col);
}
- return '';
+
+ return {row: rowEl, cell: cellEl};
+ },
+
+ /**
+ * @private
+ * Returns the XY co-ordinates of a given row/cell resolution (see {@link #resolveCell})
+ * @return {Array} X and Y coords
+ */
+ getResolvedXY : function(resolved) {
+ if (!resolved) {
+ return null;
+ }
+
+ var cell = resolved.cell,
+ row = resolved.row;
+
+ if (cell) {
+ return Ext.fly(cell).getXY();
+ } else {
+ return [this.el.getX(), Ext.fly(row).getY()];
+ }
+ },
+
+ /**
+ * @private
+ * Moves the focus element to the x and y co-ordinates of the given row and column
+ */
+ syncFocusEl : function(row, col, hscroll) {
+ var xy = row;
+
+ if (!Ext.isArray(xy)) {
+ row = Math.min(row, Math.max(0, this.getRows().length-1));
+
+ if (isNaN(row)) {
+ return;
+ }
+
+ xy = this.getResolvedXY(this.resolveCell(row, col, hscroll));
+ }
+
+ this.focusEl.setXY(xy || this.scroller.getXY());
+ },
+
+ /**
+ * @private
+ */
+ ensureVisible : function(row, col, hscroll) {
+ var resolved = this.resolveCell(row, col, hscroll);
+
+ if (!resolved || !resolved.row) {
+ return null;
+ }
+
+ var rowEl = resolved.row,
+ cellEl = resolved.cell,
+ c = this.scroller.dom,
+ p = rowEl,
+ ctop = 0,
+ stop = this.el.dom;
+
+ while (p && p != stop) {
+ ctop += p.offsetTop;
+ p = p.offsetParent;
+ }
+
+ ctop -= this.mainHd.dom.offsetHeight;
+ stop = parseInt(c.scrollTop, 10);
+
+ var cbot = ctop + rowEl.offsetHeight,
+ ch = c.clientHeight,
+ sbot = stop + ch;
+
+
+ if (ctop < stop) {
+ c.scrollTop = ctop;
+ } else if(cbot > sbot) {
+ c.scrollTop = cbot-ch;
+ }
+
+ if (hscroll !== false) {
+ var cleft = parseInt(cellEl.offsetLeft, 10),
+ cright = cleft + cellEl.offsetWidth,
+ sleft = parseInt(c.scrollLeft, 10),
+ sright = sleft + c.clientWidth;
+
+ if (cleft < sleft) {
+ c.scrollLeft = cleft;
+ } else if(cright > sright) {
+ c.scrollLeft = cright-c.clientWidth;
+ }
+ }
+
+ return this.getResolvedXY(resolved);
},
// private
- beforeUpdate : function(){
- this.grid.stopEditing(true);
+ insertRows : function(dm, firstRow, lastRow, isUpdate) {
+ var last = dm.getCount() - 1;
+ if( !isUpdate && firstRow === 0 && lastRow >= last) {
+ this.fireEvent('beforerowsinserted', this, firstRow, lastRow);
+ this.refresh();
+ this.fireEvent('rowsinserted', this, firstRow, lastRow);
+ } else {
+ if (!isUpdate) {
+ this.fireEvent('beforerowsinserted', this, firstRow, lastRow);
+ }
+ var html = this.renderRows(firstRow, lastRow),
+ before = this.getRow(firstRow);
+ if (before) {
+ if(firstRow === 0){
+ Ext.fly(this.getRow(0)).removeClass(this.firstRowCls);
+ }
+ Ext.DomHelper.insertHtml('beforeBegin', before, html);
+ } else {
+ var r = this.getRow(last - 1);
+ if(r){
+ Ext.fly(r).removeClass(this.lastRowCls);
+ }
+ Ext.DomHelper.insertHtml('beforeEnd', this.mainBody.dom, html);
+ }
+ if (!isUpdate) {
+ this.processRows(firstRow);
+ this.fireEvent('rowsinserted', this, firstRow, lastRow);
+ } else if (firstRow === 0 || firstRow >= last) {
+ //ensure first/last row is kept after an update.
+ Ext.fly(this.getRow(firstRow)).addClass(firstRow === 0 ? this.firstRowCls : this.lastRowCls);
+ }
+ }
+ this.syncFocusEl(firstRow);
+ },
+
+ /**
+ * @private
+ * DEPRECATED - this doesn't appear to be called anywhere in the library, remove in 4.0.
+ */
+ deleteRows : function(dm, firstRow, lastRow) {
+ if (dm.getRowCount() < 1) {
+ this.refresh();
+ } else {
+ this.fireEvent('beforerowsdeleted', this, firstRow, lastRow);
+
+ this.removeRows(firstRow, lastRow);
+
+ this.processRows(firstRow);
+ this.fireEvent('rowsdeleted', this, firstRow, lastRow);
+ }
+ },
+
+ /**
+ * @private
+ * Builds a CSS string for the given column index
+ * @param {Number} colIndex The column index
+ * @param {Boolean} isHeader True if getting the style for the column's header
+ * @return {String} The CSS string
+ */
+ getColumnStyle : function(colIndex, isHeader) {
+ var colModel = this.cm,
+ colConfig = colModel.config,
+ style = isHeader ? '' : colConfig[colIndex].css || '',
+ align = colConfig[colIndex].align;
+
+ style += String.format("width: {0};", this.getColumnWidth(colIndex));
+
+ if (colModel.isHidden(colIndex)) {
+ style += 'display: none; ';
+ }
+
+ if (align) {
+ style += String.format("text-align: {0};", align);
+ }
+
+ return style;
+ },
+
+ /**
+ * @private
+ * Returns the width of a given column minus its border width
+ * @return {Number} The column index
+ * @return {String|Number} The width in pixels
+ */
+ getColumnWidth : function(column) {
+ var columnWidth = this.cm.getColumnWidth(column),
+ borderWidth = this.borderWidth;
+
+ if (Ext.isNumber(columnWidth)) {
+ if (Ext.isBorderBox || (Ext.isWebKit && !Ext.isSafari2)) {
+ return columnWidth + "px";
+ } else {
+ return Math.max(columnWidth - borderWidth, 0) + "px";
+ }
+ } else {
+ return columnWidth;
+ }
+ },
+
+ /**
+ * @private
+ * Returns the total width of all visible columns
+ * @return {String}
+ */
+ getTotalWidth : function() {
+ return this.cm.getTotalWidth() + 'px';
+ },
+
+ /**
+ * @private
+ * Resizes each column to fit the available grid width.
+ * TODO: The second argument isn't even used, remove it in 4.0
+ * @param {Boolean} preventRefresh True to prevent resizing of each row to the new column sizes (defaults to false)
+ * @param {null} onlyExpand NOT USED, will be removed in 4.0
+ * @param {Number} omitColumn The index of a column to leave at its current width. Defaults to undefined
+ * @return {Boolean} True if the operation succeeded, false if not or undefined if the grid view is not yet initialized
+ */
+ fitColumns : function(preventRefresh, onlyExpand, omitColumn) {
+ var grid = this.grid,
+ colModel = this.cm,
+ totalColWidth = colModel.getTotalWidth(false),
+ gridWidth = this.getGridInnerWidth(),
+ extraWidth = gridWidth - totalColWidth,
+ columns = [],
+ extraCol = 0,
+ width = 0,
+ colWidth, fraction, i;
+
+ // not initialized, so don't screw up the default widths
+ if (gridWidth < 20 || extraWidth === 0) {
+ return false;
+ }
+
+ var visibleColCount = colModel.getColumnCount(true),
+ totalColCount = colModel.getColumnCount(false),
+ adjCount = visibleColCount - (Ext.isNumber(omitColumn) ? 1 : 0);
+
+ if (adjCount === 0) {
+ adjCount = 1;
+ omitColumn = undefined;
+ }
+
+ //FIXME: the algorithm used here is odd and potentially confusing. Includes this for loop and the while after it.
+ for (i = 0; i < totalColCount; i++) {
+ if (!colModel.isFixed(i) && i !== omitColumn) {
+ colWidth = colModel.getColumnWidth(i);
+ columns.push(i, colWidth);
+
+ if (!colModel.isHidden(i)) {
+ extraCol = i;
+ width += colWidth;
+ }
+ }
+ }
+
+ fraction = (gridWidth - colModel.getTotalWidth()) / width;
+
+ while (columns.length) {
+ colWidth = columns.pop();
+ i = columns.pop();
+
+ colModel.setColumnWidth(i, Math.max(grid.minColumnWidth, Math.floor(colWidth + colWidth * fraction)), true);
+ }
+
+ //this has been changed above so remeasure now
+ totalColWidth = colModel.getTotalWidth(false);
+
+ if (totalColWidth > gridWidth) {
+ var adjustCol = (adjCount == visibleColCount) ? extraCol : omitColumn,
+ newWidth = Math.max(1, colModel.getColumnWidth(adjustCol) - (totalColWidth - gridWidth));
+
+ colModel.setColumnWidth(adjustCol, newWidth, true);
+ }
+
+ if (preventRefresh !== true) {
+ this.updateAllColumnWidths();
+ }
+
+ return true;
+ },
+
+ /**
+ * @private
+ * Resizes the configured autoExpandColumn to take the available width after the other columns have
+ * been accounted for
+ * @param {Boolean} preventUpdate True to prevent the resizing of all rows (defaults to false)
+ */
+ autoExpand : function(preventUpdate) {
+ var grid = this.grid,
+ colModel = this.cm,
+ gridWidth = this.getGridInnerWidth(),
+ totalColumnWidth = colModel.getTotalWidth(false),
+ autoExpandColumn = grid.autoExpandColumn;
+
+ if (!this.userResized && autoExpandColumn) {
+ if (gridWidth != totalColumnWidth) {
+ //if we are not already using all available width, resize the autoExpandColumn
+ var colIndex = colModel.getIndexById(autoExpandColumn),
+ currentWidth = colModel.getColumnWidth(colIndex),
+ desiredWidth = gridWidth - totalColumnWidth + currentWidth,
+ newWidth = Math.min(Math.max(desiredWidth, grid.autoExpandMin), grid.autoExpandMax);
+
+ if (currentWidth != newWidth) {
+ colModel.setColumnWidth(colIndex, newWidth, true);
+
+ if (preventUpdate !== true) {
+ this.updateColumnWidth(colIndex, newWidth);
+ }
+ }
+ }
+ }
+ },
+
+ /**
+ * Returns the total internal width available to the grid, taking the scrollbar into account
+ * @return {Number} The total width
+ */
+ getGridInnerWidth: function() {
+ return this.grid.getGridEl().getWidth(true) - this.getScrollOffset();
+ },
+
+ /**
+ * @private
+ * Returns an array of column configurations - one for each column
+ * @return {Array} Array of column config objects. This includes the column name, renderer, id style and renderer
+ */
+ getColumnData : function() {
+ var columns = [],
+ colModel = this.cm,
+ colCount = colModel.getColumnCount(),
+ fields = this.ds.fields,
+ i, name;
+
+ for (i = 0; i < colCount; i++) {
+ name = colModel.getDataIndex(i);
+
+ columns[i] = {
+ name : Ext.isDefined(name) ? name : (fields.get(i) ? fields.get(i).name : undefined),
+ renderer: colModel.getRenderer(i),
+ scope : colModel.getRendererScope(i),
+ id : colModel.getColumnId(i),
+ style : this.getColumnStyle(i)
+ };
+ }
+
+ return columns;
+ },
+
+ /**
+ * @private
+ * Renders rows between start and end indexes
+ * @param {Number} startRow Index of the first row to render
+ * @param {Number} endRow Index of the last row to render
+ */
+ renderRows : function(startRow, endRow) {
+ var grid = this.grid,
+ store = grid.store,
+ stripe = grid.stripeRows,
+ colModel = grid.colModel,
+ colCount = colModel.getColumnCount(),
+ rowCount = store.getCount(),
+ records;
+
+ if (rowCount < 1) {
+ return '';
+ }
+
+ startRow = startRow || 0;
+ endRow = Ext.isDefined(endRow) ? endRow : rowCount - 1;
+ records = store.getRange(startRow, endRow);
+
+ return this.doRender(this.getColumnData(), records, store, startRow, colCount, stripe);
},
// private
- updateHeaders : function(){
- this.innerHd.firstChild.innerHTML = this.renderHeaders();
- this.innerHd.firstChild.style.width = this.getOffsetWidth();
- this.innerHd.firstChild.firstChild.style.width = this.getTotalWidth();
+ renderBody : function(){
+ var markup = this.renderRows() || ' ';
+ return this.templates.body.apply({rows: markup});
+ },
+
+ /**
+ * @private
+ * Refreshes a row by re-rendering it. Fires the rowupdated event when done
+ */
+ refreshRow: function(record) {
+ var store = this.ds,
+ colCount = this.cm.getColumnCount(),
+ columns = this.getColumnData(),
+ last = colCount - 1,
+ cls = ['x-grid3-row'],
+ rowParams = {
+ tstyle: String.format("width: {0};", this.getTotalWidth())
+ },
+ colBuffer = [],
+ cellTpl = this.templates.cell,
+ rowIndex, row, column, meta, css, i;
+
+ if (Ext.isNumber(record)) {
+ rowIndex = record;
+ record = store.getAt(rowIndex);
+ } else {
+ rowIndex = store.indexOf(record);
+ }
+
+ //the record could not be found
+ if (!record || rowIndex < 0) {
+ return;
+ }
+
+ //builds each column in this row
+ for (i = 0; i < colCount; i++) {
+ column = columns[i];
+
+ if (i == 0) {
+ css = 'x-grid3-cell-first';
+ } else {
+ css = (i == last) ? 'x-grid3-cell-last ' : '';
+ }
+
+ meta = {
+ id : column.id,
+ style : column.style,
+ css : css,
+ attr : "",
+ cellAttr: ""
+ };
+ // Need to set this after, because we pass meta to the renderer
+ meta.value = column.renderer.call(column.scope, record.data[column.name], meta, record, rowIndex, i, store);
+
+ if (Ext.isEmpty(meta.value)) {
+ meta.value = ' ';
+ }
+
+ if (this.markDirty && record.dirty && typeof record.modified[column.name] != 'undefined') {
+ meta.css += ' x-grid3-dirty-cell';
+ }
+
+ colBuffer[i] = cellTpl.apply(meta);
+ }
+
+ row = this.getRow(rowIndex);
+ row.className = '';
+
+ if (this.grid.stripeRows && ((rowIndex + 1) % 2 === 0)) {
+ cls.push('x-grid3-row-alt');
+ }
+
+ if (this.getRowClass) {
+ rowParams.cols = colCount;
+ cls.push(this.getRowClass(record, rowIndex, rowParams, store));
+ }
+
+ this.fly(row).addClass(cls).setStyle(rowParams.tstyle);
+ rowParams.cells = colBuffer.join("");
+ row.innerHTML = this.templates.rowInner.apply(rowParams);
+
+ this.fireEvent('rowupdated', this, rowIndex, record);
+ },
+
+ /**
+ * Refreshs the grid UI
+ * @param {Boolean} headersToo (optional) True to also refresh the headers
+ */
+ refresh : function(headersToo) {
+ this.fireEvent('beforerefresh', this);
+ this.grid.stopEditing(true);
+
+ var result = this.renderBody();
+ this.mainBody.update(result).setWidth(this.getTotalWidth());
+ if (headersToo === true) {
+ this.updateHeaders();
+ this.updateHeaderSortState();
+ }
+ this.processRows(0, true);
+ this.layout();
+ this.applyEmptyText();
+ this.fireEvent('refresh', this);
},
/**
- * Focuses the specified row.
- * @param {Number} row The row index
+ * @private
+ * Displays the configured emptyText if there are currently no rows to display
*/
- focusRow : function(row){
- this.focusCell(row, 0, false);
+ applyEmptyText : function() {
+ if (this.emptyText && !this.hasRows()) {
+ this.mainBody.update('<div class="x-grid-empty">' + this.emptyText + '</div>');
+ }
},
/**
- * Focuses the specified cell.
- * @param {Number} row The row index
- * @param {Number} col The column index
+ * @private
+ * Adds sorting classes to the column headers based on the bound store's sortInfo. Fires the 'sortchange' event
+ * if the sorting has changed since this function was last run.
*/
- focusCell : function(row, col, hscroll){
- this.syncFocusEl(this.ensureVisible(row, col, hscroll));
- if(Ext.isGecko){
- this.focusEl.focus();
- }else{
- this.focusEl.focus.defer(1, this.focusEl);
+ updateHeaderSortState : function() {
+ var state = this.ds.getSortState();
+ if (!state) {
+ return;
}
- },
- resolveCell : function(row, col, hscroll){
- if(typeof row != "number"){
- row = row.rowIndex;
+ if (!this.sortState || (this.sortState.field != state.field || this.sortState.direction != state.direction)) {
+ this.grid.fireEvent('sortchange', this.grid, state);
}
- if(!this.ds){
- return null;
+
+ this.sortState = state;
+
+ var sortColumn = this.cm.findColumnIndex(state.field);
+ if (sortColumn != -1) {
+ var sortDir = state.direction;
+ this.updateSortIcon(sortColumn, sortDir);
}
- if(row < 0 || row >= this.ds.getCount()){
- return null;
+ },
+
+ /**
+ * @private
+ * Removes any sorting indicator classes from the column headers
+ */
+ clearHeaderSortState : function() {
+ if (!this.sortState) {
+ return;
}
- col = (col !== undefined ? col : 0);
+ this.grid.fireEvent('sortchange', this.grid, null);
+ this.mainHd.select('td').removeClass(this.sortClasses);
+ delete this.sortState;
+ },
- var rowEl = this.getRow(row),
- cm = this.cm,
- colCount = cm.getColumnCount(),
- cellEl;
- if(!(hscroll === false && col === 0)){
- while(col < colCount && cm.isHidden(col)){
- col++;
+ /**
+ * @private
+ * Destroys all objects associated with the GridView
+ */
+ destroy : function() {
+ var me = this,
+ grid = me.grid,
+ gridEl = grid.getGridEl(),
+ dragZone = me.dragZone,
+ splitZone = me.splitZone,
+ columnDrag = me.columnDrag,
+ columnDrop = me.columnDrop,
+ scrollToTopTask = me.scrollToTopTask,
+ columnDragData,
+ columnDragProxy;
+
+ if (scrollToTopTask && scrollToTopTask.cancel) {
+ scrollToTopTask.cancel();
+ }
+
+ Ext.destroyMembers(me, 'colMenu', 'hmenu');
+
+ me.initData(null, null);
+ me.purgeListeners();
+
+ Ext.fly(me.innerHd).un("click", me.handleHdDown, me);
+
+ if (grid.enableColumnMove) {
+ columnDragData = columnDrag.dragData;
+ columnDragProxy = columnDrag.proxy;
+ Ext.destroy(
+ columnDrag.el,
+ columnDragProxy.ghost,
+ columnDragProxy.el,
+ columnDrop.el,
+ columnDrop.proxyTop,
+ columnDrop.proxyBottom,
+ columnDragData.ddel,
+ columnDragData.header
+ );
+
+ if (columnDragProxy.anim) {
+ Ext.destroy(columnDragProxy.anim);
}
- cellEl = this.getCell(row, col);
+
+ delete columnDragProxy.ghost;
+ delete columnDragData.ddel;
+ delete columnDragData.header;
+ columnDrag.destroy();
+
+ delete Ext.dd.DDM.locationCache[columnDrag.id];
+ delete columnDrag._domRef;
+
+ delete columnDrop.proxyTop;
+ delete columnDrop.proxyBottom;
+ columnDrop.destroy();
+ delete Ext.dd.DDM.locationCache["gridHeader" + gridEl.id];
+ delete columnDrop._domRef;
+ delete Ext.dd.DDM.ids[columnDrop.ddGroup];
}
- return {row: rowEl, cell: cellEl};
- },
+ if (splitZone) { // enableColumnResize
+ splitZone.destroy();
+ delete splitZone._domRef;
+ delete Ext.dd.DDM.ids["gridSplitters" + gridEl.id];
+ }
- getResolvedXY : function(resolved){
- if(!resolved){
- return null;
+ Ext.fly(me.innerHd).removeAllListeners();
+ Ext.removeNode(me.innerHd);
+ delete me.innerHd;
+
+ Ext.destroy(
+ me.el,
+ me.mainWrap,
+ me.mainHd,
+ me.scroller,
+ me.mainBody,
+ me.focusEl,
+ me.resizeMarker,
+ me.resizeProxy,
+ me.activeHdBtn,
+ me._flyweight,
+ dragZone,
+ splitZone
+ );
+
+ delete grid.container;
+
+ if (dragZone) {
+ dragZone.destroy();
}
- var s = this.scroller.dom, c = resolved.cell, r = resolved.row;
- return c ? Ext.fly(c).getXY() : [this.el.getX(), Ext.fly(r).getY()];
+
+ Ext.dd.DDM.currentTarget = null;
+ delete Ext.dd.DDM.locationCache[gridEl.id];
+
+ Ext.EventManager.removeResizeListener(me.onWindowResize, me);
},
- syncFocusEl : function(row, col, hscroll){
- var xy = row;
- if(!Ext.isArray(xy)){
- row = Math.min(row, Math.max(0, this.getRows().length-1));
- xy = this.getResolvedXY(this.resolveCell(row, col, hscroll));
- }
- this.focusEl.setXY(xy||this.scroller.getXY());
+ // private
+ onDenyColumnHide : function() {
+
},
- ensureVisible : function(row, col, hscroll){
- var resolved = this.resolveCell(row, col, hscroll);
- if(!resolved || !resolved.row){
- return;
+ // private
+ render : function() {
+ if (this.autoFill) {
+ var ct = this.grid.ownerCt;
+
+ if (ct && ct.getLayout()) {
+ ct.on('afterlayout', function() {
+ this.fitColumns(true, true);
+ this.updateHeaders();
+ this.updateHeaderSortState();
+ }, this, {single: true});
+ }
+ } else if (this.forceFit) {
+ this.fitColumns(true, false);
+ } else if (this.grid.autoExpandColumn) {
+ this.autoExpand(true);
}
+
+ this.grid.getGridEl().dom.innerHTML = this.renderUI();
+
+ this.afterRenderUI();
+ },
- var rowEl = resolved.row,
- cellEl = resolved.cell,
- c = this.scroller.dom,
- ctop = 0,
- p = rowEl,
- stop = this.el.dom;
+ /* --------------------------------- Model Events and Handlers --------------------------------*/
+
+ /**
+ * @private
+ * Binds a new Store and ColumnModel to this GridView. Removes any listeners from the old objects (if present)
+ * and adds listeners to the new ones
+ * @param {Ext.data.Store} newStore The new Store instance
+ * @param {Ext.grid.ColumnModel} newColModel The new ColumnModel instance
+ */
+ initData : function(newStore, newColModel) {
+ var me = this;
+
+ if (me.ds) {
+ var oldStore = me.ds;
- while(p && p != stop){
- ctop += p.offsetTop;
- p = p.offsetParent;
+ oldStore.un('add', me.onAdd, me);
+ oldStore.un('load', me.onLoad, me);
+ oldStore.un('clear', me.onClear, me);
+ oldStore.un('remove', me.onRemove, me);
+ oldStore.un('update', me.onUpdate, me);
+ oldStore.un('datachanged', me.onDataChange, me);
+
+ if (oldStore !== newStore && oldStore.autoDestroy) {
+ oldStore.destroy();
+ }
}
- ctop -= this.mainHd.dom.offsetHeight;
- stop = parseInt(c.scrollTop, 10);
+ if (newStore) {
+ newStore.on({
+ scope : me,
+ load : me.onLoad,
+ add : me.onAdd,
+ remove : me.onRemove,
+ update : me.onUpdate,
+ clear : me.onClear,
+ datachanged: me.onDataChange
+ });
+ }
- var cbot = ctop + rowEl.offsetHeight,
- ch = c.clientHeight,
- sbot = stop + ch;
+ if (me.cm) {
+ var oldColModel = me.cm;
+
+ oldColModel.un('configchange', me.onColConfigChange, me);
+ oldColModel.un('widthchange', me.onColWidthChange, me);
+ oldColModel.un('headerchange', me.onHeaderChange, me);
+ oldColModel.un('hiddenchange', me.onHiddenChange, me);
+ oldColModel.un('columnmoved', me.onColumnMove, me);
+ }
-
- if(ctop < stop){
- c.scrollTop = ctop;
- }else if(cbot > sbot){
- c.scrollTop = cbot-ch;
+ if (newColModel) {
+ delete me.lastViewWidth;
+
+ newColModel.on({
+ scope : me,
+ configchange: me.onColConfigChange,
+ widthchange : me.onColWidthChange,
+ headerchange: me.onHeaderChange,
+ hiddenchange: me.onHiddenChange,
+ columnmoved : me.onColumnMove
+ });
}
+
+ me.ds = newStore;
+ me.cm = newColModel;
+ },
- if(hscroll !== false){
- var cleft = parseInt(cellEl.offsetLeft, 10);
- var cright = cleft + cellEl.offsetWidth;
+ // private
+ onDataChange : function(){
+ this.refresh(true);
+ this.updateHeaderSortState();
+ this.syncFocusEl(0);
+ },
- var sleft = parseInt(c.scrollLeft, 10);
- var sright = sleft + c.clientWidth;
- if(cleft < sleft){
- c.scrollLeft = cleft;
- }else if(cright > sright){
- c.scrollLeft = cright-c.clientWidth;
- }
- }
- return this.getResolvedXY(resolved);
+ // private
+ onClear : function() {
+ this.refresh();
+ this.syncFocusEl(0);
},
// private
- insertRows : function(dm, firstRow, lastRow, isUpdate){
- var last = dm.getCount() - 1;
- if(!isUpdate && firstRow === 0 && lastRow >= last){
- this.refresh();
- }else{
- if(!isUpdate){
- this.fireEvent('beforerowsinserted', this, firstRow, lastRow);
- }
- var html = this.renderRows(firstRow, lastRow),
- before = this.getRow(firstRow);
- if(before){
- if(firstRow === 0){
- Ext.fly(this.getRow(0)).removeClass(this.firstRowCls);
- }
- Ext.DomHelper.insertHtml('beforeBegin', before, html);
- }else{
- var r = this.getRow(last - 1);
- if(r){
- Ext.fly(r).removeClass(this.lastRowCls);
- }
- Ext.DomHelper.insertHtml('beforeEnd', this.mainBody.dom, html);
- }
- if(!isUpdate){
- this.fireEvent('rowsinserted', this, firstRow, lastRow);
- this.processRows(firstRow);
- }else if(firstRow === 0 || firstRow >= last){
- //ensure first/last row is kept after an update.
- Ext.fly(this.getRow(firstRow)).addClass(firstRow === 0 ? this.firstRowCls : this.lastRowCls);
- }
- }
- this.syncFocusEl(firstRow);
+ onUpdate : function(store, record) {
+ this.refreshRow(record);
},
// private
- deleteRows : function(dm, firstRow, lastRow){
- if(dm.getRowCount()<1){
- this.refresh();
- }else{
- this.fireEvent('beforerowsdeleted', this, firstRow, lastRow);
+ onAdd : function(store, records, index) {
+ this.insertRows(store, index, index + (records.length-1));
+ },
- this.removeRows(firstRow, lastRow);
+ // private
+ onRemove : function(store, record, index, isUpdate) {
+ if (isUpdate !== true) {
+ this.fireEvent('beforerowremoved', this, index, record);
+ }
+
+ this.removeRow(index);
+
+ if (isUpdate !== true) {
+ this.processRows(index);
+ this.applyEmptyText();
+ this.fireEvent('rowremoved', this, index, record);
+ }
+ },
- this.processRows(firstRow);
- this.fireEvent('rowsdeleted', this, firstRow, lastRow);
+ /**
+ * @private
+ * Called when a store is loaded, scrolls to the top row
+ */
+ onLoad : function() {
+ if (Ext.isGecko) {
+ if (!this.scrollToTopTask) {
+ this.scrollToTopTask = new Ext.util.DelayedTask(this.scrollToTop, this);
+ }
+ this.scrollToTopTask.delay(1);
+ } else {
+ this.scrollToTop();
}
},
// private
- getColumnStyle : function(col, isHeader){
- var style = !isHeader ? (this.cm.config[col].css || '') : '';
- style += 'width:'+this.getColumnWidth(col)+';';
- if(this.cm.isHidden(col)){
- style += 'display:none;';
- }
- var align = this.cm.config[col].align;
- if(align){
- style += 'text-align:'+align+';';
- }
- return style;
+ onColWidthChange : function(cm, col, width) {
+ this.updateColumnWidth(col, width);
},
// private
- getColumnWidth : function(col){
- var w = this.cm.getColumnWidth(col);
- if(typeof w == 'number'){
- return (Ext.isBorderBox || (Ext.isWebKit && !Ext.isSafari2) ? w : (w - this.borderWidth > 0 ? w - this.borderWidth : 0)) + 'px';
- }
- return w;
+ onHeaderChange : function(cm, col, text) {
+ this.updateHeaders();
},
// private
- getTotalWidth : function(){
- return this.cm.getTotalWidth()+'px';
+ onHiddenChange : function(cm, col, hidden) {
+ this.updateColumnHidden(col, hidden);
},
// private
- fitColumns : function(preventRefresh, onlyExpand, omitColumn){
- var cm = this.cm, i;
- var tw = cm.getTotalWidth(false);
- var aw = this.grid.getGridEl().getWidth(true)-this.getScrollOffset();
+ onColumnMove : function(cm, oldIndex, newIndex) {
+ this.indexMap = null;
+ this.refresh(true);
+ this.restoreScroll(this.getScrollState());
+
+ this.afterMove(newIndex);
+ this.grid.fireEvent('columnmove', oldIndex, newIndex);
+ },
- if(aw < 20){ // not initialized, so don't screw up the default widths
- return;
- }
- var extra = aw - tw;
+ // private
+ onColConfigChange : function() {
+ delete this.lastViewWidth;
+ this.indexMap = null;
+ this.refresh(true);
+ },
- if(extra === 0){
- return false;
- }
+ /* -------------------- UI Events and Handlers ------------------------------ */
+ // private
+ initUI : function(grid) {
+ grid.on('headerclick', this.onHeaderClick, this);
+ },
- var vc = cm.getColumnCount(true);
- var ac = vc-(typeof omitColumn == 'number' ? 1 : 0);
- if(ac === 0){
- ac = 1;
- omitColumn = undefined;
- }
- var colCount = cm.getColumnCount();
- var cols = [];
- var extraCol = 0;
- var width = 0;
- var w;
- for (i = 0; i < colCount; i++){
- if(!cm.isHidden(i) && !cm.isFixed(i) && i !== omitColumn){
- w = cm.getColumnWidth(i);
- cols.push(i);
- extraCol = i;
- cols.push(w);
- width += w;
- }
- }
- var frac = (aw - cm.getTotalWidth())/width;
- while (cols.length){
- w = cols.pop();
- i = cols.pop();
- cm.setColumnWidth(i, Math.max(this.grid.minColumnWidth, Math.floor(w + w*frac)), true);
- }
+ // private
+ initEvents : Ext.emptyFn,
- if((tw = cm.getTotalWidth(false)) > aw){
- var adjustCol = ac != vc ? omitColumn : extraCol;
- cm.setColumnWidth(adjustCol, Math.max(1,
- cm.getColumnWidth(adjustCol)- (tw-aw)), true);
+ // private
+ onHeaderClick : function(g, index) {
+ if (this.headersDisabled || !this.cm.isSortable(index)) {
+ return;
}
+ g.stopEditing(true);
+ g.store.sort(this.cm.getDataIndex(index));
+ },
- if(preventRefresh !== true){
- this.updateAllColumnWidths();
+ /**
+ * @private
+ * Adds the hover class to a row when hovered over
+ */
+ onRowOver : function(e, target) {
+ var row = this.findRowIndex(target);
+
+ if (row !== false) {
+ this.addRowClass(row, this.rowOverCls);
}
+ },
+ /**
+ * @private
+ * Removes the hover class from a row on mouseout
+ */
+ onRowOut : function(e, target) {
+ var row = this.findRowIndex(target);
+
+ if (row !== false && !e.within(this.getRow(row), true)) {
+ this.removeRowClass(row, this.rowOverCls);
+ }
+ },
- return true;
+ // private
+ onRowSelect : function(row) {
+ this.addRowClass(row, this.selectedRowClass);
},
// private
- autoExpand : function(preventUpdate){
- var g = this.grid, cm = this.cm;
- if(!this.userResized && g.autoExpandColumn){
- var tw = cm.getTotalWidth(false);
- var aw = this.grid.getGridEl().getWidth(true)-this.getScrollOffset();
- if(tw != aw){
- var ci = cm.getIndexById(g.autoExpandColumn);
- var currentWidth = cm.getColumnWidth(ci);
- var cw = Math.min(Math.max(((aw-tw)+currentWidth), g.autoExpandMin), g.autoExpandMax);
- if(cw != currentWidth){
- cm.setColumnWidth(ci, cw, true);
- if(preventUpdate !== true){
- this.updateColumnWidth(ci, cw);
- }
- }
- }
- }
+ onRowDeselect : function(row) {
+ this.removeRowClass(row, this.selectedRowClass);
},
// private
- getColumnData : function(){
- // build a map for all the columns
- var cs = [], cm = this.cm, colCount = cm.getColumnCount();
- for(var i = 0; i < colCount; i++){
- var name = cm.getDataIndex(i);
- cs[i] = {
- name : (typeof name == 'undefined' ? this.ds.fields.get(i).name : name),
- renderer : cm.getRenderer(i),
- id : cm.getColumnId(i),
- style : this.getColumnStyle(i)
- };
+ onCellSelect : function(row, col) {
+ var cell = this.getCell(row, col);
+ if (cell) {
+ this.fly(cell).addClass('x-grid3-cell-selected');
}
- return cs;
},
// private
- renderRows : function(startRow, endRow){
- // pull in all the crap needed to render rows
- var g = this.grid, cm = g.colModel, ds = g.store, stripe = g.stripeRows;
- var colCount = cm.getColumnCount();
-
- if(ds.getCount() < 1){
- return '';
+ onCellDeselect : function(row, col) {
+ var cell = this.getCell(row, col);
+ if (cell) {
+ this.fly(cell).removeClass('x-grid3-cell-selected');
}
+ },
- var cs = this.getColumnData();
+ // private
+ handleWheel : function(e) {
+ e.stopPropagation();
+ },
- startRow = startRow || 0;
- endRow = typeof endRow == "undefined"? ds.getCount()-1 : endRow;
+ /**
+ * @private
+ * Called by the SplitDragZone when a drag has been completed. Resizes the columns
+ */
+ onColumnSplitterMoved : function(cellIndex, width) {
+ this.userResized = true;
+ this.grid.colModel.setColumnWidth(cellIndex, width, true);
- // records to render
- var rs = ds.getRange(startRow, endRow);
+ if (this.forceFit) {
+ this.fitColumns(true, false, cellIndex);
+ this.updateAllColumnWidths();
+ } else {
+ this.updateColumnWidth(cellIndex, width);
+ this.syncHeaderScroll();
+ }
- return this.doRender(cs, rs, ds, startRow, colCount, stripe);
+ this.grid.fireEvent('columnresize', cellIndex, width);
},
- // private
- renderBody : function(){
- var markup = this.renderRows() || ' ';
- return this.templates.body.apply({rows: markup});
- },
+ /**
+ * @private
+ * Click handler for the shared column dropdown menu, called on beforeshow. Builds the menu
+ * which displays the list of columns for the user to show or hide.
+ */
+ beforeColMenuShow : function() {
+ var colModel = this.cm,
+ colCount = colModel.getColumnCount(),
+ colMenu = this.colMenu,
+ i;
- // private
- refreshRow : function(record){
- var ds = this.ds, index;
- if(typeof record == 'number'){
- index = record;
- record = ds.getAt(index);
- if(!record){
- return;
- }
- }else{
- index = ds.indexOf(record);
- if(index < 0){
- return;
+ colMenu.removeAll();
+
+ for (i = 0; i < colCount; i++) {
+ if (colModel.config[i].hideable !== false) {
+ colMenu.add(new Ext.menu.CheckItem({
+ text : colModel.getColumnHeader(i),
+ itemId : 'col-' + colModel.getColumnId(i),
+ checked : !colModel.isHidden(i),
+ disabled : colModel.config[i].hideable === false,
+ hideOnClick: false
+ }));
}
}
- this.insertRows(ds, index, index, true);
- this.getRow(index).rowIndex = index;
- this.onRemove(ds, record, index+1, true);
- this.fireEvent('rowupdated', this, index, record);
},
-
+
/**
- * Refreshs the grid UI
- * @param {Boolean} headersToo (optional) True to also refresh the headers
+ * @private
+ * Attached as the 'itemclick' handler to the header menu and the column show/hide submenu (if available).
+ * Performs sorting if the sorter buttons were clicked, otherwise hides/shows the column that was clicked.
*/
- refresh : function(headersToo){
- this.fireEvent('beforerefresh', this);
- this.grid.stopEditing(true);
+ handleHdMenuClick : function(item) {
+ var store = this.ds,
+ dataIndex = this.cm.getDataIndex(this.hdCtxIndex);
- var result = this.renderBody();
- this.mainBody.update(result).setWidth(this.getTotalWidth());
- if(headersToo === true){
- this.updateHeaders();
- this.updateHeaderSortState();
+ switch (item.getItemId()) {
+ case 'asc':
+ store.sort(dataIndex, 'ASC');
+ break;
+ case 'desc':
+ store.sort(dataIndex, 'DESC');
+ break;
+ default:
+ this.handleHdMenuClickDefault(item);
}
- this.processRows(0, true);
- this.layout();
- this.applyEmptyText();
- this.fireEvent('refresh', this);
+ return true;
},
-
- // private
- applyEmptyText : function(){
- if(this.emptyText && !this.hasRows()){
- this.mainBody.update('<div class="x-grid-empty">' + this.emptyText + '</div>');
+
+ /**
+ * Called by handleHdMenuClick if any button except a sort ASC/DESC button was clicked. The default implementation provides
+ * the column hide/show functionality based on the check state of the menu item. A different implementation can be provided
+ * if needed.
+ * @param {Ext.menu.BaseItem} item The menu item that was clicked
+ */
+ handleHdMenuClickDefault: function(item) {
+ var colModel = this.cm,
+ itemId = item.getItemId(),
+ index = colModel.getIndexById(itemId.substr(4));
+
+ if (index != -1) {
+ if (item.checked && colModel.getColumnsBy(this.isHideableColumn, this).length <= 1) {
+ this.onDenyColumnHide();
+ return;
+ }
+ colModel.setHidden(index, item.checked);
}
},
- // private
- updateHeaderSortState : function(){
- var state = this.ds.getSortState();
- if(!state){
- return;
- }
- if(!this.sortState || (this.sortState.field != state.field || this.sortState.direction != state.direction)){
- this.grid.fireEvent('sortchange', this.grid, state);
- }
- this.sortState = state;
- var sortColumn = this.cm.findColumnIndex(state.field);
- if(sortColumn != -1){
- var sortDir = state.direction;
- this.updateSortIcon(sortColumn, sortDir);
+ /**
+ * @private
+ * Called when a header cell is clicked - shows the menu if the click happened over a trigger button
+ */
+ handleHdDown : function(e, target) {
+ if (Ext.fly(target).hasClass('x-grid3-hd-btn')) {
+ e.stopEvent();
+
+ var colModel = this.cm,
+ header = this.findHeaderCell(target),
+ index = this.getCellIndex(header),
+ sortable = colModel.isSortable(index),
+ menu = this.hmenu,
+ menuItems = menu.items,
+ menuCls = this.headerMenuOpenCls;
+
+ this.hdCtxIndex = index;
+
+ Ext.fly(header).addClass(menuCls);
+ menuItems.get('asc').setDisabled(!sortable);
+ menuItems.get('desc').setDisabled(!sortable);
+
+ menu.on('hide', function() {
+ Ext.fly(header).removeClass(menuCls);
+ }, this, {single:true});
+
+ menu.show(target, 'tl-bl?');
}
},
- // private
- destroy : function(){
- if(this.colMenu){
- Ext.menu.MenuMgr.unregister(this.colMenu);
- this.colMenu.destroy();
- delete this.colMenu;
+ /**
+ * @private
+ * Attached to the headers' mousemove event. This figures out the CSS cursor to use based on where the mouse is currently
+ * pointed. If the mouse is currently hovered over the extreme left or extreme right of any header cell and the cell next
+ * to it is resizable it is given the resize cursor, otherwise the cursor is set to an empty string.
+ */
+ handleHdMove : function(e) {
+ var header = this.findHeaderCell(this.activeHdRef);
+
+ if (header && !this.headersDisabled) {
+ var handleWidth = this.splitHandleWidth || 5,
+ activeRegion = this.activeHdRegion,
+ headerStyle = header.style,
+ colModel = this.cm,
+ cursor = '',
+ pageX = e.getPageX();
+
+ if (this.grid.enableColumnResize !== false) {
+ var activeHeaderIndex = this.activeHdIndex,
+ previousVisible = this.getPreviousVisible(activeHeaderIndex),
+ currentResizable = colModel.isResizable(activeHeaderIndex),
+ previousResizable = previousVisible && colModel.isResizable(previousVisible),
+ inLeftResizer = pageX - activeRegion.left <= handleWidth,
+ inRightResizer = activeRegion.right - pageX <= (!this.activeHdBtn ? handleWidth : 2);
+
+ if (inLeftResizer && previousResizable) {
+ cursor = Ext.isAir ? 'move' : Ext.isWebKit ? 'e-resize' : 'col-resize'; // col-resize not always supported
+ } else if (inRightResizer && currentResizable) {
+ cursor = Ext.isAir ? 'move' : Ext.isWebKit ? 'w-resize' : 'col-resize';
+ }
+ }
+
+ headerStyle.cursor = cursor;
}
- if(this.hmenu){
- Ext.menu.MenuMgr.unregister(this.hmenu);
- this.hmenu.destroy();
- delete this.hmenu;
+ },
+
+ /**
+ * @private
+ * Returns the index of the nearest currently visible header to the left of the given index.
+ * @param {Number} index The header index
+ * @return {Number/undefined} The index of the nearest visible header
+ */
+ getPreviousVisible: function(index) {
+ while (index > 0) {
+ if (!this.cm.isHidden(index - 1)) {
+ return index;
+ }
+ index--;
}
+ return undefined;
+ },
- this.initData(null, null);
- this.purgeListeners();
- Ext.fly(this.innerHd).un("click", this.handleHdDown, this);
-
- if(this.grid.enableColumnMove){
- Ext.destroy(
- this.columnDrag.el,
- this.columnDrag.proxy.ghost,
- this.columnDrag.proxy.el,
- this.columnDrop.el,
- this.columnDrop.proxyTop,
- this.columnDrop.proxyBottom,
- this.columnDrag.dragData.ddel,
- this.columnDrag.dragData.header
- );
- if (this.columnDrag.proxy.anim) {
- Ext.destroy(this.columnDrag.proxy.anim);
+ /**
+ * @private
+ * Tied to the header element's mouseover event - adds the over class to the header cell if the menu is not disabled
+ * for that cell
+ */
+ handleHdOver : function(e, target) {
+ var header = this.findHeaderCell(target);
+
+ if (header && !this.headersDisabled) {
+ var fly = this.fly(header);
+
+ this.activeHdRef = target;
+ this.activeHdIndex = this.getCellIndex(header);
+ this.activeHdRegion = fly.getRegion();
+
+ if (!this.isMenuDisabled(this.activeHdIndex, fly)) {
+ fly.addClass('x-grid3-hd-over');
+ this.activeHdBtn = fly.child('.x-grid3-hd-btn');
+
+ if (this.activeHdBtn) {
+ this.activeHdBtn.dom.style.height = (header.firstChild.offsetHeight - 1) + 'px';
+ }
}
- delete this.columnDrag.proxy.ghost;
- delete this.columnDrag.dragData.ddel;
- delete this.columnDrag.dragData.header;
- this.columnDrag.destroy();
- delete Ext.dd.DDM.locationCache[this.columnDrag.id];
- delete this.columnDrag._domRef;
-
- delete this.columnDrop.proxyTop;
- delete this.columnDrop.proxyBottom;
- this.columnDrop.destroy();
- delete Ext.dd.DDM.locationCache["gridHeader" + this.grid.getGridEl().id];
- delete this.columnDrop._domRef;
- delete Ext.dd.DDM.ids[this.columnDrop.ddGroup];
}
+ },
- if (this.splitone){ // enableColumnResize
- this.splitone.destroy();
- delete this.splitone._domRef;
- delete Ext.dd.DDM.ids["gridSplitters" + this.grid.getGridEl().id];
+ /**
+ * @private
+ * Tied to the header element's mouseout event. Removes the hover class from the header cell
+ */
+ handleHdOut : function(e, target) {
+ var header = this.findHeaderCell(target);
+
+ if (header && (!Ext.isIE || !e.within(header, true))) {
+ this.activeHdRef = null;
+ this.fly(header).removeClass('x-grid3-hd-over');
+ header.style.cursor = '';
}
+ },
+
+ /**
+ * @private
+ * Used by {@link #handleHdOver} to determine whether or not to show the header menu class on cell hover
+ * @param {Number} cellIndex The header cell index
+ * @param {Ext.Element} el The cell element currently being hovered over
+ */
+ isMenuDisabled: function(cellIndex, el) {
+ return this.cm.isMenuDisabled(cellIndex);
+ },
- Ext.fly(this.innerHd).removeAllListeners();
- Ext.removeNode(this.innerHd);
- delete this.innerHd;
-
- Ext.destroy(
- this.el,
- this.mainWrap,
- this.mainHd,
- this.scroller,
- this.mainBody,
- this.focusEl,
- this.resizeMarker,
- this.resizeProxy,
- this.activeHdBtn,
- this.dragZone,
- this.splitZone,
- this._flyweight
- );
+ /**
+ * @private
+ * Returns true if there are any rows rendered into the GridView
+ * @return {Boolean} True if any rows have been rendered
+ */
+ hasRows : function() {
+ var fc = this.mainBody.dom.firstChild;
+ return fc && fc.nodeType == 1 && fc.className != 'x-grid-empty';
+ },
+
+ /**
+ * @private
+ */
+ isHideableColumn : function(c) {
+ return !c.hidden;
+ },
- delete this.grid.container;
+ /**
+ * @private
+ * DEPRECATED - will be removed in Ext JS 5.0
+ */
+ bind : function(d, c) {
+ this.initData(d, c);
+ }
+});
- if(this.dragZone){
- this.dragZone.destroy();
- }
- Ext.dd.DDM.currentTarget = null;
- delete Ext.dd.DDM.locationCache[this.grid.getGridEl().id];
+// private
+// This is a support class used internally by the Grid components
+Ext.grid.GridView.SplitDragZone = Ext.extend(Ext.dd.DDProxy, {
- Ext.EventManager.removeResizeListener(this.onWindowResize, this);
+ constructor: function(grid, hd){
+ this.grid = grid;
+ this.view = grid.getView();
+ this.marker = this.view.resizeMarker;
+ this.proxy = this.view.resizeProxy;
+ Ext.grid.GridView.SplitDragZone.superclass.constructor.call(this, hd,
+ 'gridSplitters' + this.grid.getGridEl().id, {
+ dragElId : Ext.id(this.proxy.dom), resizeFrame:false
+ });
+ this.scroll = false;
+ this.hw = this.view.splitHandleWidth || 5;
},
- // private
- onDenyColumnHide : function(){
+ b4StartDrag : function(x, y){
+ this.dragHeadersDisabled = this.view.headersDisabled;
+ this.view.headersDisabled = true;
+ var h = this.view.mainWrap.getHeight();
+ this.marker.setHeight(h);
+ this.marker.show();
+ this.marker.alignTo(this.view.getHeaderCell(this.cellIndex), 'tl-tl', [-2, 0]);
+ this.proxy.setHeight(h);
+ var w = this.cm.getColumnWidth(this.cellIndex),
+ minw = Math.max(w-this.grid.minColumnWidth, 0);
+ this.resetConstraints();
+ this.setXConstraint(minw, 1000);
+ this.setYConstraint(0, 0);
+ this.minX = x - minw;
+ this.maxX = x + 1000;
+ this.startPos = x;
+ Ext.dd.DDProxy.prototype.b4StartDrag.call(this, x, y);
+ },
+ allowHeaderDrag : function(e){
+ return true;
},
- // private
- render : function(){
- if(this.autoFill){
- var ct = this.grid.ownerCt;
- if (ct && ct.getLayout()){
- ct.on('afterlayout', function(){
- this.fitColumns(true, true);
- this.updateHeaders();
- }, this, {single: true});
- }else{
- this.fitColumns(true, true);
+ handleMouseDown : function(e){
+ var t = this.view.findHeaderCell(e.getTarget());
+ if(t && this.allowHeaderDrag(e)){
+ var xy = this.view.fly(t).getXY(),
+ x = xy[0],
+ exy = e.getXY(),
+ ex = exy[0],
+ w = t.offsetWidth,
+ adjust = false;
+
+ if((ex - x) <= this.hw){
+ adjust = -1;
+ }else if((x+w) - ex <= this.hw){
+ adjust = 0;
+ }
+ if(adjust !== false){
+ this.cm = this.grid.colModel;
+ var ci = this.view.getCellIndex(t);
+ if(adjust == -1){
+ if (ci + adjust < 0) {
+ return;
+ }
+ while(this.cm.isHidden(ci+adjust)){
+ --adjust;
+ if(ci+adjust < 0){
+ return;
+ }
+ }
+ }
+ this.cellIndex = ci+adjust;
+ this.split = t.dom;
+ if(this.cm.isResizable(this.cellIndex) && !this.cm.isFixed(this.cellIndex)){
+ Ext.grid.GridView.SplitDragZone.superclass.handleMouseDown.apply(this, arguments);
+ }
+ }else if(this.view.columnDrag){
+ this.view.columnDrag.callHandleMouseDown(e);
}
- }else if(this.forceFit){
- this.fitColumns(true, false);
- }else if(this.grid.autoExpandColumn){
- this.autoExpand(true);
}
+ },
- this.renderUI();
+ endDrag : function(e){
+ this.marker.hide();
+ var v = this.view,
+ endX = Math.max(this.minX, e.getPageX()),
+ diff = endX - this.startPos,
+ disabled = this.dragHeadersDisabled;
+
+ v.onColumnSplitterMoved(this.cellIndex, this.cm.getColumnWidth(this.cellIndex)+diff);
+ setTimeout(function(){
+ v.headersDisabled = disabled;
+ }, 50);
},
- /* --------------------------------- Model Events and Handlers --------------------------------*/
- // private
- initData : function(ds, cm){
- if(this.ds){
- this.ds.un('load', this.onLoad, this);
- this.ds.un('datachanged', this.onDataChange, this);
- this.ds.un('add', this.onAdd, this);
- this.ds.un('remove', this.onRemove, this);
- this.ds.un('update', this.onUpdate, this);
- this.ds.un('clear', this.onClear, this);
- if(this.ds !== ds && this.ds.autoDestroy){
- this.ds.destroy();
- }
- }
- if(ds){
- ds.on({
- scope: this,
- load: this.onLoad,
- datachanged: this.onDataChange,
- add: this.onAdd,
- remove: this.onRemove,
- update: this.onUpdate,
- clear: this.onClear
- });
+ autoOffset : function(){
+ this.setDelta(0,0);
+ }
+});
+/**
+ * @class Ext.grid.PivotGridView
+ * @extends Ext.grid.GridView
+ * Specialised GridView for rendering Pivot Grid components. Config can be passed to the PivotGridView via the PivotGrid constructor's
+ * viewConfig option:
+<pre><code>
+new Ext.grid.PivotGrid({
+ viewConfig: {
+ title: 'My Pivot Grid',
+ getCellCls: function(value) {
+ return value > 10 'red' : 'green';
}
- this.ds = ds;
+ }
+});
+</code></pre>
+ * <p>Currently {@link #title} and {@link #getCellCls} are the only configuration options accepted by PivotGridView. All other
+ * interaction is performed via the {@link Ext.grid.PivotGrid PivotGrid} class.</p>
+ */
+Ext.grid.PivotGridView = Ext.extend(Ext.grid.GridView, {
+
+ /**
+ * The CSS class added to all group header cells. Defaults to 'grid-hd-group-cell'
+ * @property colHeaderCellCls
+ * @type String
+ */
+ colHeaderCellCls: 'grid-hd-group-cell',
+
+ /**
+ * @cfg {String} title Optional title to be placed in the top left corner of the PivotGrid. Defaults to an empty string.
+ */
+ title: '',
+
+ /**
+ * @cfg {Function} getCellCls Optional function which should return a CSS class name for each cell value. This is useful when
+ * color coding cells based on their value. Defaults to undefined.
+ */
+
+ /**
+ * Returns the headers to be rendered at the top of the grid. Should be a 2-dimensional array, where each item specifies the number
+ * of columns it groups (column in this case refers to normal grid columns). In the example below we have 5 city groups, which are
+ * each part of a continent supergroup. The colspan for each city group refers to the number of normal grid columns that group spans,
+ * so in this case the grid would be expected to have a total of 12 columns:
+<pre><code>
+[
+ {
+ items: [
+ {header: 'England', colspan: 5},
+ {header: 'USA', colspan: 3}
+ ]
+ },
+ {
+ items: [
+ {header: 'London', colspan: 2},
+ {header: 'Cambridge', colspan: 3},
+ {header: 'Palo Alto', colspan: 3}
+ ]
+ }
+]
+</code></pre>
+ * In the example above we have cities nested under countries. The nesting could be deeper if desired - e.g. Continent -> Country ->
+ * State -> City, or any other structure. The only constaint is that the same depth must be used throughout the structure.
+ * @return {Array} A tree structure containing the headers to be rendered. Must include the colspan property at each level, which should
+ * be the sum of all child nodes beneath this node.
+ */
+ getColumnHeaders: function() {
+ return this.grid.topAxis.buildHeaders();;
+ },
+
+ /**
+ * Returns the headers to be rendered on the left of the grid. Should be a 2-dimensional array, where each item specifies the number
+ * of rows it groups. In the example below we have 5 city groups, which are each part of a continent supergroup. The rowspan for each
+ * city group refers to the number of normal grid columns that group spans, so in this case the grid would be expected to have a
+ * total of 12 rows:
+<pre><code>
+[
+ {
+ width: 90,
+ items: [
+ {header: 'England', rowspan: 5},
+ {header: 'USA', rowspan: 3}
+ ]
+ },
+ {
+ width: 50,
+ items: [
+ {header: 'London', rowspan: 2},
+ {header: 'Cambridge', rowspan: 3},
+ {header: 'Palo Alto', rowspan: 3}
+ ]
+ }
+]
+</code></pre>
+ * In the example above we have cities nested under countries. The nesting could be deeper if desired - e.g. Continent -> Country ->
+ * State -> City, or any other structure. The only constaint is that the same depth must be used throughout the structure.
+ * @return {Array} A tree structure containing the headers to be rendered. Must include the colspan property at each level, which should
+ * be the sum of all child nodes beneath this node.
+ * Each group may specify the width it should be rendered with.
+ * @return {Array} The row groups
+ */
+ getRowHeaders: function() {
+ return this.grid.leftAxis.buildHeaders();
+ },
+
+ /**
+ * @private
+ * Renders rows between start and end indexes
+ * @param {Number} startRow Index of the first row to render
+ * @param {Number} endRow Index of the last row to render
+ */
+ renderRows : function(startRow, endRow) {
+ var grid = this.grid,
+ rows = grid.extractData(),
+ rowCount = rows.length,
+ templates = this.templates,
+ renderer = grid.renderer,
+ hasRenderer = typeof renderer == 'function',
+ getCellCls = this.getCellCls,
+ hasGetCellCls = typeof getCellCls == 'function',
+ cellTemplate = templates.cell,
+ rowTemplate = templates.row,
+ rowBuffer = [],
+ meta = {},
+ tstyle = 'width:' + this.getGridInnerWidth() + 'px;',
+ colBuffer, column, i;
+
+ startRow = startRow || 0;
+ endRow = Ext.isDefined(endRow) ? endRow : rowCount - 1;
+
+ for (i = 0; i < rowCount; i++) {
+ row = rows[i];
+ colCount = row.length;
+ colBuffer = [];
+
+ rowIndex = startRow + i;
- if(this.cm){
- this.cm.un('configchange', this.onColConfigChange, this);
- this.cm.un('widthchange', this.onColWidthChange, this);
- this.cm.un('headerchange', this.onHeaderChange, this);
- this.cm.un('hiddenchange', this.onHiddenChange, this);
- this.cm.un('columnmoved', this.onColumnMove, this);
- }
- if(cm){
- delete this.lastViewWidth;
- cm.on({
- scope: this,
- configchange: this.onColConfigChange,
- widthchange: this.onColWidthChange,
- headerchange: this.onHeaderChange,
- hiddenchange: this.onHiddenChange,
- columnmoved: this.onColumnMove
+ //build up each column's HTML
+ for (j = 0; j < colCount; j++) {
+ cell = row[j];
+
+ meta.css = j === 0 ? 'x-grid3-cell-first ' : (j == (colCount - 1) ? 'x-grid3-cell-last ' : '');
+ meta.attr = meta.cellAttr = '';
+ meta.value = cell;
+
+ if (Ext.isEmpty(meta.value)) {
+ meta.value = ' ';
+ }
+
+ if (hasRenderer) {
+ meta.value = renderer(meta.value);
+ }
+
+ if (hasGetCellCls) {
+ meta.css += getCellCls(meta.value) + ' ';
+ }
+
+ colBuffer[colBuffer.length] = cellTemplate.apply(meta);
+ }
+
+ rowBuffer[rowBuffer.length] = rowTemplate.apply({
+ tstyle: tstyle,
+ cols : colCount,
+ cells : colBuffer.join(""),
+ alt : ''
});
}
- this.cm = cm;
- },
-
- // private
- onDataChange : function(){
- this.refresh();
- this.updateHeaderSortState();
- this.syncFocusEl(0);
+
+ return rowBuffer.join("");
},
-
- // private
- onClear : function(){
- this.refresh();
- this.syncFocusEl(0);
+
+ /**
+ * The master template to use when rendering the GridView. Has a default template
+ * @property Ext.Template
+ * @type masterTpl
+ */
+ masterTpl: new Ext.Template(
+ '<div class="x-grid3 x-pivotgrid" hidefocus="true">',
+ '<div class="x-grid3-viewport">',
+ '<div class="x-grid3-header">',
+ '<div class="x-grid3-header-title"><span>{title}</span></div>',
+ '<div class="x-grid3-header-inner">',
+ '<div class="x-grid3-header-offset" style="{ostyle}"></div>',
+ '</div>',
+ '<div class="x-clear"></div>',
+ '</div>',
+ '<div class="x-grid3-scroller">',
+ '<div class="x-grid3-row-headers"></div>',
+ '<div class="x-grid3-body" style="{bstyle}">{body}</div>',
+ '<a href="#" class="x-grid3-focus" tabIndex="-1"></a>',
+ '</div>',
+ '</div>',
+ '<div class="x-grid3-resize-marker"> </div>',
+ '<div class="x-grid3-resize-proxy"> </div>',
+ '</div>'
+ ),
+
+ /**
+ * @private
+ * Adds a gcell template to the internal templates object. This is used to render the headers in a multi-level column header.
+ */
+ initTemplates: function() {
+ Ext.grid.PivotGridView.superclass.initTemplates.apply(this, arguments);
+
+ var templates = this.templates || {};
+ if (!templates.gcell) {
+ templates.gcell = new Ext.XTemplate(
+ '<td class="x-grid3-hd x-grid3-gcell x-grid3-td-{id} ux-grid-hd-group-row-{row} ' + this.colHeaderCellCls + '" style="{style}">',
+ '<div {tooltip} class="x-grid3-hd-inner x-grid3-hd-{id}" unselectable="on" style="{istyle}">',
+ this.grid.enableHdMenu ? '<a class="x-grid3-hd-btn" href="#"></a>' : '', '{value}',
+ '</div>',
+ '</td>'
+ );
+ }
+
+ this.templates = templates;
+ this.hrowRe = new RegExp("ux-grid-hd-group-row-(\\d+)", "");
},
-
- // private
- onUpdate : function(ds, record){
- this.refreshRow(record);
+
+ /**
+ * @private
+ * Sets up the reference to the row headers element
+ */
+ initElements: function() {
+ Ext.grid.PivotGridView.superclass.initElements.apply(this, arguments);
+
+ /**
+ * @property rowHeadersEl
+ * @type Ext.Element
+ * The element containing all row headers
+ */
+ this.rowHeadersEl = new Ext.Element(this.scroller.child('div.x-grid3-row-headers'));
+
+ /**
+ * @property headerTitleEl
+ * @type Ext.Element
+ * The element that contains the optional title (top left section of the pivot grid)
+ */
+ this.headerTitleEl = new Ext.Element(this.mainHd.child('div.x-grid3-header-title'));
},
-
- // private
- onAdd : function(ds, records, index){
- this.insertRows(ds, index, index + (records.length-1));
+
+ /**
+ * @private
+ * Takes row headers into account when calculating total available width
+ */
+ getGridInnerWidth: function() {
+ var previousWidth = Ext.grid.PivotGridView.superclass.getGridInnerWidth.apply(this, arguments);
+
+ return previousWidth - this.getTotalRowHeaderWidth();
},
-
- // private
- onRemove : function(ds, record, index, isUpdate){
- if(isUpdate !== true){
- this.fireEvent('beforerowremoved', this, index, record);
- }
- this.removeRow(index);
- if(isUpdate !== true){
- this.processRows(index);
- this.applyEmptyText();
- this.fireEvent('rowremoved', this, index, record);
+
+ /**
+ * Returns the total width of all row headers as specified by {@link #getRowHeaders}
+ * @return {Number} The total width
+ */
+ getTotalRowHeaderWidth: function() {
+ var headers = this.getRowHeaders(),
+ length = headers.length,
+ total = 0,
+ i;
+
+ for (i = 0; i< length; i++) {
+ total += headers[i].width;
}
+
+ return total;
},
-
- // private
- onLoad : function(){
- this.scrollToTop.defer(Ext.isGecko ? 1 : 0, this);
+
+ /**
+ * @private
+ * Returns the total height of all column headers
+ * @return {Number} The total height
+ */
+ getTotalColumnHeaderHeight: function() {
+ return this.getColumnHeaders().length * 21;
},
-
- // private
- onColWidthChange : function(cm, col, width){
- this.updateColumnWidth(col, width);
+
+ /**
+ * @private
+ * Slight specialisation of the GridView renderUI - just adds the row headers
+ */
+ renderUI : function() {
+ var templates = this.templates,
+ innerWidth = this.getGridInnerWidth();
+
+ return templates.master.apply({
+ body : templates.body.apply({rows:' '}),
+ ostyle: 'width:' + innerWidth + 'px',
+ bstyle: 'width:' + innerWidth + 'px'
+ });
},
-
- // private
- onHeaderChange : function(cm, col, text){
- this.updateHeaders();
+
+ /**
+ * @private
+ * Make sure that the headers and rows are all sized correctly during layout
+ */
+ onLayout: function(width, height) {
+ Ext.grid.PivotGridView.superclass.onLayout.apply(this, arguments);
+
+ var width = this.getGridInnerWidth();
+
+ this.resizeColumnHeaders(width);
+ this.resizeAllRows(width);
},
-
- // private
- onHiddenChange : function(cm, col, hidden){
- this.updateColumnHidden(col, hidden);
+
+ /**
+ * Refreshs the grid UI
+ * @param {Boolean} headersToo (optional) True to also refresh the headers
+ */
+ refresh : function(headersToo) {
+ this.fireEvent('beforerefresh', this);
+ this.grid.stopEditing(true);
+
+ var result = this.renderBody();
+ this.mainBody.update(result).setWidth(this.getGridInnerWidth());
+ if (headersToo === true) {
+ this.updateHeaders();
+ this.updateHeaderSortState();
+ }
+ this.processRows(0, true);
+ this.layout();
+ this.applyEmptyText();
+ this.fireEvent('refresh', this);
},
-
- // private
- onColumnMove : function(cm, oldIndex, newIndex){
- this.indexMap = null;
- var s = this.getScrollState();
- this.refresh(true);
- this.restoreScroll(s);
- this.afterMove(newIndex);
- this.grid.fireEvent('columnmove', oldIndex, newIndex);
+
+ /**
+ * @private
+ * Bypasses GridView's renderHeaders as they are taken care of separately by the PivotAxis instances
+ */
+ renderHeaders: Ext.emptyFn,
+
+ /**
+ * @private
+ * Taken care of by PivotAxis
+ */
+ fitColumns: Ext.emptyFn,
+
+ /**
+ * @private
+ * Called on layout, ensures that the width of each column header is correct. Omitting this can lead to faulty
+ * layouts when nested in a container.
+ * @param {Number} width The new width
+ */
+ resizeColumnHeaders: function(width) {
+ var topAxis = this.grid.topAxis;
+
+ if (topAxis.rendered) {
+ topAxis.el.setWidth(width);
+ }
},
-
- // private
- onColConfigChange : function(){
- delete this.lastViewWidth;
- this.indexMap = null;
- this.refresh(true);
+
+ /**
+ * @private
+ * Sets the row header div to the correct width. Should be called after rendering and reconfiguration of headers
+ */
+ resizeRowHeaders: function() {
+ var rowHeaderWidth = this.getTotalRowHeaderWidth(),
+ marginStyle = String.format("margin-left: {0}px;", rowHeaderWidth);
+
+ this.rowHeadersEl.setWidth(rowHeaderWidth);
+ this.mainBody.applyStyles(marginStyle);
+ Ext.fly(this.innerHd).applyStyles(marginStyle);
+
+ this.headerTitleEl.setWidth(rowHeaderWidth);
+ this.headerTitleEl.setHeight(this.getTotalColumnHeaderHeight());
},
-
- /* -------------------- UI Events and Handlers ------------------------------ */
- // private
- initUI : function(grid){
- grid.on('headerclick', this.onHeaderClick, this);
+
+ /**
+ * @private
+ * Resizes all rendered rows to the given width. Usually called by onLayout
+ * @param {Number} width The new width
+ */
+ resizeAllRows: function(width) {
+ var rows = this.getRows(),
+ length = rows.length,
+ i;
+
+ for (i = 0; i < length; i++) {
+ Ext.fly(rows[i]).setWidth(width);
+ Ext.fly(rows[i]).child('table').setWidth(width);
+ }
},
-
- // private
- initEvents : function(){
+
+ /**
+ * @private
+ * Updates the Row Headers, deferring the updating of Column Headers to GridView
+ */
+ updateHeaders: function() {
+ this.renderGroupRowHeaders();
+ this.renderGroupColumnHeaders();
},
-
- // private
- onHeaderClick : function(g, index){
- if(this.headersDisabled || !this.cm.isSortable(index)){
- return;
- }
- g.stopEditing(true);
- g.store.sort(this.cm.getDataIndex(index));
+
+ /**
+ * @private
+ * Renders all row header groups at all levels based on the structure fetched from {@link #getGroupRowHeaders}
+ */
+ renderGroupRowHeaders: function() {
+ var leftAxis = this.grid.leftAxis;
+
+ this.resizeRowHeaders();
+ leftAxis.rendered = false;
+ leftAxis.render(this.rowHeadersEl);
+
+ this.setTitle(this.title);
},
-
- // private
- onRowOver : function(e, t){
- var row;
- if((row = this.findRowIndex(t)) !== false){
- this.addRowClass(row, 'x-grid3-row-over');
- }
+
+ /**
+ * Sets the title text in the top left segment of the PivotGridView
+ * @param {String} title The title
+ */
+ setTitle: function(title) {
+ this.headerTitleEl.child('span').dom.innerHTML = title;
},
-
- // private
- onRowOut : function(e, t){
- var row;
- if((row = this.findRowIndex(t)) !== false && !e.within(this.getRow(row), true)){
- this.removeRowClass(row, 'x-grid3-row-over');
- }
+
+ /**
+ * @private
+ * Renders all column header groups at all levels based on the structure fetched from {@link #getColumnHeaders}
+ */
+ renderGroupColumnHeaders: function() {
+ var topAxis = this.grid.topAxis;
+
+ topAxis.rendered = false;
+ topAxis.render(this.innerHd.firstChild);
},
+
+ /**
+ * @private
+ * Overridden to test whether the user is hovering over a group cell, in which case we don't show the menu
+ */
+ isMenuDisabled: function(cellIndex, el) {
+ return true;
+ }
+});/**
+ * @class Ext.grid.PivotAxis
+ * @extends Ext.Component
+ * <p>PivotAxis is a class that supports a {@link Ext.grid.PivotGrid}. Each PivotGrid contains two PivotAxis instances - the left
+ * axis and the top axis. Each PivotAxis defines an ordered set of dimensions, each of which should correspond to a field in a
+ * Store's Record (see {@link Ext.grid.PivotGrid} documentation for further explanation).</p>
+ * <p>Developers should have little interaction with the PivotAxis instances directly as most of their management is performed by
+ * the PivotGrid. An exception is the dynamic reconfiguration of axes at run time - to achieve this we use PivotAxis's
+ * {@link #setDimensions} function and refresh the grid:</p>
+<pre><code>
+var pivotGrid = new Ext.grid.PivotGrid({
+ //some PivotGrid config here
+});
- // private
- handleWheel : function(e){
- e.stopPropagation();
- },
+//change the left axis dimensions
+pivotGrid.leftAxis.setDimensions([
+ {
+ dataIndex: 'person',
+ direction: 'DESC',
+ width : 100
+ },
+ {
+ dataIndex: 'product',
+ direction: 'ASC',
+ width : 80
+ }
+]);
- // private
- onRowSelect : function(row){
- this.addRowClass(row, this.selectedRowClass);
+pivotGrid.view.refresh(true);
+</code></pre>
+ * This clears the previous dimensions on the axis and redraws the grid with the new dimensions.
+ */
+Ext.grid.PivotAxis = Ext.extend(Ext.Component, {
+ /**
+ * @cfg {String} orientation One of 'vertical' or 'horizontal'. Defaults to horizontal
+ */
+ orientation: 'horizontal',
+
+ /**
+ * @cfg {Number} defaultHeaderWidth The width to render each row header that does not have a width specified via
+ {@link #getRowGroupHeaders}. Defaults to 80.
+ */
+ defaultHeaderWidth: 80,
+
+ /**
+ * @private
+ * @cfg {Number} paddingWidth The amount of padding used by each cell.
+ * TODO: From 4.x onwards this can be removed as it won't be needed. For now it is used to account for the differences between
+ * the content box and border box measurement models
+ */
+ paddingWidth: 7,
+
+ /**
+ * Updates the dimensions used by this axis
+ * @param {Array} dimensions The new dimensions
+ */
+ setDimensions: function(dimensions) {
+ this.dimensions = dimensions;
},
-
- // private
- onRowDeselect : function(row){
- this.removeRowClass(row, this.selectedRowClass);
+
+ /**
+ * @private
+ * Builds the html table that contains the dimensions for this axis. This branches internally between vertical
+ * and horizontal orientations because the table structure is slightly different in each case
+ */
+ onRender: function(ct, position) {
+ var rows = this.orientation == 'horizontal'
+ ? this.renderHorizontalRows()
+ : this.renderVerticalRows();
+
+ this.el = Ext.DomHelper.overwrite(ct.dom, {tag: 'table', cn: rows}, true);
},
+
+ /**
+ * @private
+ * Specialised renderer for horizontal oriented axes
+ * @return {Object} The HTML Domspec for a horizontal oriented axis
+ */
+ renderHorizontalRows: function() {
+ var headers = this.buildHeaders(),
+ rowCount = headers.length,
+ rows = [],
+ cells, cols, colCount, i, j;
+
+ for (i = 0; i < rowCount; i++) {
+ cells = [];
+ cols = headers[i].items;
+ colCount = cols.length;
+
+ for (j = 0; j < colCount; j++) {
+ cells.push({
+ tag: 'td',
+ html: cols[j].header,
+ colspan: cols[j].span
+ });
+ }
- // private
- onCellSelect : function(row, col){
- var cell = this.getCell(row, col);
- if(cell){
- this.fly(cell).addClass('x-grid3-cell-selected');
+ rows[i] = {
+ tag: 'tr',
+ cn: cells
+ };
}
+
+ return rows;
},
-
- // private
- onCellDeselect : function(row, col){
- var cell = this.getCell(row, col);
- if(cell){
- this.fly(cell).removeClass('x-grid3-cell-selected');
+
+ /**
+ * @private
+ * Specialised renderer for vertical oriented axes
+ * @return {Object} The HTML Domspec for a vertical oriented axis
+ */
+ renderVerticalRows: function() {
+ var headers = this.buildHeaders(),
+ colCount = headers.length,
+ rowCells = [],
+ rows = [],
+ rowCount, col, row, colWidth, i, j;
+
+ for (i = 0; i < colCount; i++) {
+ col = headers[i];
+ colWidth = col.width || 80;
+ rowCount = col.items.length;
+
+ for (j = 0; j < rowCount; j++) {
+ row = col.items[j];
+
+ rowCells[row.start] = rowCells[row.start] || [];
+ rowCells[row.start].push({
+ tag : 'td',
+ html : row.header,
+ rowspan: row.span,
+ width : Ext.isBorderBox ? colWidth : colWidth - this.paddingWidth
+ });
+ }
+ }
+
+ rowCount = rowCells.length;
+ for (i = 0; i < rowCount; i++) {
+ rows[i] = {
+ tag: 'tr',
+ cn : rowCells[i]
+ };
}
+
+ return rows;
},
-
- // private
- onColumnSplitterMoved : function(i, w){
- this.userResized = true;
- var cm = this.grid.colModel;
- cm.setColumnWidth(i, w, true);
-
- if(this.forceFit){
- this.fitColumns(true, false, i);
- this.updateAllColumnWidths();
- }else{
- this.updateColumnWidth(i, w);
- this.syncHeaderScroll();
+
+ /**
+ * @private
+ * Returns the set of all unique tuples based on the bound store and dimension definitions.
+ * Internally we construct a new, temporary store to make use of the multi-sort capabilities of Store. In
+ * 4.x this functionality should have been moved to MixedCollection so this step should not be needed.
+ * @return {Array} All unique tuples
+ */
+ getTuples: function() {
+ var newStore = new Ext.data.Store({});
+
+ newStore.data = this.store.data.clone();
+ newStore.fields = this.store.fields;
+
+ var sorters = [],
+ dimensions = this.dimensions,
+ length = dimensions.length,
+ i;
+
+ for (i = 0; i < length; i++) {
+ sorters.push({
+ field : dimensions[i].dataIndex,
+ direction: dimensions[i].direction || 'ASC'
+ });
}
-
- this.grid.fireEvent('columnresize', i, w);
+
+ newStore.sort(sorters);
+
+ var records = newStore.data.items,
+ hashes = [],
+ tuples = [],
+ recData, hash, info, data, key;
+
+ length = records.length;
+
+ for (i = 0; i < length; i++) {
+ info = this.getRecordInfo(records[i]);
+ data = info.data;
+ hash = "";
+
+ for (key in data) {
+ hash += data[key] + '---';
+ }
+
+ if (hashes.indexOf(hash) == -1) {
+ hashes.push(hash);
+ tuples.push(info);
+ }
+ }
+
+ newStore.destroy();
+
+ return tuples;
},
-
- // private
- handleHdMenuClick : function(item){
- var index = this.hdCtxIndex,
- cm = this.cm,
- ds = this.ds,
- id = item.getItemId();
- switch(id){
- case 'asc':
- ds.sort(cm.getDataIndex(index), 'ASC');
- break;
- case 'desc':
- ds.sort(cm.getDataIndex(index), 'DESC');
- break;
- default:
- index = cm.getIndexById(id.substr(4));
- if(index != -1){
- if(item.checked && cm.getColumnsBy(this.isHideableColumn, this).length <= 1){
- this.onDenyColumnHide();
+
+ /**
+ * @private
+ */
+ getRecordInfo: function(record) {
+ var dimensions = this.dimensions,
+ length = dimensions.length,
+ data = {},
+ dimension, dataIndex, i;
+
+ //get an object containing just the data we are interested in based on the configured dimensions
+ for (i = 0; i < length; i++) {
+ dimension = dimensions[i];
+ dataIndex = dimension.dataIndex;
+
+ data[dataIndex] = record.get(dataIndex);
+ }
+
+ //creates a specialised matcher function for a given tuple. The returned function will return
+ //true if the record passed to it matches the dataIndex values of each dimension in this axis
+ var createMatcherFunction = function(data) {
+ return function(record) {
+ for (var dataIndex in data) {
+ if (record.get(dataIndex) != data[dataIndex]) {
return false;
}
- cm.setHidden(index, item.checked);
}
+
+ return true;
+ };
+ };
+
+ return {
+ data: data,
+ matcher: createMatcherFunction(data)
+ };
+ },
+
+ /**
+ * @private
+ * Uses the calculated set of tuples to build an array of headers that can be rendered into a table using rowspan or
+ * colspan. Basically this takes the set of tuples and spans any cells that run into one another, so if we had dimensions
+ * of Person and Product and several tuples containing different Products for the same Person, those Products would be
+ * spanned.
+ * @return {Array} The headers
+ */
+ buildHeaders: function() {
+ var tuples = this.getTuples(),
+ rowCount = tuples.length,
+ dimensions = this.dimensions,
+ colCount = dimensions.length,
+ headers = [],
+ tuple, rows, currentHeader, previousHeader, span, start, isLast, changed, i, j;
+
+ for (i = 0; i < colCount; i++) {
+ dimension = dimensions[i];
+ rows = [];
+ span = 0;
+ start = 0;
+
+ for (j = 0; j < rowCount; j++) {
+ tuple = tuples[j];
+ isLast = j == (rowCount - 1);
+ currentHeader = tuple.data[dimension.dataIndex];
+
+ /*
+ * 'changed' indicates that we need to create a new cell. This should be true whenever the cell
+ * above (previousHeader) is different from this cell, or when the cell on the previous dimension
+ * changed (e.g. if the current dimension is Product and the previous was Person, we need to start
+ * a new cell if Product is the same but Person changed, so we check the previous dimension and tuple)
+ */
+ changed = previousHeader != undefined && previousHeader != currentHeader;
+ if (i > 0 && j > 0) {
+ changed = changed || tuple.data[dimensions[i-1].dataIndex] != tuples[j-1].data[dimensions[i-1].dataIndex];
+ }
+
+ if (changed) {
+ rows.push({
+ header: previousHeader,
+ span : span,
+ start : start
+ });
+
+ start += span;
+ span = 0;
+ }
+
+ if (isLast) {
+ rows.push({
+ header: currentHeader,
+ span : span + 1,
+ start : start
+ });
+
+ start += span;
+ span = 0;
+ }
+
+ previousHeader = currentHeader;
+ span++;
+ }
+
+ headers.push({
+ items: rows,
+ width: dimension.width || this.defaultHeaderWidth
+ });
+
+ previousHeader = undefined;
+ }
+
+ return headers;
+ }
+});
+// private
+// This is a support class used internally by the Grid components
+Ext.grid.HeaderDragZone = Ext.extend(Ext.dd.DragZone, {
+ maxDragWidth: 120,
+
+ constructor : function(grid, hd, hd2){
+ this.grid = grid;
+ this.view = grid.getView();
+ this.ddGroup = "gridHeader" + this.grid.getGridEl().id;
+ Ext.grid.HeaderDragZone.superclass.constructor.call(this, hd);
+ if(hd2){
+ this.setHandleElId(Ext.id(hd));
+ this.setOuterHandleElId(Ext.id(hd2));
+ }
+ this.scroll = false;
+ },
+
+ getDragData : function(e){
+ var t = Ext.lib.Event.getTarget(e),
+ h = this.view.findHeaderCell(t);
+ if(h){
+ return {ddel: h.firstChild, header:h};
}
- return true;
+ return false;
},
- // private
- isHideableColumn : function(c){
- return !c.hidden && !c.fixed;
+ onInitDrag : function(e){
+ // keep the value here so we can restore it;
+ this.dragHeadersDisabled = this.view.headersDisabled;
+ this.view.headersDisabled = true;
+ var clone = this.dragData.ddel.cloneNode(true);
+ clone.id = Ext.id();
+ clone.style.width = Math.min(this.dragData.header.offsetWidth,this.maxDragWidth) + "px";
+ this.proxy.update(clone);
+ return true;
},
- // private
- beforeColMenuShow : function(){
- var cm = this.cm, colCount = cm.getColumnCount();
- this.colMenu.removeAll();
- for(var i = 0; i < colCount; i++){
- if(cm.config[i].fixed !== true && cm.config[i].hideable !== false){
- this.colMenu.add(new Ext.menu.CheckItem({
- itemId: 'col-'+cm.getColumnId(i),
- text: cm.getColumnHeader(i),
- checked: !cm.isHidden(i),
- hideOnClick:false,
- disabled: cm.config[i].hideable === false
- }));
- }
- }
+ afterValidDrop : function(){
+ this.completeDrop();
},
- // private
- handleHdDown : function(e, t){
- if(Ext.fly(t).hasClass('x-grid3-hd-btn')){
- e.stopEvent();
- var hd = this.findHeaderCell(t);
- Ext.fly(hd).addClass('x-grid3-hd-menu-open');
- var index = this.getCellIndex(hd);
- this.hdCtxIndex = index;
- var ms = this.hmenu.items, cm = this.cm;
- ms.get('asc').setDisabled(!cm.isSortable(index));
- ms.get('desc').setDisabled(!cm.isSortable(index));
- this.hmenu.on('hide', function(){
- Ext.fly(hd).removeClass('x-grid3-hd-menu-open');
- }, this, {single:true});
- this.hmenu.show(t, 'tl-bl?');
- }
+ afterInvalidDrop : function(){
+ this.completeDrop();
},
+
+ completeDrop: function(){
+ var v = this.view,
+ disabled = this.dragHeadersDisabled;
+ setTimeout(function(){
+ v.headersDisabled = disabled;
+ }, 50);
+ }
+});
- // private
- handleHdOver : function(e, t){
- var hd = this.findHeaderCell(t);
- if(hd && !this.headersDisabled){
- this.activeHdRef = t;
- this.activeHdIndex = this.getCellIndex(hd);
- var fly = this.fly(hd);
- this.activeHdRegion = fly.getRegion();
- if(!this.cm.isMenuDisabled(this.activeHdIndex)){
- fly.addClass('x-grid3-hd-over');
- this.activeHdBtn = fly.child('.x-grid3-hd-btn');
- if(this.activeHdBtn){
- this.activeHdBtn.dom.style.height = (hd.firstChild.offsetHeight-1)+'px';
- }
+// private
+// This is a support class used internally by the Grid components
+Ext.grid.HeaderDropZone = Ext.extend(Ext.dd.DropZone, {
+ proxyOffsets : [-4, -9],
+ fly: Ext.Element.fly,
+
+ constructor : function(grid, hd, hd2){
+ this.grid = grid;
+ this.view = grid.getView();
+ // split the proxies so they don't interfere with mouse events
+ this.proxyTop = Ext.DomHelper.append(document.body, {
+ cls:"col-move-top", html:" "
+ }, true);
+ this.proxyBottom = Ext.DomHelper.append(document.body, {
+ cls:"col-move-bottom", html:" "
+ }, true);
+ this.proxyTop.hide = this.proxyBottom.hide = function(){
+ this.setLeftTop(-100,-100);
+ this.setStyle("visibility", "hidden");
+ };
+ this.ddGroup = "gridHeader" + this.grid.getGridEl().id;
+ // temporarily disabled
+ //Ext.dd.ScrollManager.register(this.view.scroller.dom);
+ Ext.grid.HeaderDropZone.superclass.constructor.call(this, grid.getGridEl().dom);
+ },
+
+ getTargetFromEvent : function(e){
+ var t = Ext.lib.Event.getTarget(e),
+ cindex = this.view.findCellIndex(t);
+ if(cindex !== false){
+ return this.view.getHeaderCell(cindex);
+ }
+ },
+
+ nextVisible : function(h){
+ var v = this.view, cm = this.grid.colModel;
+ h = h.nextSibling;
+ while(h){
+ if(!cm.isHidden(v.getCellIndex(h))){
+ return h;
}
+ h = h.nextSibling;
}
+ return null;
},
- // private
- handleHdMove : function(e, t){
- var hd = this.findHeaderCell(this.activeHdRef);
- if(hd && !this.headersDisabled){
- var hw = this.splitHandleWidth || 5,
- r = this.activeHdRegion,
- x = e.getPageX(),
- ss = hd.style,
- cur = '';
- if(this.grid.enableColumnResize !== false){
- if(x - r.left <= hw && this.cm.isResizable(this.activeHdIndex-1)){
- cur = Ext.isAir ? 'move' : Ext.isWebKit ? 'e-resize' : 'col-resize'; // col-resize not always supported
- }else if(r.right - x <= (!this.activeHdBtn ? hw : 2) && this.cm.isResizable(this.activeHdIndex)){
- cur = Ext.isAir ? 'move' : Ext.isWebKit ? 'w-resize' : 'col-resize';
- }
+ prevVisible : function(h){
+ var v = this.view, cm = this.grid.colModel;
+ h = h.prevSibling;
+ while(h){
+ if(!cm.isHidden(v.getCellIndex(h))){
+ return h;
}
- ss.cursor = cur;
+ h = h.prevSibling;
}
+ return null;
},
- // private
- handleHdOut : function(e, t){
- var hd = this.findHeaderCell(t);
- if(hd && (!Ext.isIE || !e.within(hd, true))){
- this.activeHdRef = null;
- this.fly(hd).removeClass('x-grid3-hd-over');
- hd.style.cursor = '';
+ positionIndicator : function(h, n, e){
+ var x = Ext.lib.Event.getPageX(e),
+ r = Ext.lib.Dom.getRegion(n.firstChild),
+ px,
+ pt,
+ py = r.top + this.proxyOffsets[1];
+ if((r.right - x) <= (r.right-r.left)/2){
+ px = r.right+this.view.borderWidth;
+ pt = "after";
+ }else{
+ px = r.left;
+ pt = "before";
}
- },
-
- // private
- hasRows : function(){
- var fc = this.mainBody.dom.firstChild;
- return fc && fc.nodeType == 1 && fc.className != 'x-grid-empty';
- },
- // back compat
- bind : function(d, c){
- this.initData(d, c);
- }
-});
+ if(this.grid.colModel.isFixed(this.view.getCellIndex(n))){
+ return false;
+ }
+ px += this.proxyOffsets[0];
+ this.proxyTop.setLeftTop(px, py);
+ this.proxyTop.show();
+ if(!this.bottomOffset){
+ this.bottomOffset = this.view.mainHd.getHeight();
+ }
+ this.proxyBottom.setLeftTop(px, py+this.proxyTop.dom.offsetHeight+this.bottomOffset);
+ this.proxyBottom.show();
+ return pt;
+ },
-// private
-// This is a support class used internally by the Grid components
-Ext.grid.GridView.SplitDragZone = function(grid, hd){
- this.grid = grid;
- this.view = grid.getView();
- this.marker = this.view.resizeMarker;
- this.proxy = this.view.resizeProxy;
- Ext.grid.GridView.SplitDragZone.superclass.constructor.call(this, hd,
- 'gridSplitters' + this.grid.getGridEl().id, {
- dragElId : Ext.id(this.proxy.dom), resizeFrame:false
- });
- this.scroll = false;
- this.hw = this.view.splitHandleWidth || 5;
-};
-Ext.extend(Ext.grid.GridView.SplitDragZone, Ext.dd.DDProxy, {
+ onNodeEnter : function(n, dd, e, data){
+ if(data.header != n){
+ this.positionIndicator(data.header, n, e);
+ }
+ },
- b4StartDrag : function(x, y){
- this.view.headersDisabled = true;
- var h = this.view.mainWrap.getHeight();
- this.marker.setHeight(h);
- this.marker.show();
- this.marker.alignTo(this.view.getHeaderCell(this.cellIndex), 'tl-tl', [-2, 0]);
- this.proxy.setHeight(h);
- var w = this.cm.getColumnWidth(this.cellIndex);
- var minw = Math.max(w-this.grid.minColumnWidth, 0);
- this.resetConstraints();
- this.setXConstraint(minw, 1000);
- this.setYConstraint(0, 0);
- this.minX = x - minw;
- this.maxX = x + 1000;
- this.startPos = x;
- Ext.dd.DDProxy.prototype.b4StartDrag.call(this, x, y);
+ onNodeOver : function(n, dd, e, data){
+ var result = false;
+ if(data.header != n){
+ result = this.positionIndicator(data.header, n, e);
+ }
+ if(!result){
+ this.proxyTop.hide();
+ this.proxyBottom.hide();
+ }
+ return result ? this.dropAllowed : this.dropNotAllowed;
},
+ onNodeOut : function(n, dd, e, data){
+ this.proxyTop.hide();
+ this.proxyBottom.hide();
+ },
- handleMouseDown : function(e){
- var t = this.view.findHeaderCell(e.getTarget());
- if(t){
- var xy = this.view.fly(t).getXY(), x = xy[0], y = xy[1];
- var exy = e.getXY(), ex = exy[0];
- var w = t.offsetWidth, adjust = false;
- if((ex - x) <= this.hw){
- adjust = -1;
- }else if((x+w) - ex <= this.hw){
- adjust = 0;
+ onNodeDrop : function(n, dd, e, data){
+ var h = data.header;
+ if(h != n){
+ var cm = this.grid.colModel,
+ x = Ext.lib.Event.getPageX(e),
+ r = Ext.lib.Dom.getRegion(n.firstChild),
+ pt = (r.right - x) <= ((r.right-r.left)/2) ? "after" : "before",
+ oldIndex = this.view.getCellIndex(h),
+ newIndex = this.view.getCellIndex(n);
+ if(pt == "after"){
+ newIndex++;
}
- if(adjust !== false){
- this.cm = this.grid.colModel;
- var ci = this.view.getCellIndex(t);
- if(adjust == -1){
- if (ci + adjust < 0) {
- return;
- }
- while(this.cm.isHidden(ci+adjust)){
- --adjust;
- if(ci+adjust < 0){
- return;
- }
- }
- }
- this.cellIndex = ci+adjust;
- this.split = t.dom;
- if(this.cm.isResizable(this.cellIndex) && !this.cm.isFixed(this.cellIndex)){
- Ext.grid.GridView.SplitDragZone.superclass.handleMouseDown.apply(this, arguments);
- }
- }else if(this.view.columnDrag){
- this.view.columnDrag.callHandleMouseDown(e);
+ if(oldIndex < newIndex){
+ newIndex--;
}
+ cm.moveColumn(oldIndex, newIndex);
+ return true;
}
- },
+ return false;
+ }
+});
- endDrag : function(e){
- this.marker.hide();
- var v = this.view;
- var endX = Math.max(this.minX, e.getPageX());
- var diff = endX - this.startPos;
- v.onColumnSplitterMoved(this.cellIndex, this.cm.getColumnWidth(this.cellIndex)+diff);
- setTimeout(function(){
- v.headersDisabled = false;
- }, 50);
+Ext.grid.GridView.ColumnDragZone = Ext.extend(Ext.grid.HeaderDragZone, {
+
+ constructor : function(grid, hd){
+ Ext.grid.GridView.ColumnDragZone.superclass.constructor.call(this, grid, hd, null);
+ this.proxy.el.addClass('x-grid3-col-dd');
+ },
+
+ handleMouseDown : function(e){
},
- autoOffset : function(){
- this.setDelta(0,0);
+ callHandleMouseDown : function(e){
+ Ext.grid.GridView.ColumnDragZone.superclass.handleMouseDown.call(this, e);
}
-});
-// private\r
-// This is a support class used internally by the Grid components\r
-Ext.grid.HeaderDragZone = function(grid, hd, hd2){\r
- this.grid = grid;\r
- this.view = grid.getView();\r
- this.ddGroup = "gridHeader" + this.grid.getGridEl().id;\r
- Ext.grid.HeaderDragZone.superclass.constructor.call(this, hd);\r
- if(hd2){\r
- this.setHandleElId(Ext.id(hd));\r
- this.setOuterHandleElId(Ext.id(hd2));\r
- }\r
- this.scroll = false;\r
-};\r
-Ext.extend(Ext.grid.HeaderDragZone, Ext.dd.DragZone, {\r
- maxDragWidth: 120,\r
- getDragData : function(e){\r
- var t = Ext.lib.Event.getTarget(e);\r
- var h = this.view.findHeaderCell(t);\r
- if(h){\r
- return {ddel: h.firstChild, header:h};\r
- }\r
- return false;\r
- },\r
-\r
- onInitDrag : function(e){\r
- this.view.headersDisabled = true;\r
- var clone = this.dragData.ddel.cloneNode(true);\r
- clone.id = Ext.id();\r
- clone.style.width = Math.min(this.dragData.header.offsetWidth,this.maxDragWidth) + "px";\r
- this.proxy.update(clone);\r
- return true;\r
- },\r
-\r
- afterValidDrop : function(){\r
- var v = this.view;\r
- setTimeout(function(){\r
- v.headersDisabled = false;\r
- }, 50);\r
- },\r
-\r
- afterInvalidDrop : function(){\r
- var v = this.view;\r
- setTimeout(function(){\r
- v.headersDisabled = false;\r
- }, 50);\r
- }\r
-});\r
-\r
-// private\r
-// This is a support class used internally by the Grid components\r
-Ext.grid.HeaderDropZone = function(grid, hd, hd2){\r
- this.grid = grid;\r
- this.view = grid.getView();\r
- // split the proxies so they don't interfere with mouse events\r
- this.proxyTop = Ext.DomHelper.append(document.body, {\r
- cls:"col-move-top", html:" "\r
- }, true);\r
- this.proxyBottom = Ext.DomHelper.append(document.body, {\r
- cls:"col-move-bottom", html:" "\r
- }, true);\r
- this.proxyTop.hide = this.proxyBottom.hide = function(){\r
- this.setLeftTop(-100,-100);\r
- this.setStyle("visibility", "hidden");\r
- };\r
- this.ddGroup = "gridHeader" + this.grid.getGridEl().id;\r
- // temporarily disabled\r
- //Ext.dd.ScrollManager.register(this.view.scroller.dom);\r
- Ext.grid.HeaderDropZone.superclass.constructor.call(this, grid.getGridEl().dom);\r
-};\r
-Ext.extend(Ext.grid.HeaderDropZone, Ext.dd.DropZone, {\r
- proxyOffsets : [-4, -9],\r
- fly: Ext.Element.fly,\r
-\r
- getTargetFromEvent : function(e){\r
- var t = Ext.lib.Event.getTarget(e);\r
- var cindex = this.view.findCellIndex(t);\r
- if(cindex !== false){\r
- return this.view.getHeaderCell(cindex);\r
- }\r
- },\r
-\r
- nextVisible : function(h){\r
- var v = this.view, cm = this.grid.colModel;\r
- h = h.nextSibling;\r
- while(h){\r
- if(!cm.isHidden(v.getCellIndex(h))){\r
- return h;\r
- }\r
- h = h.nextSibling;\r
- }\r
- return null;\r
- },\r
-\r
- prevVisible : function(h){\r
- var v = this.view, cm = this.grid.colModel;\r
- h = h.prevSibling;\r
- while(h){\r
- if(!cm.isHidden(v.getCellIndex(h))){\r
- return h;\r
- }\r
- h = h.prevSibling;\r
- }\r
- return null;\r
- },\r
-\r
- positionIndicator : function(h, n, e){\r
- var x = Ext.lib.Event.getPageX(e);\r
- var r = Ext.lib.Dom.getRegion(n.firstChild);\r
- var px, pt, py = r.top + this.proxyOffsets[1];\r
- if((r.right - x) <= (r.right-r.left)/2){\r
- px = r.right+this.view.borderWidth;\r
- pt = "after";\r
- }else{\r
- px = r.left;\r
- pt = "before";\r
- }\r
-\r
- if(this.grid.colModel.isFixed(this.view.getCellIndex(n))){\r
- return false;\r
- }\r
-\r
- px += this.proxyOffsets[0];\r
- this.proxyTop.setLeftTop(px, py);\r
- this.proxyTop.show();\r
- if(!this.bottomOffset){\r
- this.bottomOffset = this.view.mainHd.getHeight();\r
- }\r
- this.proxyBottom.setLeftTop(px, py+this.proxyTop.dom.offsetHeight+this.bottomOffset);\r
- this.proxyBottom.show();\r
- return pt;\r
- },\r
-\r
- onNodeEnter : function(n, dd, e, data){\r
- if(data.header != n){\r
- this.positionIndicator(data.header, n, e);\r
- }\r
- },\r
-\r
- onNodeOver : function(n, dd, e, data){\r
- var result = false;\r
- if(data.header != n){\r
- result = this.positionIndicator(data.header, n, e);\r
- }\r
- if(!result){\r
- this.proxyTop.hide();\r
- this.proxyBottom.hide();\r
- }\r
- return result ? this.dropAllowed : this.dropNotAllowed;\r
- },\r
-\r
- onNodeOut : function(n, dd, e, data){\r
- this.proxyTop.hide();\r
- this.proxyBottom.hide();\r
- },\r
-\r
- onNodeDrop : function(n, dd, e, data){\r
- var h = data.header;\r
- if(h != n){\r
- var cm = this.grid.colModel;\r
- var x = Ext.lib.Event.getPageX(e);\r
- var r = Ext.lib.Dom.getRegion(n.firstChild);\r
- var pt = (r.right - x) <= ((r.right-r.left)/2) ? "after" : "before";\r
- var oldIndex = this.view.getCellIndex(h);\r
- var newIndex = this.view.getCellIndex(n);\r
- if(pt == "after"){\r
- newIndex++;\r
- }\r
- if(oldIndex < newIndex){\r
- newIndex--;\r
- }\r
- cm.moveColumn(oldIndex, newIndex);\r
- return true;\r
- }\r
- return false;\r
- }\r
-});\r
-\r
-\r
-Ext.grid.GridView.ColumnDragZone = function(grid, hd){\r
- Ext.grid.GridView.ColumnDragZone.superclass.constructor.call(this, grid, hd, null);\r
- this.proxy.el.addClass('x-grid3-col-dd');\r
-};\r
-\r
-Ext.extend(Ext.grid.GridView.ColumnDragZone, Ext.grid.HeaderDragZone, {\r
- handleMouseDown : function(e){\r
-\r
- },\r
-\r
- callHandleMouseDown : function(e){\r
- Ext.grid.GridView.ColumnDragZone.superclass.handleMouseDown.call(this, e);\r
- }\r
});// private
// This is a support class used internally by the Grid components
-Ext.grid.SplitDragZone = function(grid, hd, hd2){
- this.grid = grid;
- this.view = grid.getView();
- this.proxy = this.view.resizeProxy;
- Ext.grid.SplitDragZone.superclass.constructor.call(this, hd,
- "gridSplitters" + this.grid.getGridEl().id, {
- dragElId : Ext.id(this.proxy.dom), resizeFrame:false
- });
- this.setHandleElId(Ext.id(hd));
- this.setOuterHandleElId(Ext.id(hd2));
- this.scroll = false;
-};
-Ext.extend(Ext.grid.SplitDragZone, Ext.dd.DDProxy, {
+Ext.grid.SplitDragZone = Ext.extend(Ext.dd.DDProxy, {
fly: Ext.Element.fly,
+
+ constructor : function(grid, hd, hd2){
+ this.grid = grid;
+ this.view = grid.getView();
+ this.proxy = this.view.resizeProxy;
+ Ext.grid.SplitDragZone.superclass.constructor.call(this, hd,
+ "gridSplitters" + this.grid.getGridEl().id, {
+ dragElId : Ext.id(this.proxy.dom), resizeFrame:false
+ });
+ this.setHandleElId(Ext.id(hd));
+ this.setOuterHandleElId(Ext.id(hd2));
+ this.scroll = false;
+ },
b4StartDrag : function(x, y){
this.view.headersDisabled = true;
* @param {Mixed} config Specify either an Array of {@link Ext.grid.Column} configuration objects or specify
* a configuration Object (see introductory section discussion utilizing Initialization Method 2 above).
*/
-Ext.grid.ColumnModel = function(config){
- /**
- * An Array of {@link Ext.grid.Column Column definition} objects representing the configuration
- * of this ColumnModel. See {@link Ext.grid.Column} for the configuration properties that may
- * be specified.
- * @property config
- * @type Array
- */
- if(config.columns){
- Ext.apply(this, config);
- this.setConfig(config.columns, true);
- }else{
- this.setConfig(config, true);
- }
- this.addEvents(
- /**
- * @event widthchange
- * Fires when the width of a column is programmaticially changed using
- * <code>{@link #setColumnWidth}</code>.
- * Note internal resizing suppresses the event from firing. See also
- * {@link Ext.grid.GridPanel}.<code>{@link #columnresize}</code>.
- * @param {ColumnModel} this
- * @param {Number} columnIndex The column index
- * @param {Number} newWidth The new width
- */
- "widthchange",
- /**
- * @event headerchange
- * Fires when the text of a header changes.
- * @param {ColumnModel} this
- * @param {Number} columnIndex The column index
- * @param {String} newText The new header text
- */
- "headerchange",
- /**
- * @event hiddenchange
- * Fires when a column is hidden or "unhidden".
- * @param {ColumnModel} this
- * @param {Number} columnIndex The column index
- * @param {Boolean} hidden true if hidden, false otherwise
- */
- "hiddenchange",
- /**
- * @event columnmoved
- * Fires when a column is moved.
- * @param {ColumnModel} this
- * @param {Number} oldIndex
- * @param {Number} newIndex
- */
- "columnmoved",
- /**
- * @event configchange
- * Fires when the configuration is changed
- * @param {ColumnModel} this
- */
- "configchange"
- );
- Ext.grid.ColumnModel.superclass.constructor.call(this);
-};
-Ext.extend(Ext.grid.ColumnModel, Ext.util.Observable, {
+Ext.grid.ColumnModel = Ext.extend(Ext.util.Observable, {
/**
* @cfg {Number} defaultWidth (optional) The width of columns which have no <tt>{@link #width}</tt>
* specified (defaults to <tt>100</tt>). This property shall preferably be configured through the
* <tt><b>{@link #defaults}</b></tt> config property.
*/
defaultWidth: 100,
+
/**
* @cfg {Boolean} defaultSortable (optional) Default sortable of columns which have no
* sortable specified (defaults to <tt>false</tt>). This property shall preferably be configured
* through the <tt><b>{@link #defaults}</b></tt> config property.
*/
defaultSortable: false,
+
/**
* @cfg {Array} columns An Array of object literals. The config options defined by
* <b>{@link Ext.grid.Column}</b> are the options which may appear in the object literal for each
* individual column definition.
*/
+
/**
* @cfg {Object} defaults Object literal which will be used to apply {@link Ext.grid.Column}
* configuration options to all <tt><b>{@link #columns}</b></tt>. Configuration options specified with
* individual {@link Ext.grid.Column column} configs will supersede these <tt><b>{@link #defaults}</b></tt>.
*/
+ constructor : function(config) {
+ /**
+ * An Array of {@link Ext.grid.Column Column definition} objects representing the configuration
+ * of this ColumnModel. See {@link Ext.grid.Column} for the configuration properties that may
+ * be specified.
+ * @property config
+ * @type Array
+ */
+ if (config.columns) {
+ Ext.apply(this, config);
+ this.setConfig(config.columns, true);
+ } else {
+ this.setConfig(config, true);
+ }
+
+ this.addEvents(
+ /**
+ * @event widthchange
+ * Fires when the width of a column is programmaticially changed using
+ * <code>{@link #setColumnWidth}</code>.
+ * Note internal resizing suppresses the event from firing. See also
+ * {@link Ext.grid.GridPanel}.<code>{@link #columnresize}</code>.
+ * @param {ColumnModel} this
+ * @param {Number} columnIndex The column index
+ * @param {Number} newWidth The new width
+ */
+ "widthchange",
+
+ /**
+ * @event headerchange
+ * Fires when the text of a header changes.
+ * @param {ColumnModel} this
+ * @param {Number} columnIndex The column index
+ * @param {String} newText The new header text
+ */
+ "headerchange",
+
+ /**
+ * @event hiddenchange
+ * Fires when a column is hidden or "unhidden".
+ * @param {ColumnModel} this
+ * @param {Number} columnIndex The column index
+ * @param {Boolean} hidden true if hidden, false otherwise
+ */
+ "hiddenchange",
+
+ /**
+ * @event columnmoved
+ * Fires when a column is moved.
+ * @param {ColumnModel} this
+ * @param {Number} oldIndex
+ * @param {Number} newIndex
+ */
+ "columnmoved",
+
+ /**
+ * @event configchange
+ * Fires when the configuration is changed
+ * @param {ColumnModel} this
+ */
+ "configchange"
+ );
+
+ Ext.grid.ColumnModel.superclass.constructor.call(this);
+ },
+
/**
* Returns the id of the column at the specified index.
* @param {Number} index The column index
* @return {String} the id
*/
- getColumnId : function(index){
+ getColumnId : function(index) {
return this.config[index].id;
},
- getColumnAt : function(index){
+ getColumnAt : function(index) {
return this.config[index];
},
* @param {Boolean} initial Specify <tt>true</tt> to bypass cleanup which deletes the <tt>totalWidth</tt>
* and destroys existing editors.
*/
- setConfig : function(config, initial){
+ setConfig : function(config, initial) {
var i, c, len;
- if(!initial){ // cleanup
+
+ if (!initial) { // cleanup
delete this.totalWidth;
- for(i = 0, len = this.config.length; i < len; i++){
+
+ for (i = 0, len = this.config.length; i < len; i++) {
c = this.config[i];
- if(c.editor){
- c.editor.destroy();
+
+ if (c.setEditor) {
+ //check here, in case we have a special column like a CheckboxSelectionModel
+ c.setEditor(null);
}
}
}
this.config = config;
this.lookup = {};
- for(i = 0, len = config.length; i < len; i++){
+ for (i = 0, len = config.length; i < len; i++) {
c = Ext.applyIf(config[i], this.defaults);
+
// if no id, create one using column's ordinal position
- if(typeof c.id == 'undefined'){
+ if (Ext.isEmpty(c.id)) {
c.id = i;
}
- if(!c.isColumn){
+
+ if (!c.isColumn) {
var Cls = Ext.grid.Column.types[c.xtype || 'gridcolumn'];
c = new Cls(c);
config[i] = c;
}
+
this.lookup[c.id] = c;
}
- if(!initial){
+
+ if (!initial) {
this.fireEvent('configchange', this);
}
},
* @param {String} id The column id
* @return {Object} the column
*/
- getColumnById : function(id){
+ getColumnById : function(id) {
return this.lookup[id];
},
* @param {String} id The column id
* @return {Number} the index, or -1 if not found
*/
- getIndexById : function(id){
- for(var i = 0, len = this.config.length; i < len; i++){
- if(this.config[i].id == id){
+ getIndexById : function(id) {
+ for (var i = 0, len = this.config.length; i < len; i++) {
+ if (this.config[i].id == id) {
return i;
}
}
* @param {Number} oldIndex The index of the column to move.
* @param {Number} newIndex The position at which to reinsert the coolumn.
*/
- moveColumn : function(oldIndex, newIndex){
- var c = this.config[oldIndex];
- this.config.splice(oldIndex, 1);
- this.config.splice(newIndex, 0, c);
+ moveColumn : function(oldIndex, newIndex) {
+ var config = this.config,
+ c = config[oldIndex];
+
+ config.splice(oldIndex, 1);
+ config.splice(newIndex, 0, c);
this.dataMap = null;
this.fireEvent("columnmoved", this, oldIndex, newIndex);
},
* @param {Boolean} visibleOnly Optional. Pass as true to only include visible columns.
* @return {Number}
*/
- getColumnCount : function(visibleOnly){
- if(visibleOnly === true){
- var c = 0;
- for(var i = 0, len = this.config.length; i < len; i++){
- if(!this.isHidden(i)){
+ getColumnCount : function(visibleOnly) {
+ var length = this.config.length,
+ c = 0,
+ i;
+
+ if (visibleOnly === true) {
+ for (i = 0; i < length; i++) {
+ if (!this.isHidden(i)) {
c++;
}
}
+
return c;
}
- return this.config.length;
+
+ return length;
},
/**
return c.hidden;
});
</code></pre>
- * @param {Function} fn
- * @param {Object} scope (optional)
+ * @param {Function} fn A function which, when passed a {@link Ext.grid.Column Column} object, must
+ * return <code>true</code> if the column is to be included in the returned Array.
+ * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function
+ * is executed. Defaults to this ColumnModel.
* @return {Array} result
*/
- getColumnsBy : function(fn, scope){
- var r = [];
- for(var i = 0, len = this.config.length; i < len; i++){
- var c = this.config[i];
- if(fn.call(scope||this, c, i) === true){
- r[r.length] = c;
+ getColumnsBy : function(fn, scope) {
+ var config = this.config,
+ length = config.length,
+ result = [],
+ i, c;
+
+ for (i = 0; i < length; i++){
+ c = config[i];
+
+ if (fn.call(scope || this, c, i) === true) {
+ result[result.length] = c;
}
}
- return r;
+
+ return result;
},
/**
* @param {Number} col The column index
* @return {Boolean}
*/
- isSortable : function(col){
+ isSortable : function(col) {
return !!this.config[col].sortable;
},
* @param {Number} col The column index
* @return {Boolean}
*/
- isMenuDisabled : function(col){
+ isMenuDisabled : function(col) {
return !!this.config[col].menuDisabled;
},
* @param {Number} col The column index.
* @return {Function} The function used to render the cell. See {@link #setRenderer}.
*/
- getRenderer : function(col){
- if(!this.config[col].renderer){
- return Ext.grid.ColumnModel.defaultRenderer;
- }
- return this.config[col].renderer;
+ getRenderer : function(col) {
+ return this.config[col].renderer || Ext.grid.ColumnModel.defaultRenderer;
+ },
+
+ getRendererScope : function(col) {
+ return this.config[col].scope;
},
/**
* <li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
* <li><b>store</b> : Ext.data.Store<p class="sub-desc">The {@link Ext.data.Store} object from which the Record was extracted.</p></li></ul>
*/
- setRenderer : function(col, fn){
+ setRenderer : function(col, fn) {
this.config[col].renderer = fn;
},
* @param {Number} col The column index
* @return {Number}
*/
- getColumnWidth : function(col){
- return this.config[col].width;
+ getColumnWidth : function(col) {
+ var width = this.config[col].width;
+ if(typeof width != 'number'){
+ width = this.defaultWidth;
+ }
+ return width;
},
/**
* @param {Boolean} suppressEvent True to suppress firing the <code>{@link #widthchange}</code>
* event. Defaults to false.
*/
- setColumnWidth : function(col, width, suppressEvent){
+ setColumnWidth : function(col, width, suppressEvent) {
this.config[col].width = width;
this.totalWidth = null;
- if(!suppressEvent){
+
+ if (!suppressEvent) {
this.fireEvent("widthchange", this, col, width);
}
},
* @param {Boolean} includeHidden True to include hidden column widths
* @return {Number}
*/
- getTotalWidth : function(includeHidden){
- if(!this.totalWidth){
+ getTotalWidth : function(includeHidden) {
+ if (!this.totalWidth) {
this.totalWidth = 0;
- for(var i = 0, len = this.config.length; i < len; i++){
- if(includeHidden || !this.isHidden(i)){
+ for (var i = 0, len = this.config.length; i < len; i++) {
+ if (includeHidden || !this.isHidden(i)) {
this.totalWidth += this.getColumnWidth(i);
}
}
* @param {Number} col The column index
* @return {String}
*/
- getColumnHeader : function(col){
+ getColumnHeader : function(col) {
return this.config[col].header;
},
* @param {Number} col The column index
* @param {String} header The new header
*/
- setColumnHeader : function(col, header){
+ setColumnHeader : function(col, header) {
this.config[col].header = header;
this.fireEvent("headerchange", this, col, header);
},
* @param {Number} col The column index
* @return {String}
*/
- getColumnTooltip : function(col){
+ getColumnTooltip : function(col) {
return this.config[col].tooltip;
},
/**
* @param {Number} col The column index
* @param {String} tooltip The new tooltip
*/
- setColumnTooltip : function(col, tooltip){
+ setColumnTooltip : function(col, tooltip) {
this.config[col].tooltip = tooltip;
},
* @param {Number} col The column index
* @return {String} The column's dataIndex
*/
- getDataIndex : function(col){
+ getDataIndex : function(col) {
return this.config[col].dataIndex;
},
* @param {Number} col The column index
* @param {String} dataIndex The new dataIndex
*/
- setDataIndex : function(col, dataIndex){
+ setDataIndex : function(col, dataIndex) {
this.config[col].dataIndex = dataIndex;
},
* @param {String} col The dataIndex to find
* @return {Number} The column index, or -1 if no match was found
*/
- findColumnIndex : function(dataIndex){
+ findColumnIndex : function(dataIndex) {
var c = this.config;
for(var i = 0, len = c.length; i < len; i++){
if(c[i].dataIndex == dataIndex){
* @param {Number} rowIndex The row index
* @return {Boolean}
*/
- isCellEditable : function(colIndex, rowIndex){
- return (this.config[colIndex].editable || (typeof this.config[colIndex].editable == "undefined" && this.config[colIndex].editor)) ? true : false;
+ isCellEditable : function(colIndex, rowIndex) {
+ var c = this.config[colIndex],
+ ed = c.editable;
+
+ //force boolean
+ return !!(ed || (!Ext.isDefined(ed) && c.editor));
},
/**
* @return {Ext.Editor} The {@link Ext.Editor Editor} that was created to wrap
* the {@link Ext.form.Field Field} used to edit the cell.
*/
- getCellEditor : function(colIndex, rowIndex){
+ getCellEditor : function(colIndex, rowIndex) {
return this.config[colIndex].getCellEditor(rowIndex);
},
* @param {Number} col The column index
* @param {Boolean} editable True if the column is editable
*/
- setEditable : function(col, editable){
+ setEditable : function(col, editable) {
this.config[col].editable = editable;
},
* @param {Number} colIndex The column index
* @return {Boolean}
*/
- isHidden : function(colIndex){
+ isHidden : function(colIndex) {
return !!this.config[colIndex].hidden; // ensure returns boolean
},
* @param {Number} colIndex The column index
* @return {Boolean}
*/
- isFixed : function(colIndex){
+ isFixed : function(colIndex) {
return !!this.config[colIndex].fixed;
},
* Returns true if the column can be resized
* @return {Boolean}
*/
- isResizable : function(colIndex){
+ isResizable : function(colIndex) {
return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true;
},
+
/**
* Sets if a column is hidden.
<pre><code>
* @param {Number} colIndex The column index
* @param {Boolean} hidden True if the column is hidden
*/
- setHidden : function(colIndex, hidden){
+ setHidden : function(colIndex, hidden) {
var c = this.config[colIndex];
if(c.hidden !== hidden){
c.hidden = hidden;
* @param {Number} col The column index
* @param {Object} editor The editor object
*/
- setEditor : function(col, editor){
- Ext.destroy(this.config[col].editor);
- this.config[col].editor = editor;
+ setEditor : function(col, editor) {
+ this.config[col].setEditor(editor);
},
/**
- * Destroys this column model by purging any event listeners, and removing any editors.
+ * Destroys this column model by purging any event listeners. Destroys and dereferences all Columns.
*/
- destroy : function(){
- for(var i = 0, c = this.config, len = c.length; i < len; i++){
- Ext.destroy(c[i].editor);
+ destroy : function() {
+ var length = this.config.length,
+ i = 0;
+
+ for (; i < length; i++){
+ this.config[i].destroy(); // Column's destroy encapsulates all cleanup.
}
+ delete this.config;
+ delete this.lookup;
this.purgeListeners();
+ },
+
+ /**
+ * @private
+ * Setup any saved state for the column, ensures that defaults are applied.
+ */
+ setState : function(col, state) {
+ state = Ext.applyIf(state, this.defaults);
+ Ext.apply(this.config[col], state);
}
});
// private
-Ext.grid.ColumnModel.defaultRenderer = function(value){
- if(typeof value == "string" && value.length < 1){
+Ext.grid.ColumnModel.defaultRenderer = function(value) {
+ if (typeof value == "string" && value.length < 1) {
return " ";
}
return value;
-};/**\r
- * @class Ext.grid.AbstractSelectionModel\r
- * @extends Ext.util.Observable\r
- * Abstract base class for grid SelectionModels. It provides the interface that should be\r
- * implemented by descendant classes. This class should not be directly instantiated.\r
- * @constructor\r
- */\r
-Ext.grid.AbstractSelectionModel = function(){\r
- this.locked = false;\r
- Ext.grid.AbstractSelectionModel.superclass.constructor.call(this);\r
-};\r
-\r
-Ext.extend(Ext.grid.AbstractSelectionModel, Ext.util.Observable, {\r
- /**\r
- * The GridPanel for which this SelectionModel is handling selection. Read-only.\r
- * @type Object\r
- * @property grid\r
- */\r
-\r
- /** @ignore Called by the grid automatically. Do not call directly. */\r
- init : function(grid){\r
- this.grid = grid;\r
- this.initEvents();\r
- },\r
-\r
- /**\r
- * Locks the selections.\r
- */\r
- lock : function(){\r
- this.locked = true;\r
- },\r
-\r
- /**\r
- * Unlocks the selections.\r
- */\r
- unlock : function(){\r
- this.locked = false;\r
- },\r
-\r
- /**\r
- * Returns true if the selections are locked.\r
- * @return {Boolean}\r
- */\r
- isLocked : function(){\r
- return this.locked;\r
- },\r
- \r
- destroy: function(){\r
- this.purgeListeners();\r
- }\r
+};/**
+ * @class Ext.grid.AbstractSelectionModel
+ * @extends Ext.util.Observable
+ * Abstract base class for grid SelectionModels. It provides the interface that should be
+ * implemented by descendant classes. This class should not be directly instantiated.
+ * @constructor
+ */
+Ext.grid.AbstractSelectionModel = Ext.extend(Ext.util.Observable, {
+ /**
+ * The GridPanel for which this SelectionModel is handling selection. Read-only.
+ * @type Object
+ * @property grid
+ */
+
+ constructor : function(){
+ this.locked = false;
+ Ext.grid.AbstractSelectionModel.superclass.constructor.call(this);
+ },
+
+ /** @ignore Called by the grid automatically. Do not call directly. */
+ init : function(grid){
+ this.grid = grid;
+ if(this.lockOnInit){
+ delete this.lockOnInit;
+ this.locked = false;
+ this.lock();
+ }
+ this.initEvents();
+ },
+
+ /**
+ * Locks the selections.
+ */
+ lock : function(){
+ if(!this.locked){
+ this.locked = true;
+ // If the grid has been set, then the view is already initialized.
+ var g = this.grid;
+ if(g){
+ g.getView().on({
+ scope: this,
+ beforerefresh: this.sortUnLock,
+ refresh: this.sortLock
+ });
+ }else{
+ this.lockOnInit = true;
+ }
+ }
+ },
+
+ // set the lock states before and after a view refresh
+ sortLock : function() {
+ this.locked = true;
+ },
+
+ // set the lock states before and after a view refresh
+ sortUnLock : function() {
+ this.locked = false;
+ },
+
+ /**
+ * Unlocks the selections.
+ */
+ unlock : function(){
+ if(this.locked){
+ this.locked = false;
+ var g = this.grid,
+ gv;
+
+ // If the grid has been set, then the view is already initialized.
+ if(g){
+ gv = g.getView();
+ gv.un('beforerefresh', this.sortUnLock, this);
+ gv.un('refresh', this.sortLock, this);
+ }else{
+ delete this.lockOnInit;
+ }
+ }
+ },
+
+ /**
+ * Returns true if the selections are locked.
+ * @return {Boolean}
+ */
+ isLocked : function(){
+ return this.locked;
+ },
+
+ destroy: function(){
+ this.unlock();
+ this.purgeListeners();
+ }
});/**
* @class Ext.grid.RowSelectionModel
* @extends Ext.grid.AbstractSelectionModel
* @constructor
* @param {Object} config
*/
-Ext.grid.RowSelectionModel = function(config){
- Ext.apply(this, config);
- this.selections = new Ext.util.MixedCollection(false, function(o){
- return o.id;
- });
-
- this.last = false;
- this.lastActive = false;
-
- this.addEvents(
- /**
- * @event selectionchange
- * Fires when the selection changes
- * @param {SelectionModel} this
- */
- 'selectionchange',
- /**
- * @event beforerowselect
- * Fires before a row is selected, return false to cancel the selection.
- * @param {SelectionModel} this
- * @param {Number} rowIndex The index to be selected
- * @param {Boolean} keepExisting False if other selections will be cleared
- * @param {Record} record The record to be selected
- */
- 'beforerowselect',
- /**
- * @event rowselect
- * Fires when a row is selected.
- * @param {SelectionModel} this
- * @param {Number} rowIndex The selected index
- * @param {Ext.data.Record} r The selected record
- */
- 'rowselect',
- /**
- * @event rowdeselect
- * Fires when a row is deselected. To prevent deselection
- * {@link Ext.grid.AbstractSelectionModel#lock lock the selections}.
- * @param {SelectionModel} this
- * @param {Number} rowIndex
- * @param {Record} record
- */
- 'rowdeselect'
- );
-
- Ext.grid.RowSelectionModel.superclass.constructor.call(this);
-};
-
-Ext.extend(Ext.grid.RowSelectionModel, Ext.grid.AbstractSelectionModel, {
+Ext.grid.RowSelectionModel = Ext.extend(Ext.grid.AbstractSelectionModel, {
/**
* @cfg {Boolean} singleSelect
* <tt>true</tt> to allow selection of only one row at a time (defaults to <tt>false</tt>
* allowing multiple selections)
*/
singleSelect : false,
+
+ constructor : function(config){
+ Ext.apply(this, config);
+ this.selections = new Ext.util.MixedCollection(false, function(o){
+ return o.id;
+ });
+
+ this.last = false;
+ this.lastActive = false;
+
+ this.addEvents(
+ /**
+ * @event selectionchange
+ * Fires when the selection changes
+ * @param {SelectionModel} this
+ */
+ 'selectionchange',
+ /**
+ * @event beforerowselect
+ * Fires before a row is selected, return false to cancel the selection.
+ * @param {SelectionModel} this
+ * @param {Number} rowIndex The index to be selected
+ * @param {Boolean} keepExisting False if other selections will be cleared
+ * @param {Record} record The record to be selected
+ */
+ 'beforerowselect',
+ /**
+ * @event rowselect
+ * Fires when a row is selected.
+ * @param {SelectionModel} this
+ * @param {Number} rowIndex The selected index
+ * @param {Ext.data.Record} r The selected record
+ */
+ 'rowselect',
+ /**
+ * @event rowdeselect
+ * Fires when a row is deselected. To prevent deselection
+ * {@link Ext.grid.AbstractSelectionModel#lock lock the selections}.
+ * @param {SelectionModel} this
+ * @param {Number} rowIndex
+ * @param {Record} record
+ */
+ 'rowdeselect'
+ );
+ Ext.grid.RowSelectionModel.superclass.constructor.call(this);
+ },
/**
* @cfg {Boolean} moveEditorOnEnter
}
this.rowNav = new Ext.KeyNav(this.grid.getGridEl(), {
- 'up' : function(e){
- if(!e.shiftKey || this.singleSelect){
- this.selectPrevious(false);
- }else if(this.last !== false && this.lastActive !== false){
- var last = this.last;
- this.selectRange(this.last, this.lastActive-1);
- this.grid.getView().focusRow(this.lastActive);
- if(last !== false){
- this.last = last;
- }
- }else{
- this.selectFirstRow();
- }
- },
- 'down' : function(e){
- if(!e.shiftKey || this.singleSelect){
- this.selectNext(false);
- }else if(this.last !== false && this.lastActive !== false){
- var last = this.last;
- this.selectRange(this.last, this.lastActive+1);
- this.grid.getView().focusRow(this.lastActive);
- if(last !== false){
- this.last = last;
- }
- }else{
- this.selectFirstRow();
- }
- },
+ up: this.onKeyPress,
+ down: this.onKeyPress,
scope: this
});
rowremoved: this.onRemove
});
},
+
+ onKeyPress : function(e, name){
+ var up = name == 'up',
+ method = up ? 'selectPrevious' : 'selectNext',
+ add = up ? -1 : 1,
+ last;
+ if(!e.shiftKey || this.singleSelect){
+ this[method](false);
+ }else if(this.last !== false && this.lastActive !== false){
+ last = this.last;
+ this.selectRange(this.last, this.lastActive + add);
+ this.grid.getView().focusRow(this.lastActive);
+ if(last !== false){
+ this.last = last;
+ }
+ }else{
+ this.selectFirstRow();
+ }
+ },
// private
onRefresh : function(){
- var ds = this.grid.store, index;
- var s = this.getSelections();
+ var ds = this.grid.store,
+ s = this.getSelections(),
+ i = 0,
+ len = s.length,
+ index, r;
+
+ this.silent = true;
this.clearSelections(true);
- for(var i = 0, len = s.length; i < len; i++){
- var r = s[i];
+ for(; i < len; i++){
+ r = s[i];
if((index = ds.indexOfId(r.id)) != -1){
this.selectRow(index, true);
}
if(s.length != this.selections.getCount()){
this.fireEvent('selectionchange', this);
}
+ this.silent = false;
},
// private
if(!keepExisting){
this.clearSelections();
}
- var ds = this.grid.store;
- for(var i = 0, len = records.length; i < len; i++){
+ var ds = this.grid.store,
+ i = 0,
+ len = records.length;
+ for(; i < len; i++){
this.selectRow(ds.indexOf(records[i]), true);
}
},
* Calls the passed function with each selection. If the function returns
* <tt>false</tt>, iteration is stopped and this function returns
* <tt>false</tt>. Otherwise it returns <tt>true</tt>.
- * @param {Function} fn
- * @param {Object} scope (optional)
+ * @param {Function} fn The function to call upon each iteration. It is passed the selected {@link Ext.data.Record Record}.
+ * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this RowSelectionModel.
* @return {Boolean} true if all selections were iterated
*/
each : function(fn, scope){
- var s = this.getSelections();
- for(var i = 0, len = s.length; i < len; i++){
+ var s = this.getSelections(),
+ i = 0,
+ len = s.length;
+
+ for(; i < len; i++){
if(fn.call(scope || this, s[i], i) === false){
return false;
}
return;
}
if(fast !== true){
- var ds = this.grid.store;
- var s = this.selections;
+ var ds = this.grid.store,
+ s = this.selections;
s.each(function(r){
this.deselectRow(ds.indexOfId(r.id));
}, this);
if(!preventViewNotify){
this.grid.getView().onRowSelect(index);
}
- this.fireEvent('rowselect', this, index, r);
- this.fireEvent('selectionchange', this);
+ if(!this.silent){
+ this.fireEvent('rowselect', this, index, r);
+ this.fireEvent('selectionchange', this);
+ }
}
},
}
},
- // private
- restoreLast : function(){
- if(this._last){
- this.last = this._last;
- }
- },
-
// private
acceptsNav : function(row, col, cm){
return !cm.isHidden(col) && cm.isCellEditable(col, row);
g = this.grid,
last = g.lastEdit,
ed = g.activeEditor,
+ shift = e.shiftKey,
ae, last, r, c;
- var shift = e.shiftKey;
+
if(k == e.TAB){
e.stopEvent();
ed.completeEdit();
r = newCell[0];
c = newCell[1];
- if(last.row != r){
- this.selectRow(r); // *** highlight newly-selected cell and update selection
- }
+ this.onEditorSelect(r, last.row);
if(g.isEditor && g.editing){ // *** handle tabbing while editorgrid is in edit mode
ae = g.activeEditor;
}
},
- destroy : function(){
- if(this.rowNav){
- this.rowNav.disable();
- this.rowNav = null;
+ onEditorSelect: function(row, lastRow){
+ if(lastRow != row){
+ this.selectRow(row); // *** highlight newly-selected cell and update selection
}
+ },
+
+ destroy : function(){
+ Ext.destroy(this.rowNav);
+ this.rowNav = null;
Ext.grid.RowSelectionModel.superclass.destroy.call(this);
}
-});/**\r
- * @class Ext.grid.Column\r
- * <p>This class encapsulates column configuration data to be used in the initialization of a\r
- * {@link Ext.grid.ColumnModel ColumnModel}.</p>\r
- * <p>While subclasses are provided to render data in different ways, this class renders a passed\r
- * data field unchanged and is usually used for textual columns.</p>\r
- */\r
-Ext.grid.Column = function(config){\r
- Ext.apply(this, config);\r
-\r
- if(Ext.isString(this.renderer)){\r
- this.renderer = Ext.util.Format[this.renderer];\r
- } else if(Ext.isObject(this.renderer)){\r
- this.scope = this.renderer.scope;\r
- this.renderer = this.renderer.fn;\r
- }\r
- this.renderer = this.renderer.createDelegate(this.scope || config);\r
-\r
- if(this.editor){\r
- this.editor = Ext.create(this.editor, 'textfield');\r
- }\r
-};\r
-\r
-Ext.grid.Column.prototype = {\r
- /**\r
- * @cfg {Boolean} editable Optional. Defaults to <tt>true</tt>, enabling the configured\r
- * <tt>{@link #editor}</tt>. Set to <tt>false</tt> to initially disable editing on this column.\r
- * The initial configuration may be dynamically altered using\r
- * {@link Ext.grid.ColumnModel}.{@link Ext.grid.ColumnModel#setEditable setEditable()}.\r
- */\r
- /**\r
- * @cfg {String} id Optional. A name which identifies this column (defaults to the column's initial\r
- * ordinal position.) The <tt>id</tt> is used to create a CSS <b>class</b> name which is applied to all\r
- * table cells (including headers) in that column (in this context the <tt>id</tt> does not need to be\r
- * unique). The class name takes the form of <pre>x-grid3-td-<b>id</b></pre>\r
- * Header cells will also receive this class name, but will also have the class <pre>x-grid3-hd</pre>\r
- * So, to target header cells, use CSS selectors such as:<pre>.x-grid3-hd-row .x-grid3-td-<b>id</b></pre>\r
- * The {@link Ext.grid.GridPanel#autoExpandColumn} grid config option references the column via this\r
- * unique identifier.\r
- */\r
- /**\r
- * @cfg {String} header Optional. The header text to be used as innerHTML\r
- * (html tags are accepted) to display in the Grid view. <b>Note</b>: to\r
- * have a clickable header with no text displayed use <tt>' '</tt>.\r
- */\r
- /**\r
- * @cfg {Boolean} groupable Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option\r
- * may be used to disable the header menu item to group by the column selected. Defaults to <tt>true</tt>,\r
- * which enables the header menu group option. Set to <tt>false</tt> to disable (but still show) the\r
- * group option in the header menu for the column. See also <code>{@link #groupName}</code>.\r
- */\r
- /**\r
- * @cfg {String} groupName Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option\r
- * may be used to specify the text with which to prefix the group field value in the group header line.\r
- * See also {@link #groupRenderer} and\r
- * {@link Ext.grid.GroupingView}.{@link Ext.grid.GroupingView#showGroupName showGroupName}.\r
- */\r
- /**\r
- * @cfg {Function} groupRenderer <p>Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option\r
- * may be used to specify the function used to format the grouping field value for display in the group\r
- * {@link #groupName header}. If a <tt><b>groupRenderer</b></tt> is not specified, the configured\r
- * <tt><b>{@link #renderer}</b></tt> will be called; if a <tt><b>{@link #renderer}</b></tt> is also not specified\r
- * the new value of the group field will be used.</p>\r
- * <p>The called function (either the <tt><b>groupRenderer</b></tt> or <tt><b>{@link #renderer}</b></tt>) will be\r
- * passed the following parameters:\r
- * <div class="mdetail-params"><ul>\r
- * <li><b>v</b> : Object<p class="sub-desc">The new value of the group field.</p></li>\r
- * <li><b>unused</b> : undefined<p class="sub-desc">Unused parameter.</p></li>\r
- * <li><b>r</b> : Ext.data.Record<p class="sub-desc">The Record providing the data\r
- * for the row which caused group change.</p></li>\r
- * <li><b>rowIndex</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li>\r
- * <li><b>colIndex</b> : Number<p class="sub-desc">The column index of the group field.</p></li>\r
- * <li><b>ds</b> : Ext.data.Store<p class="sub-desc">The Store which is providing the data Model.</p></li>\r
- * </ul></div></p>\r
- * <p>The function should return a string value.</p>\r
- */\r
- /**\r
- * @cfg {String} emptyGroupText Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option\r
- * may be used to specify the text to display when there is an empty group value. Defaults to the\r
- * {@link Ext.grid.GroupingView}.{@link Ext.grid.GroupingView#emptyGroupText emptyGroupText}.\r
- */\r
- /**\r
- * @cfg {String} dataIndex <p><b>Required</b>. The name of the field in the\r
- * grid's {@link Ext.data.Store}'s {@link Ext.data.Record} definition from\r
- * which to draw the column's value.</p>\r
- */\r
- /**\r
- * @cfg {Number} width\r
- * Optional. The initial width in pixels of the column.\r
- * The width of each column can also be affected if any of the following are configured:\r
- * <div class="mdetail-params"><ul>\r
- * <li>{@link Ext.grid.GridPanel}.<tt>{@link Ext.grid.GridPanel#autoExpandColumn autoExpandColumn}</tt></li>\r
- * <li>{@link Ext.grid.GridView}.<tt>{@link Ext.grid.GridView#forceFit forceFit}</tt>\r
- * <div class="sub-desc">\r
- * <p>By specifying <tt>forceFit:true</tt>, {@link #fixed non-fixed width} columns will be\r
- * re-proportioned (based on the relative initial widths) to fill the width of the grid so\r
- * that no horizontal scrollbar is shown.</p>\r
- * </div></li>\r
- * <li>{@link Ext.grid.GridView}.<tt>{@link Ext.grid.GridView#autoFill autoFill}</tt></li>\r
- * <li>{@link Ext.grid.GridPanel}.<tt>{@link Ext.grid.GridPanel#minColumnWidth minColumnWidth}</tt></li>\r
- * <br><p><b>Note</b>: when the width of each column is determined, a space on the right side\r
- * is reserved for the vertical scrollbar. The\r
- * {@link Ext.grid.GridView}.<tt>{@link Ext.grid.GridView#scrollOffset scrollOffset}</tt>\r
- * can be modified to reduce or eliminate the reserved offset.</p>\r
- */\r
- /**\r
- * @cfg {Boolean} sortable Optional. <tt>true</tt> if sorting is to be allowed on this column.\r
- * Defaults to the value of the <code>{@link Ext.grid.ColumnModel#defaultSortable}</code> property.\r
- * Whether local/remote sorting is used is specified in <code>{@link Ext.data.Store#remoteSort}</code>.\r
- */\r
- /**\r
- * @cfg {Boolean} fixed Optional. <tt>true</tt> if the column width cannot be changed. Defaults to <tt>false</tt>.\r
- */\r
- /**\r
- * @cfg {Boolean} resizable Optional. <tt>false</tt> to disable column resizing. Defaults to <tt>true</tt>.\r
- */\r
- /**\r
- * @cfg {Boolean} menuDisabled Optional. <tt>true</tt> to disable the column menu. Defaults to <tt>false</tt>.\r
- */\r
- /**\r
- * @cfg {Boolean} hidden\r
- * Optional. <tt>true</tt> to initially hide this column. Defaults to <tt>false</tt>.\r
- * A hidden column {@link Ext.grid.GridPanel#enableColumnHide may be shown via the header row menu}.\r
- * If a column is never to be shown, simply do not include this column in the Column Model at all. \r
- */\r
- /**\r
- * @cfg {String} tooltip Optional. A text string to use as the column header's tooltip. If Quicktips\r
- * are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the\r
- * header's HTML title attribute. Defaults to ''.\r
- */\r
- /**\r
- * @cfg {Mixed} renderer\r
- * <p>For an alternative to specifying a renderer see <code>{@link #xtype}</code></p>\r
- * <p>Optional. A renderer is an 'interceptor' method which can be used transform data (value,\r
- * appearance, etc.) before it is rendered). This may be specified in either of three ways:\r
- * <div class="mdetail-params"><ul>\r
- * <li>A renderer function used to return HTML markup for a cell given the cell's data value.</li>\r
- * <li>A string which references a property name of the {@link Ext.util.Format} class which\r
- * provides a renderer function.</li>\r
- * <li>An object specifying both the renderer function, and its execution scope (<tt><b>this</b></tt>\r
- * reference) e.g.:<pre style="margin-left:1.2em"><code>\r
-{\r
- fn: this.gridRenderer,\r
- scope: this\r
-}\r
-</code></pre></li></ul></div>\r
- * If not specified, the default renderer uses the raw data value.</p>\r
- * <p>For information about the renderer function (passed parameters, etc.), see\r
- * {@link Ext.grid.ColumnModel#setRenderer}. An example of specifying renderer function inline:</p><pre><code>\r
-var companyColumn = {\r
- header: 'Company Name',\r
- dataIndex: 'company',\r
- renderer: function(value, metaData, record, rowIndex, colIndex, store) {\r
- // provide the logic depending on business rules\r
- // name of your own choosing to manipulate the cell depending upon\r
- // the data in the underlying Record object.\r
- if (value == 'whatever') {\r
- //metaData.css : String : A CSS class name to add to the TD element of the cell.\r
- //metaData.attr : String : An html attribute definition string to apply to\r
- // the data container element within the table\r
- // cell (e.g. 'style="color:red;"').\r
- metaData.css = 'name-of-css-class-you-will-define';\r
- }\r
- return value;\r
- }\r
-}\r
- * </code></pre>\r
- * See also {@link #scope}.\r
- */\r
- /**\r
- * @cfg {String} xtype Optional. A String which references a predefined {@link Ext.grid.Column} subclass\r
- * type which is preconfigured with an appropriate <code>{@link #renderer}</code> to be easily\r
- * configured into a ColumnModel. The predefined {@link Ext.grid.Column} subclass types are:\r
- * <div class="mdetail-params"><ul>\r
- * <li><b><tt>gridcolumn</tt></b> : {@link Ext.grid.Column} (<b>Default</b>)<p class="sub-desc"></p></li>\r
- * <li><b><tt>booleancolumn</tt></b> : {@link Ext.grid.BooleanColumn}<p class="sub-desc"></p></li>\r
- * <li><b><tt>numbercolumn</tt></b> : {@link Ext.grid.NumberColumn}<p class="sub-desc"></p></li>\r
- * <li><b><tt>datecolumn</tt></b> : {@link Ext.grid.DateColumn}<p class="sub-desc"></p></li>\r
- * <li><b><tt>templatecolumn</tt></b> : {@link Ext.grid.TemplateColumn}<p class="sub-desc"></p></li>\r
- * </ul></div>\r
- * <p>Configuration properties for the specified <code>xtype</code> may be specified with\r
- * the Column configuration properties, for example:</p>\r
- * <pre><code>\r
-var grid = new Ext.grid.GridPanel({\r
- ...\r
- columns: [{\r
- header: 'Last Updated',\r
- dataIndex: 'lastChange',\r
- width: 85,\r
- sortable: true,\r
- //renderer: Ext.util.Format.dateRenderer('m/d/Y'),\r
- xtype: 'datecolumn', // use xtype instead of renderer\r
- format: 'M/d/Y' // configuration property for {@link Ext.grid.DateColumn}\r
- }, {\r
- ...\r
- }]\r
-});\r
- * </code></pre>\r
- */\r
- /**\r
- * @cfg {Object} scope Optional. The scope (<tt><b>this</b></tt> reference) in which to execute the\r
- * renderer. Defaults to the Column configuration object.\r
- */\r
- /**\r
- * @cfg {String} align Optional. Set the CSS text-align property of the column. Defaults to undefined.\r
- */\r
- /**\r
- * @cfg {String} css Optional. An inline style definition string which is applied to all table cells in the column\r
- * (excluding headers). Defaults to undefined.\r
- */\r
- /**\r
- * @cfg {Boolean} hideable Optional. Specify as <tt>false</tt> to prevent the user from hiding this column\r
- * (defaults to true). To disallow column hiding globally for all columns in the grid, use\r
- * {@link Ext.grid.GridPanel#enableColumnHide} instead.\r
- */\r
- /**\r
- * @cfg {Ext.form.Field} editor Optional. The {@link Ext.form.Field} to use when editing values in this column\r
- * if editing is supported by the grid. See <tt>{@link #editable}</tt> also.\r
- */\r
-\r
- /**\r
- * @private\r
- * @cfg {Boolean} isColumn\r
- * Used by ColumnModel setConfig method to avoid reprocessing a Column\r
- * if <code>isColumn</code> is not set ColumnModel will recreate a new Ext.grid.Column\r
- * Defaults to true.\r
- */\r
- isColumn : true,\r
-\r
- /**\r
- * Optional. A function which returns displayable data when passed the following parameters:\r
- * <div class="mdetail-params"><ul>\r
- * <li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>\r
- * <li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>\r
- * <li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>\r
- * <li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container\r
- * element <i>within</i> the table cell (e.g. 'style="color:red;"').</p></li></ul></p></li>\r
- * <li><b>record</b> : Ext.data.record<p class="sub-desc">The {@link Ext.data.Record} from which the data was\r
- * extracted.</p></li>\r
- * <li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>\r
- * <li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>\r
- * <li><b>store</b> : Ext.data.Store<p class="sub-desc">The {@link Ext.data.Store} object from which the Record\r
- * was extracted.</p></li>\r
- * </ul></div>\r
- * @property renderer\r
- * @type Function\r
- */\r
- renderer : function(value){\r
- if(Ext.isString(value) && value.length < 1){\r
- return ' ';\r
- }\r
- return value;\r
- },\r
-\r
- // private\r
- getEditor: function(rowIndex){\r
- return this.editable !== false ? this.editor : null;\r
- },\r
-\r
- /**\r
- * Returns the {@link Ext.Editor editor} defined for this column that was created to wrap the {@link Ext.form.Field Field}\r
- * used to edit the cell.\r
- * @param {Number} rowIndex The row index\r
- * @return {Ext.Editor}\r
- */\r
- getCellEditor: function(rowIndex){\r
- var editor = this.getEditor(rowIndex);\r
- if(editor){\r
- if(!editor.startEdit){\r
- if(!editor.gridEditor){\r
- editor.gridEditor = new Ext.grid.GridEditor(editor);\r
- }\r
- return editor.gridEditor;\r
- }else if(editor.startEdit){\r
- return editor;\r
- }\r
- }\r
- return null;\r
- }\r
-};\r
-\r
-/**\r
- * @class Ext.grid.BooleanColumn\r
- * @extends Ext.grid.Column\r
- * <p>A Column definition class which renders boolean data fields. See the {@link Ext.grid.Column#xtype xtype}\r
- * config option of {@link Ext.grid.Column} for more details.</p>\r
- */\r
-Ext.grid.BooleanColumn = Ext.extend(Ext.grid.Column, {\r
- /**\r
- * @cfg {String} trueText\r
- * The string returned by the renderer when the column value is not falsey (defaults to <tt>'true'</tt>).\r
- */\r
- trueText: 'true',\r
- /**\r
- * @cfg {String} falseText\r
- * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to\r
- * <tt>'false'</tt>).\r
- */\r
- falseText: 'false',\r
- /**\r
- * @cfg {String} undefinedText\r
- * The string returned by the renderer when the column value is undefined (defaults to <tt>' '</tt>).\r
- */\r
- undefinedText: ' ',\r
-\r
- constructor: function(cfg){\r
- Ext.grid.BooleanColumn.superclass.constructor.call(this, cfg);\r
- var t = this.trueText, f = this.falseText, u = this.undefinedText;\r
- this.renderer = function(v){\r
- if(v === undefined){\r
- return u;\r
- }\r
- if(!v || v === 'false'){\r
- return f;\r
- }\r
- return t;\r
- };\r
- }\r
-});\r
-\r
-/**\r
- * @class Ext.grid.NumberColumn\r
- * @extends Ext.grid.Column\r
- * <p>A Column definition class which renders a numeric data field according to a {@link #format} string. See the\r
- * {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column} for more details.</p>\r
- */\r
-Ext.grid.NumberColumn = Ext.extend(Ext.grid.Column, {\r
- /**\r
- * @cfg {String} format\r
- * A formatting string as used by {@link Ext.util.Format#number} to format a numeric value for this Column\r
- * (defaults to <tt>'0,000.00'</tt>).\r
- */\r
- format : '0,000.00',\r
- constructor: function(cfg){\r
- Ext.grid.NumberColumn.superclass.constructor.call(this, cfg);\r
- this.renderer = Ext.util.Format.numberRenderer(this.format);\r
- }\r
-});\r
-\r
-/**\r
- * @class Ext.grid.DateColumn\r
- * @extends Ext.grid.Column\r
- * <p>A Column definition class which renders a passed date according to the default locale, or a configured\r
- * {@link #format}. See the {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column}\r
- * for more details.</p>\r
- */\r
-Ext.grid.DateColumn = Ext.extend(Ext.grid.Column, {\r
- /**\r
- * @cfg {String} format\r
- * A formatting string as used by {@link Date#format} to format a Date for this Column\r
- * (defaults to <tt>'m/d/Y'</tt>).\r
- */\r
- format : 'm/d/Y',\r
- constructor: function(cfg){\r
- Ext.grid.DateColumn.superclass.constructor.call(this, cfg);\r
- this.renderer = Ext.util.Format.dateRenderer(this.format);\r
- }\r
-});\r
-\r
-/**\r
- * @class Ext.grid.TemplateColumn\r
- * @extends Ext.grid.Column\r
- * <p>A Column definition class which renders a value by processing a {@link Ext.data.Record Record}'s\r
- * {@link Ext.data.Record#data data} using a {@link #tpl configured} {@link Ext.XTemplate XTemplate}.\r
- * See the {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column} for more\r
- * details.</p>\r
- */\r
-Ext.grid.TemplateColumn = Ext.extend(Ext.grid.Column, {\r
- /**\r
- * @cfg {String/XTemplate} tpl\r
- * An {@link Ext.XTemplate XTemplate}, or an XTemplate <i>definition string</i> to use to process a\r
- * {@link Ext.data.Record Record}'s {@link Ext.data.Record#data data} to produce a column's rendered value.\r
- */\r
- constructor: function(cfg){\r
- Ext.grid.TemplateColumn.superclass.constructor.call(this, cfg);\r
- var tpl = Ext.isObject(this.tpl) ? this.tpl : new Ext.XTemplate(this.tpl);\r
- this.renderer = function(value, p, r){\r
- return tpl.apply(r.data);\r
- };\r
- this.tpl = tpl;\r
- }\r
-});\r
-\r
-/*\r
- * @property types\r
- * @type Object\r
- * @member Ext.grid.Column\r
- * @static\r
- * <p>An object containing predefined Column classes keyed by a mnemonic code which may be referenced\r
- * by the {@link Ext.grid.ColumnModel#xtype xtype} config option of ColumnModel.</p>\r
- * <p>This contains the following properties</p><div class="mdesc-details"><ul>\r
- * <li>gridcolumn : <b>{@link Ext.grid.Column Column constructor}</b></li>\r
- * <li>booleancolumn : <b>{@link Ext.grid.BooleanColumn BooleanColumn constructor}</b></li>\r
- * <li>numbercolumn : <b>{@link Ext.grid.NumberColumn NumberColumn constructor}</b></li>\r
- * <li>datecolumn : <b>{@link Ext.grid.DateColumn DateColumn constructor}</b></li>\r
- * <li>templatecolumn : <b>{@link Ext.grid.TemplateColumn TemplateColumn constructor}</b></li>\r
- * </ul></div>\r
- */\r
-Ext.grid.Column.types = {\r
- gridcolumn : Ext.grid.Column,\r
- booleancolumn: Ext.grid.BooleanColumn,\r
- numbercolumn: Ext.grid.NumberColumn,\r
- datecolumn: Ext.grid.DateColumn,\r
- templatecolumn: Ext.grid.TemplateColumn\r
+});
+/**
+ * @class Ext.grid.Column
+ * <p>This class encapsulates column configuration data to be used in the initialization of a
+ * {@link Ext.grid.ColumnModel ColumnModel}.</p>
+ * <p>While subclasses are provided to render data in different ways, this class renders a passed
+ * data field unchanged and is usually used for textual columns.</p>
+ */
+Ext.grid.Column = Ext.extend(Ext.util.Observable, {
+ /**
+ * @cfg {Boolean} editable Optional. Defaults to <tt>true</tt>, enabling the configured
+ * <tt>{@link #editor}</tt>. Set to <tt>false</tt> to initially disable editing on this column.
+ * The initial configuration may be dynamically altered using
+ * {@link Ext.grid.ColumnModel}.{@link Ext.grid.ColumnModel#setEditable setEditable()}.
+ */
+ /**
+ * @cfg {String} id Optional. A name which identifies this column (defaults to the column's initial
+ * ordinal position.) The <tt>id</tt> is used to create a CSS <b>class</b> name which is applied to all
+ * table cells (including headers) in that column (in this context the <tt>id</tt> does not need to be
+ * unique). The class name takes the form of <pre>x-grid3-td-<b>id</b></pre>
+ * Header cells will also receive this class name, but will also have the class <pre>x-grid3-hd</pre>
+ * So, to target header cells, use CSS selectors such as:<pre>.x-grid3-hd-row .x-grid3-td-<b>id</b></pre>
+ * The {@link Ext.grid.GridPanel#autoExpandColumn} grid config option references the column via this
+ * unique identifier.
+ */
+ /**
+ * @cfg {String} header Optional. The header text to be used as innerHTML
+ * (html tags are accepted) to display in the Grid view. <b>Note</b>: to
+ * have a clickable header with no text displayed use <tt>'&#160;'</tt>.
+ */
+ /**
+ * @cfg {Boolean} groupable Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
+ * may be used to disable the header menu item to group by the column selected. Defaults to <tt>true</tt>,
+ * which enables the header menu group option. Set to <tt>false</tt> to disable (but still show) the
+ * group option in the header menu for the column. See also <code>{@link #groupName}</code>.
+ */
+ /**
+ * @cfg {String} groupName Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
+ * may be used to specify the text with which to prefix the group field value in the group header line.
+ * See also {@link #groupRenderer} and
+ * {@link Ext.grid.GroupingView}.{@link Ext.grid.GroupingView#showGroupName showGroupName}.
+ */
+ /**
+ * @cfg {Function} groupRenderer <p>Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
+ * may be used to specify the function used to format the grouping field value for display in the group
+ * {@link #groupName header}. If a <tt><b>groupRenderer</b></tt> is not specified, the configured
+ * <tt><b>{@link #renderer}</b></tt> will be called; if a <tt><b>{@link #renderer}</b></tt> is also not specified
+ * the new value of the group field will be used.</p>
+ * <p>The called function (either the <tt><b>groupRenderer</b></tt> or <tt><b>{@link #renderer}</b></tt>) will be
+ * passed the following parameters:
+ * <div class="mdetail-params"><ul>
+ * <li><b>v</b> : Object<p class="sub-desc">The new value of the group field.</p></li>
+ * <li><b>unused</b> : undefined<p class="sub-desc">Unused parameter.</p></li>
+ * <li><b>r</b> : Ext.data.Record<p class="sub-desc">The Record providing the data
+ * for the row which caused group change.</p></li>
+ * <li><b>rowIndex</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li>
+ * <li><b>colIndex</b> : Number<p class="sub-desc">The column index of the group field.</p></li>
+ * <li><b>ds</b> : Ext.data.Store<p class="sub-desc">The Store which is providing the data Model.</p></li>
+ * </ul></div></p>
+ * <p>The function should return a string value.</p>
+ */
+ /**
+ * @cfg {String} emptyGroupText Optional. If the grid is being rendered by an {@link Ext.grid.GroupingView}, this option
+ * may be used to specify the text to display when there is an empty group value. Defaults to the
+ * {@link Ext.grid.GroupingView}.{@link Ext.grid.GroupingView#emptyGroupText emptyGroupText}.
+ */
+ /**
+ * @cfg {String} dataIndex <p><b>Required</b>. The name of the field in the
+ * grid's {@link Ext.data.Store}'s {@link Ext.data.Record} definition from
+ * which to draw the column's value.</p>
+ */
+ /**
+ * @cfg {Number} width
+ * Optional. The initial width in pixels of the column.
+ * The width of each column can also be affected if any of the following are configured:
+ * <div class="mdetail-params"><ul>
+ * <li>{@link Ext.grid.GridPanel}.<tt>{@link Ext.grid.GridPanel#autoExpandColumn autoExpandColumn}</tt></li>
+ * <li>{@link Ext.grid.GridView}.<tt>{@link Ext.grid.GridView#forceFit forceFit}</tt>
+ * <div class="sub-desc">
+ * <p>By specifying <tt>forceFit:true</tt>, {@link #fixed non-fixed width} columns will be
+ * re-proportioned (based on the relative initial widths) to fill the width of the grid so
+ * that no horizontal scrollbar is shown.</p>
+ * </div></li>
+ * <li>{@link Ext.grid.GridView}.<tt>{@link Ext.grid.GridView#autoFill autoFill}</tt></li>
+ * <li>{@link Ext.grid.GridPanel}.<tt>{@link Ext.grid.GridPanel#minColumnWidth minColumnWidth}</tt></li>
+ * <br><p><b>Note</b>: when the width of each column is determined, a space on the right side
+ * is reserved for the vertical scrollbar. The
+ * {@link Ext.grid.GridView}.<tt>{@link Ext.grid.GridView#scrollOffset scrollOffset}</tt>
+ * can be modified to reduce or eliminate the reserved offset.</p>
+ */
+ /**
+ * @cfg {Boolean} sortable Optional. <tt>true</tt> if sorting is to be allowed on this column.
+ * Defaults to the value of the <code>{@link Ext.grid.ColumnModel#defaultSortable}</code> property.
+ * Whether local/remote sorting is used is specified in <code>{@link Ext.data.Store#remoteSort}</code>.
+ */
+ /**
+ * @cfg {Boolean} fixed Optional. <tt>true</tt> if the column width cannot be changed. Defaults to <tt>false</tt>.
+ */
+ /**
+ * @cfg {Boolean} resizable Optional. <tt>false</tt> to disable column resizing. Defaults to <tt>true</tt>.
+ */
+ /**
+ * @cfg {Boolean} menuDisabled Optional. <tt>true</tt> to disable the column menu. Defaults to <tt>false</tt>.
+ */
+ /**
+ * @cfg {Boolean} hidden
+ * Optional. <tt>true</tt> to initially hide this column. Defaults to <tt>false</tt>.
+ * A hidden column {@link Ext.grid.GridPanel#enableColumnHide may be shown via the header row menu}.
+ * If a column is never to be shown, simply do not include this column in the Column Model at all.
+ */
+ /**
+ * @cfg {String} tooltip Optional. A text string to use as the column header's tooltip. If Quicktips
+ * are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the
+ * header's HTML title attribute. Defaults to ''.
+ */
+ /**
+ * @cfg {Mixed} renderer
+ * <p>For an alternative to specifying a renderer see <code>{@link #xtype}</code></p>
+ * <p>Optional. A renderer is an 'interceptor' method which can be used transform data (value,
+ * appearance, etc.) before it is rendered). This may be specified in either of three ways:
+ * <div class="mdetail-params"><ul>
+ * <li>A renderer function used to return HTML markup for a cell given the cell's data value.</li>
+ * <li>A string which references a property name of the {@link Ext.util.Format} class which
+ * provides a renderer function.</li>
+ * <li>An object specifying both the renderer function, and its execution scope (<tt><b>this</b></tt>
+ * reference) e.g.:<pre style="margin-left:1.2em"><code>
+{
+ fn: this.gridRenderer,
+ scope: this
+}
+</code></pre></li></ul></div>
+ * If not specified, the default renderer uses the raw data value.</p>
+ * <p>For information about the renderer function (passed parameters, etc.), see
+ * {@link Ext.grid.ColumnModel#setRenderer}. An example of specifying renderer function inline:</p><pre><code>
+var companyColumn = {
+ header: 'Company Name',
+ dataIndex: 'company',
+ renderer: function(value, metaData, record, rowIndex, colIndex, store) {
+ // provide the logic depending on business rules
+ // name of your own choosing to manipulate the cell depending upon
+ // the data in the underlying Record object.
+ if (value == 'whatever') {
+ //metaData.css : String : A CSS class name to add to the TD element of the cell.
+ //metaData.attr : String : An html attribute definition string to apply to
+ // the data container element within the table
+ // cell (e.g. 'style="color:red;"').
+ metaData.css = 'name-of-css-class-you-will-define';
+ }
+ return value;
+ }
+}
+ * </code></pre>
+ * See also {@link #scope}.
+ */
+ /**
+ * @cfg {String} xtype Optional. A String which references a predefined {@link Ext.grid.Column} subclass
+ * type which is preconfigured with an appropriate <code>{@link #renderer}</code> to be easily
+ * configured into a ColumnModel. The predefined {@link Ext.grid.Column} subclass types are:
+ * <div class="mdetail-params"><ul>
+ * <li><b><tt>gridcolumn</tt></b> : {@link Ext.grid.Column} (<b>Default</b>)<p class="sub-desc"></p></li>
+ * <li><b><tt>booleancolumn</tt></b> : {@link Ext.grid.BooleanColumn}<p class="sub-desc"></p></li>
+ * <li><b><tt>numbercolumn</tt></b> : {@link Ext.grid.NumberColumn}<p class="sub-desc"></p></li>
+ * <li><b><tt>datecolumn</tt></b> : {@link Ext.grid.DateColumn}<p class="sub-desc"></p></li>
+ * <li><b><tt>templatecolumn</tt></b> : {@link Ext.grid.TemplateColumn}<p class="sub-desc"></p></li>
+ * </ul></div>
+ * <p>Configuration properties for the specified <code>xtype</code> may be specified with
+ * the Column configuration properties, for example:</p>
+ * <pre><code>
+var grid = new Ext.grid.GridPanel({
+ ...
+ columns: [{
+ header: 'Last Updated',
+ dataIndex: 'lastChange',
+ width: 85,
+ sortable: true,
+ //renderer: Ext.util.Format.dateRenderer('m/d/Y'),
+ xtype: 'datecolumn', // use xtype instead of renderer
+ format: 'M/d/Y' // configuration property for {@link Ext.grid.DateColumn}
+ }, {
+ ...
+ }]
+});
+ * </code></pre>
+ */
+ /**
+ * @cfg {Object} scope Optional. The scope (<tt><b>this</b></tt> reference) in which to execute the
+ * renderer. Defaults to the Column configuration object.
+ */
+ /**
+ * @cfg {String} align Optional. Set the CSS text-align property of the column. Defaults to undefined.
+ */
+ /**
+ * @cfg {String} css Optional. An inline style definition string which is applied to all table cells in the column
+ * (excluding headers). Defaults to undefined.
+ */
+ /**
+ * @cfg {Boolean} hideable Optional. Specify as <tt>false</tt> to prevent the user from hiding this column
+ * (defaults to true). To disallow column hiding globally for all columns in the grid, use
+ * {@link Ext.grid.GridPanel#enableColumnHide} instead.
+ */
+ /**
+ * @cfg {Ext.form.Field} editor Optional. The {@link Ext.form.Field} to use when editing values in this column
+ * if editing is supported by the grid. See <tt>{@link #editable}</tt> also.
+ */
+
+ /**
+ * @private
+ * @cfg {Boolean} isColumn
+ * Used by ColumnModel setConfig method to avoid reprocessing a Column
+ * if <code>isColumn</code> is not set ColumnModel will recreate a new Ext.grid.Column
+ * Defaults to true.
+ */
+ isColumn : true,
+
+ constructor : function(config){
+ Ext.apply(this, config);
+
+ if(Ext.isString(this.renderer)){
+ this.renderer = Ext.util.Format[this.renderer];
+ }else if(Ext.isObject(this.renderer)){
+ this.scope = this.renderer.scope;
+ this.renderer = this.renderer.fn;
+ }
+ if(!this.scope){
+ this.scope = this;
+ }
+
+ var ed = this.editor;
+ delete this.editor;
+ this.setEditor(ed);
+ this.addEvents(
+ /**
+ * @event click
+ * Fires when this Column is clicked.
+ * @param {Column} this
+ * @param {Grid} The owning GridPanel
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'click',
+ /**
+ * @event contextmenu
+ * Fires when this Column is right clicked.
+ * @param {Column} this
+ * @param {Grid} The owning GridPanel
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'contextmenu',
+ /**
+ * @event dblclick
+ * Fires when this Column is double clicked.
+ * @param {Column} this
+ * @param {Grid} The owning GridPanel
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'dblclick',
+ /**
+ * @event mousedown
+ * Fires when this Column receives a mousedown event.
+ * @param {Column} this
+ * @param {Grid} The owning GridPanel
+ * @param {Number} rowIndex
+ * @param {Ext.EventObject} e
+ */
+ 'mousedown'
+ );
+ Ext.grid.Column.superclass.constructor.call(this);
+ },
+
+ /**
+ * @private
+ * Process and refire events routed from the GridView's processEvent method.
+ * Returns the event handler's status to allow cancelling of GridView's bubbling process.
+ */
+ processEvent : function(name, e, grid, rowIndex, colIndex){
+ return this.fireEvent(name, this, grid, rowIndex, e);
+ },
+
+ /**
+ * @private
+ * Clean up. Remove any Editor. Remove any listeners.
+ */
+ destroy: function() {
+ if(this.setEditor){
+ this.setEditor(null);
+ }
+ this.purgeListeners();
+ },
+
+ /**
+ * Optional. A function which returns displayable data when passed the following parameters:
+ * <div class="mdetail-params"><ul>
+ * <li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
+ * <li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
+ * <li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
+ * <li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container
+ * element <i>within</i> the table cell (e.g. 'style="color:red;"').</p></li></ul></p></li>
+ * <li><b>record</b> : Ext.data.record<p class="sub-desc">The {@link Ext.data.Record} from which the data was
+ * extracted.</p></li>
+ * <li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
+ * <li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
+ * <li><b>store</b> : Ext.data.Store<p class="sub-desc">The {@link Ext.data.Store} object from which the Record
+ * was extracted.</p></li>
+ * </ul></div>
+ * @property renderer
+ * @type Function
+ */
+ renderer : function(value){
+ return value;
+ },
+
+ // private
+ getEditor: function(rowIndex){
+ return this.editable !== false ? this.editor : null;
+ },
+
+ /**
+ * Sets a new editor for this column.
+ * @param {Ext.Editor/Ext.form.Field} editor The editor to set
+ */
+ setEditor : function(editor){
+ var ed = this.editor;
+ if(ed){
+ if(ed.gridEditor){
+ ed.gridEditor.destroy();
+ delete ed.gridEditor;
+ }else{
+ ed.destroy();
+ }
+ }
+ this.editor = null;
+ if(editor){
+ //not an instance, create it
+ if(!editor.isXType){
+ editor = Ext.create(editor, 'textfield');
+ }
+ this.editor = editor;
+ }
+ },
+
+ /**
+ * Returns the {@link Ext.Editor editor} defined for this column that was created to wrap the {@link Ext.form.Field Field}
+ * used to edit the cell.
+ * @param {Number} rowIndex The row index
+ * @return {Ext.Editor}
+ */
+ getCellEditor: function(rowIndex){
+ var ed = this.getEditor(rowIndex);
+ if(ed){
+ if(!ed.startEdit){
+ if(!ed.gridEditor){
+ ed.gridEditor = new Ext.grid.GridEditor(ed);
+ }
+ ed = ed.gridEditor;
+ }
+ }
+ return ed;
+ }
+});
+
+/**
+ * @class Ext.grid.BooleanColumn
+ * @extends Ext.grid.Column
+ * <p>A Column definition class which renders boolean data fields. See the {@link Ext.grid.Column#xtype xtype}
+ * config option of {@link Ext.grid.Column} for more details.</p>
+ */
+Ext.grid.BooleanColumn = Ext.extend(Ext.grid.Column, {
+ /**
+ * @cfg {String} trueText
+ * The string returned by the renderer when the column value is not falsy (defaults to <tt>'true'</tt>).
+ */
+ trueText: 'true',
+ /**
+ * @cfg {String} falseText
+ * The string returned by the renderer when the column value is falsy (but not undefined) (defaults to
+ * <tt>'false'</tt>).
+ */
+ falseText: 'false',
+ /**
+ * @cfg {String} undefinedText
+ * The string returned by the renderer when the column value is undefined (defaults to <tt>'&#160;'</tt>).
+ */
+ undefinedText: ' ',
+
+ constructor: function(cfg){
+ Ext.grid.BooleanColumn.superclass.constructor.call(this, cfg);
+ var t = this.trueText, f = this.falseText, u = this.undefinedText;
+ this.renderer = function(v){
+ if(v === undefined){
+ return u;
+ }
+ if(!v || v === 'false'){
+ return f;
+ }
+ return t;
+ };
+ }
+});
+
+/**
+ * @class Ext.grid.NumberColumn
+ * @extends Ext.grid.Column
+ * <p>A Column definition class which renders a numeric data field according to a {@link #format} string. See the
+ * {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column} for more details.</p>
+ */
+Ext.grid.NumberColumn = Ext.extend(Ext.grid.Column, {
+ /**
+ * @cfg {String} format
+ * A formatting string as used by {@link Ext.util.Format#number} to format a numeric value for this Column
+ * (defaults to <tt>'0,000.00'</tt>).
+ */
+ format : '0,000.00',
+ constructor: function(cfg){
+ Ext.grid.NumberColumn.superclass.constructor.call(this, cfg);
+ this.renderer = Ext.util.Format.numberRenderer(this.format);
+ }
+});
+
+/**
+ * @class Ext.grid.DateColumn
+ * @extends Ext.grid.Column
+ * <p>A Column definition class which renders a passed date according to the default locale, or a configured
+ * {@link #format}. See the {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column}
+ * for more details.</p>
+ */
+Ext.grid.DateColumn = Ext.extend(Ext.grid.Column, {
+ /**
+ * @cfg {String} format
+ * A formatting string as used by {@link Date#format} to format a Date for this Column
+ * (defaults to <tt>'m/d/Y'</tt>).
+ */
+ format : 'm/d/Y',
+ constructor: function(cfg){
+ Ext.grid.DateColumn.superclass.constructor.call(this, cfg);
+ this.renderer = Ext.util.Format.dateRenderer(this.format);
+ }
+});
+
+/**
+ * @class Ext.grid.TemplateColumn
+ * @extends Ext.grid.Column
+ * <p>A Column definition class which renders a value by processing a {@link Ext.data.Record Record}'s
+ * {@link Ext.data.Record#data data} using a {@link #tpl configured} {@link Ext.XTemplate XTemplate}.
+ * See the {@link Ext.grid.Column#xtype xtype} config option of {@link Ext.grid.Column} for more
+ * details.</p>
+ */
+Ext.grid.TemplateColumn = Ext.extend(Ext.grid.Column, {
+ /**
+ * @cfg {String/XTemplate} tpl
+ * An {@link Ext.XTemplate XTemplate}, or an XTemplate <i>definition string</i> to use to process a
+ * {@link Ext.data.Record Record}'s {@link Ext.data.Record#data data} to produce a column's rendered value.
+ */
+ constructor: function(cfg){
+ Ext.grid.TemplateColumn.superclass.constructor.call(this, cfg);
+ var tpl = (!Ext.isPrimitive(this.tpl) && this.tpl.compile) ? this.tpl : new Ext.XTemplate(this.tpl);
+ this.renderer = function(value, p, r){
+ return tpl.apply(r.data);
+ };
+ this.tpl = tpl;
+ }
+});
+
+/**
+ * @class Ext.grid.ActionColumn
+ * @extends Ext.grid.Column
+ * <p>A Grid column type which renders an icon, or a series of icons in a grid cell, and offers a scoped click
+ * handler for each icon. Example usage:</p>
+<pre><code>
+new Ext.grid.GridPanel({
+ store: myStore,
+ columns: [
+ {
+ xtype: 'actioncolumn',
+ width: 50,
+ items: [
+ {
+ icon : 'sell.gif', // Use a URL in the icon config
+ tooltip: 'Sell stock',
+ handler: function(grid, rowIndex, colIndex) {
+ var rec = store.getAt(rowIndex);
+ alert("Sell " + rec.get('company'));
+ }
+ },
+ {
+ getClass: function(v, meta, rec) { // Or return a class from a function
+ if (rec.get('change') < 0) {
+ this.items[1].tooltip = 'Do not buy!';
+ return 'alert-col';
+ } else {
+ this.items[1].tooltip = 'Buy stock';
+ return 'buy-col';
+ }
+ },
+ handler: function(grid, rowIndex, colIndex) {
+ var rec = store.getAt(rowIndex);
+ alert("Buy " + rec.get('company'));
+ }
+ }
+ ]
+ }
+ //any other columns here
+ ]
+});
+</pre></code>
+ * <p>The action column can be at any index in the columns array, and a grid can have any number of
+ * action columns. </p>
+ */
+Ext.grid.ActionColumn = Ext.extend(Ext.grid.Column, {
+ /**
+ * @cfg {String} icon
+ * The URL of an image to display as the clickable element in the column.
+ * Optional - defaults to <code>{@link Ext#BLANK_IMAGE_URL Ext.BLANK_IMAGE_URL}</code>.
+ */
+ /**
+ * @cfg {String} iconCls
+ * A CSS class to apply to the icon image. To determine the class dynamically, configure the Column with a <code>{@link #getClass}</code> function.
+ */
+ /**
+ * @cfg {Function} handler A function called when the icon is clicked.
+ * The handler is passed the following parameters:<div class="mdetail-params"><ul>
+ * <li><code>grid</code> : GridPanel<div class="sub-desc">The owning GridPanel.</div></li>
+ * <li><code>rowIndex</code> : Number<div class="sub-desc">The row index clicked on.</div></li>
+ * <li><code>colIndex</code> : Number<div class="sub-desc">The column index clicked on.</div></li>
+ * <li><code>item</code> : Object<div class="sub-desc">The clicked item (or this Column if multiple
+ * {@link #items} were not configured).</div></li>
+ * <li><code>e</code> : Event<div class="sub-desc">The click event.</div></li>
+ * </ul></div>
+ */
+ /**
+ * @cfg {Object} scope The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>
+ * and <code>{@link #getClass}</code> fuctions are executed. Defaults to this Column.
+ */
+ /**
+ * @cfg {String} tooltip A tooltip message to be displayed on hover. {@link Ext.QuickTips#init Ext.QuickTips} must have
+ * been initialized.
+ */
+ /**
+ * @cfg {Boolean} stopSelection Defaults to <code>true</code>. Prevent grid <i>row</i> selection upon mousedown.
+ */
+ /**
+ * @cfg {Function} getClass A function which returns the CSS class to apply to the icon image.
+ * The function is passed the following parameters:<div class="mdetail-params"><ul>
+ * <li><b>v</b> : Object<p class="sub-desc">The value of the column's configured field (if any).</p></li>
+ * <li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
+ * <li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
+ * <li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container element <i>within</i> the table cell
+ * (e.g. 'style="color:red;"').</p></li>
+ * </ul></p></li>
+ * <li><b>r</b> : Ext.data.Record<p class="sub-desc">The Record providing the data.</p></li>
+ * <li><b>rowIndex</b> : Number<p class="sub-desc">The row index..</p></li>
+ * <li><b>colIndex</b> : Number<p class="sub-desc">The column index.</p></li>
+ * <li><b>store</b> : Ext.data.Store<p class="sub-desc">The Store which is providing the data Model.</p></li>
+ * </ul></div>
+ */
+ /**
+ * @cfg {Array} items An Array which may contain multiple icon definitions, each element of which may contain:
+ * <div class="mdetail-params"><ul>
+ * <li><code>icon</code> : String<div class="sub-desc">The url of an image to display as the clickable element
+ * in the column.</div></li>
+ * <li><code>iconCls</code> : String<div class="sub-desc">A CSS class to apply to the icon image.
+ * To determine the class dynamically, configure the item with a <code>getClass</code> function.</div></li>
+ * <li><code>getClass</code> : Function<div class="sub-desc">A function which returns the CSS class to apply to the icon image.
+ * The function is passed the following parameters:<ul>
+ * <li><b>v</b> : Object<p class="sub-desc">The value of the column's configured field (if any).</p></li>
+ * <li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
+ * <li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
+ * <li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container element <i>within</i> the table cell
+ * (e.g. 'style="color:red;"').</p></li>
+ * </ul></p></li>
+ * <li><b>r</b> : Ext.data.Record<p class="sub-desc">The Record providing the data.</p></li>
+ * <li><b>rowIndex</b> : Number<p class="sub-desc">The row index..</p></li>
+ * <li><b>colIndex</b> : Number<p class="sub-desc">The column index.</p></li>
+ * <li><b>store</b> : Ext.data.Store<p class="sub-desc">The Store which is providing the data Model.</p></li>
+ * </ul></div></li>
+ * <li><code>handler</code> : Function<div class="sub-desc">A function called when the icon is clicked.</div></li>
+ * <li><code>scope</code> : Scope<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the
+ * <code>handler</code> and <code>getClass</code> functions are executed. Fallback defaults are this Column's
+ * configured scope, then this Column.</div></li>
+ * <li><code>tooltip</code> : String<div class="sub-desc">A tooltip message to be displayed on hover.
+ * {@link Ext.QuickTips#init Ext.QuickTips} must have been initialized.</div></li>
+ * </ul></div>
+ */
+ header: ' ',
+
+ actionIdRe: /x-action-col-(\d+)/,
+
+ /**
+ * @cfg {String} altText The alt text to use for the image element. Defaults to <tt>''</tt>.
+ */
+ altText: '',
+
+ constructor: function(cfg) {
+ var me = this,
+ items = cfg.items || (me.items = [me]),
+ l = items.length,
+ i,
+ item;
+
+ Ext.grid.ActionColumn.superclass.constructor.call(me, cfg);
+
+// Renderer closure iterates through items creating an <img> element for each and tagging with an identifying
+// class name x-action-col-{n}
+ me.renderer = function(v, meta) {
+// Allow a configured renderer to create initial value (And set the other values in the "metadata" argument!)
+ v = Ext.isFunction(cfg.renderer) ? cfg.renderer.apply(this, arguments)||'' : '';
+
+ meta.css += ' x-action-col-cell';
+ for (i = 0; i < l; i++) {
+ item = items[i];
+ v += '<img alt="' + me.altText + '" src="' + (item.icon || Ext.BLANK_IMAGE_URL) +
+ '" class="x-action-col-icon x-action-col-' + String(i) + ' ' + (item.iconCls || '') +
+ ' ' + (Ext.isFunction(item.getClass) ? item.getClass.apply(item.scope||this.scope||this, arguments) : '') + '"' +
+ ((item.tooltip) ? ' ext:qtip="' + item.tooltip + '"' : '') + ' />';
+ }
+ return v;
+ };
+ },
+
+ destroy: function() {
+ delete this.items;
+ delete this.renderer;
+ return Ext.grid.ActionColumn.superclass.destroy.apply(this, arguments);
+ },
+
+ /**
+ * @private
+ * Process and refire events routed from the GridView's processEvent method.
+ * Also fires any configured click handlers. By default, cancels the mousedown event to prevent selection.
+ * Returns the event handler's status to allow cancelling of GridView's bubbling process.
+ */
+ processEvent : function(name, e, grid, rowIndex, colIndex){
+ var m = e.getTarget().className.match(this.actionIdRe),
+ item, fn;
+ if (m && (item = this.items[parseInt(m[1], 10)])) {
+ if (name == 'click') {
+ (fn = item.handler || this.handler) && fn.call(item.scope||this.scope||this, grid, rowIndex, colIndex, item, e);
+ } else if ((name == 'mousedown') && (item.stopSelection !== false)) {
+ return false;
+ }
+ }
+ return Ext.grid.ActionColumn.superclass.processEvent.apply(this, arguments);
+ }
+});
+
+/*
+ * @property types
+ * @type Object
+ * @member Ext.grid.Column
+ * @static
+ * <p>An object containing predefined Column classes keyed by a mnemonic code which may be referenced
+ * by the {@link Ext.grid.ColumnModel#xtype xtype} config option of ColumnModel.</p>
+ * <p>This contains the following properties</p><div class="mdesc-details"><ul>
+ * <li>gridcolumn : <b>{@link Ext.grid.Column Column constructor}</b></li>
+ * <li>booleancolumn : <b>{@link Ext.grid.BooleanColumn BooleanColumn constructor}</b></li>
+ * <li>numbercolumn : <b>{@link Ext.grid.NumberColumn NumberColumn constructor}</b></li>
+ * <li>datecolumn : <b>{@link Ext.grid.DateColumn DateColumn constructor}</b></li>
+ * <li>templatecolumn : <b>{@link Ext.grid.TemplateColumn TemplateColumn constructor}</b></li>
+ * </ul></div>
+ */
+Ext.grid.Column.types = {
+ gridcolumn : Ext.grid.Column,
+ booleancolumn: Ext.grid.BooleanColumn,
+ numbercolumn: Ext.grid.NumberColumn,
+ datecolumn: Ext.grid.DateColumn,
+ templatecolumn: Ext.grid.TemplateColumn,
+ actioncolumn: Ext.grid.ActionColumn
};/**
* @class Ext.grid.RowNumberer
* This is a utility class that can be passed into a {@link Ext.grid.ColumnModel} as a column config that provides
* @constructor
* @param {Object} config The configuration options
*/
-Ext.grid.RowNumberer = function(config){
- Ext.apply(this, config);
- if(this.rowspan){
- this.renderer = this.renderer.createDelegate(this);
- }
-};
-
-Ext.grid.RowNumberer.prototype = {
+Ext.grid.RowNumberer = Ext.extend(Object, {
/**
* @cfg {String} header Any valid text or HTML fragment to display in the header cell for the row
* number column (defaults to '').
* @hide
*/
sortable: false,
+
+ constructor : function(config){
+ Ext.apply(this, config);
+ if(this.rowspan){
+ this.renderer = this.renderer.createDelegate(this);
+ }
+ },
// private
fixed:true,
+ hideable: false,
menuDisabled:true,
dataIndex: '',
id: 'numberer',
}
return rowIndex+1;
}
-};/**\r
- * @class Ext.grid.CheckboxSelectionModel\r
- * @extends Ext.grid.RowSelectionModel\r
- * A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.\r
- * @constructor\r
- * @param {Object} config The configuration options\r
- */\r
-Ext.grid.CheckboxSelectionModel = Ext.extend(Ext.grid.RowSelectionModel, {\r
-\r
- /**\r
- * @cfg {Boolean} checkOnly <tt>true</tt> if rows can only be selected by clicking on the\r
- * checkbox column (defaults to <tt>false</tt>).\r
- */\r
- /**\r
- * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the\r
- * checkbox column. Defaults to:<pre><code>\r
- * '<div class="x-grid3-hd-checker">&#160;</div>'</tt>\r
- * </code></pre>\r
- * The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header\r
- * and provides support for automatic check all/none behavior on header click. This string\r
- * can be replaced by any valid HTML fragment, including a simple text string (e.g.,\r
- * <tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the\r
- * <tt>'x-grid3-hd-checker'</tt> class is supplied.\r
- */\r
- header : '<div class="x-grid3-hd-checker"> </div>',\r
- /**\r
- * @cfg {Number} width The default width in pixels of the checkbox column (defaults to <tt>20</tt>).\r
- */\r
- width : 20,\r
- /**\r
- * @cfg {Boolean} sortable <tt>true</tt> if the checkbox column is sortable (defaults to\r
- * <tt>false</tt>).\r
- */\r
- sortable : false,\r
-\r
- // private\r
- menuDisabled : true,\r
- fixed : true,\r
- dataIndex : '',\r
- id : 'checker',\r
-\r
- constructor : function(){\r
- Ext.grid.CheckboxSelectionModel.superclass.constructor.apply(this, arguments);\r
-\r
- if(this.checkOnly){\r
- this.handleMouseDown = Ext.emptyFn;\r
- }\r
- },\r
-\r
- // private\r
- initEvents : function(){\r
- Ext.grid.CheckboxSelectionModel.superclass.initEvents.call(this);\r
- this.grid.on('render', function(){\r
- var view = this.grid.getView();\r
- view.mainBody.on('mousedown', this.onMouseDown, this);\r
- Ext.fly(view.innerHd).on('mousedown', this.onHdMouseDown, this);\r
-\r
- }, this);\r
- },\r
-\r
- // private\r
- onMouseDown : function(e, t){\r
- if(e.button === 0 && t.className == 'x-grid3-row-checker'){ // Only fire if left-click\r
- e.stopEvent();\r
- var row = e.getTarget('.x-grid3-row');\r
- if(row){\r
- var index = row.rowIndex;\r
- if(this.isSelected(index)){\r
- this.deselectRow(index);\r
- }else{\r
- this.selectRow(index, true);\r
- }\r
- }\r
- }\r
- },\r
-\r
- // private\r
- onHdMouseDown : function(e, t){\r
- if(t.className == 'x-grid3-hd-checker'){\r
- e.stopEvent();\r
- var hd = Ext.fly(t.parentNode);\r
- var isChecked = hd.hasClass('x-grid3-hd-checker-on');\r
- if(isChecked){\r
- hd.removeClass('x-grid3-hd-checker-on');\r
- this.clearSelections();\r
- }else{\r
- hd.addClass('x-grid3-hd-checker-on');\r
- this.selectAll();\r
- }\r
- }\r
- },\r
-\r
- // private\r
- renderer : function(v, p, record){\r
- return '<div class="x-grid3-row-checker"> </div>';\r
- }\r
+});/**
+ * @class Ext.grid.CheckboxSelectionModel
+ * @extends Ext.grid.RowSelectionModel
+ * A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.
+ * @constructor
+ * @param {Object} config The configuration options
+ */
+Ext.grid.CheckboxSelectionModel = Ext.extend(Ext.grid.RowSelectionModel, {
+
+ /**
+ * @cfg {Boolean} checkOnly <tt>true</tt> if rows can only be selected by clicking on the
+ * checkbox column (defaults to <tt>false</tt>).
+ */
+ /**
+ * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the
+ * checkbox column. Defaults to:<pre><code>
+ * '<div class="x-grid3-hd-checker">&#160;</div>'</tt>
+ * </code></pre>
+ * The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header
+ * and provides support for automatic check all/none behavior on header click. This string
+ * can be replaced by any valid HTML fragment, including a simple text string (e.g.,
+ * <tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the
+ * <tt>'x-grid3-hd-checker'</tt> class is supplied.
+ */
+ header : '<div class="x-grid3-hd-checker"> </div>',
+ /**
+ * @cfg {Number} width The default width in pixels of the checkbox column (defaults to <tt>20</tt>).
+ */
+ width : 20,
+ /**
+ * @cfg {Boolean} sortable <tt>true</tt> if the checkbox column is sortable (defaults to
+ * <tt>false</tt>).
+ */
+ sortable : false,
+
+ // private
+ menuDisabled : true,
+ fixed : true,
+ hideable: false,
+ dataIndex : '',
+ id : 'checker',
+ isColumn: true, // So that ColumnModel doesn't feed this through the Column constructor
+
+ constructor : function(){
+ Ext.grid.CheckboxSelectionModel.superclass.constructor.apply(this, arguments);
+ if(this.checkOnly){
+ this.handleMouseDown = Ext.emptyFn;
+ }
+ },
+
+ // private
+ initEvents : function(){
+ Ext.grid.CheckboxSelectionModel.superclass.initEvents.call(this);
+ this.grid.on('render', function(){
+ Ext.fly(this.grid.getView().innerHd).on('mousedown', this.onHdMouseDown, this);
+ }, this);
+ },
+
+ /**
+ * @private
+ * Process and refire events routed from the GridView's processEvent method.
+ */
+ processEvent : function(name, e, grid, rowIndex, colIndex){
+ if (name == 'mousedown') {
+ this.onMouseDown(e, e.getTarget());
+ return false;
+ } else {
+ return Ext.grid.Column.prototype.processEvent.apply(this, arguments);
+ }
+ },
+
+ // private
+ onMouseDown : function(e, t){
+ if(e.button === 0 && t.className == 'x-grid3-row-checker'){ // Only fire if left-click
+ e.stopEvent();
+ var row = e.getTarget('.x-grid3-row');
+ if(row){
+ var index = row.rowIndex;
+ if(this.isSelected(index)){
+ this.deselectRow(index);
+ }else{
+ this.selectRow(index, true);
+ this.grid.getView().focusRow(index);
+ }
+ }
+ }
+ },
+
+ // private
+ onHdMouseDown : function(e, t) {
+ if(t.className == 'x-grid3-hd-checker'){
+ e.stopEvent();
+ var hd = Ext.fly(t.parentNode);
+ var isChecked = hd.hasClass('x-grid3-hd-checker-on');
+ if(isChecked){
+ hd.removeClass('x-grid3-hd-checker-on');
+ this.clearSelections();
+ }else{
+ hd.addClass('x-grid3-hd-checker-on');
+ this.selectAll();
+ }
+ }
+ },
+
+ // private
+ renderer : function(v, p, record){
+ return '<div class="x-grid3-row-checker"> </div>';
+ },
+
+ onEditorSelect: function(row, lastRow){
+ if(lastRow != row && !this.checkOnly){
+ this.selectRow(row); // *** highlight newly-selected cell and update selection
+ }
+ }
});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff