Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / src / widgets / grid / GridPanel.js
index 9a08132..2af5bc1 100644 (file)
@@ -1,5 +1,5 @@
 /*!
- * Ext JS Library 3.0.0
+ * Ext JS Library 3.1.0
  * Copyright(c) 2006-2009 Ext JS, LLC
  * licensing@extjs.com
  * http://www.extjs.com/license
  * <p>Example usage:</p>\r
  * <pre><code>\r
 var grid = new Ext.grid.GridPanel({\r
-    {@link #store}: new (@link Ext.data.Store}({\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 #columns}: [\r
-        {id: 'company', header: 'Company', width: 200, sortable: true, dataIndex: 'company'},\r
-        {header: 'Price', width: 120, sortable: true, renderer: Ext.util.Format.usMoney, dataIndex: 'price'},\r
-        {header: 'Change', width: 120, sortable: true, dataIndex: 'change'},\r
-        {header: '% Change', width: 120, sortable: true, dataIndex: 'pctChange'},\r
-        // instead of specifying renderer: Ext.util.Format.dateRenderer('m/d/Y') use xtype\r
-        {header: 'Last Updated', width: 135, sortable: true, dataIndex: 'lastChange', xtype: 'datecolumn', format: 'M d, Y'}\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
@@ -140,7 +149,9 @@ Ext.grid.GridPanel = Ext.extend(Ext.Panel, {
      * @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 Defaults to <tt>true</tt> to enable hiding of columns with the header context menu.\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
@@ -219,6 +230,15 @@ Ext.grid.GridPanel = Ext.extend(Ext.Panel, {
      * 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
+     * See {@link Ext.util.Observable#enableBubble}. \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
@@ -345,6 +365,33 @@ Ext.grid.GridPanel = Ext.extend(Ext.Panel, {
              * @param {Ext.EventObject} e\r
              */\r
             'headermousedown',\r
+            \r
+            /**\r
+             * @event groupmousedown\r
+             * Fires before a group header is clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.\r
+             * @param {Grid} this\r
+             * @param {String} groupField\r
+             * @param {String} groupValue\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'groupmousedown',\r
+            \r
+            /**\r
+             * @event rowbodymousedown\r
+             * Fires before the row body is clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>\r
+             * @param {Grid} this\r
+             * @param {Number} rowIndex\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'rowbodymousedown',\r
+            \r
+            /**\r
+             * @event containermousedown\r
+             * Fires before the container is clicked. The container consists of any part of the grid body that is not covered by a row.\r
+             * @param {Grid} this\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'containermousedown',\r
 \r
             /**\r
              * @event cellclick\r
@@ -406,6 +453,56 @@ function(grid, rowIndex, columnIndex, e) {
              * @param {Ext.EventObject} e\r
              */\r
             'headerdblclick',\r
+            /**\r
+             * @event groupclick\r
+             * Fires when group header is clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.\r
+             * @param {Grid} this\r
+             * @param {String} groupField\r
+             * @param {String} groupValue\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'groupclick',\r
+            /**\r
+             * @event groupdblclick\r
+             * Fires when group header is double clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.\r
+             * @param {Grid} this\r
+             * @param {String} groupField\r
+             * @param {String} groupValue\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'groupdblclick',\r
+            /**\r
+             * @event containerclick\r
+             * Fires when the container is clicked. The container consists of any part of the grid body that is not covered by a row.\r
+             * @param {Grid} this\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'containerclick',\r
+            /**\r
+             * @event containerdblclick\r
+             * Fires when the container is double clicked. The container consists of any part of the grid body that is not covered by a row.\r
+             * @param {Grid} this\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'containerdblclick',\r
+            \r
+            /**\r
+             * @event rowbodyclick\r
+             * Fires when the row body is clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>\r
+             * @param {Grid} this\r
+             * @param {Number} rowIndex\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'rowbodyclick',\r
+            /**\r
+             * @event rowbodydblclick\r
+             * Fires when the row body is double clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>\r
+             * @param {Grid} this\r
+             * @param {Number} rowIndex\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'rowbodydblclick',\r
+            \r
             /**\r
              * @event rowcontextmenu\r
              * Fires when a row is right clicked\r
@@ -431,6 +528,30 @@ function(grid, rowIndex, columnIndex, e) {
              * @param {Ext.EventObject} e\r
              */\r
             'headercontextmenu',\r
+            /**\r
+             * @event groupcontextmenu\r
+             * Fires when group header is right clicked. <b>Only applies for grids with a {@link Ext.grid.GroupingView GroupingView}</b>.\r
+             * @param {Grid} this\r
+             * @param {String} groupField\r
+             * @param {String} groupValue\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'groupcontextmenu',\r
+            /**\r
+             * @event containercontextmenu\r
+             * Fires when the container is right clicked. The container consists of any part of the grid body that is not covered by a row.\r
+             * @param {Grid} this\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'containercontextmenu',\r
+            /**\r
+             * @event rowbodycontextmenu\r
+             * Fires when the row body is right clicked. <b>Only applies for grids with {@link Ext.grid.GridView#enableRowBody enableRowBody} configured.</b>\r
+             * @param {Grid} this\r
+             * @param {Number} rowIndex\r
+             * @param {Ext.EventObject} e\r
+             */\r
+            'rowbodycontextmenu',\r
             /**\r
              * @event bodyscroll\r
              * Fires when the body element is scrolled\r
@@ -466,7 +587,13 @@ function(grid, rowIndex, columnIndex, e) {
              * @param {Ext.data.Store} store The new store\r
              * @param {Ext.grid.ColumnModel} colModel The new column model\r
              */\r
-            'reconfigure'\r
+            'reconfigure',\r
+            /**\r
+             * @event viewready\r
+             * Fires when the grid view is available (use this for selecting a default row). \r
+             * @param {Grid} this\r
+             */\r
+            'viewready'\r
         );\r
     },\r
 \r
@@ -474,26 +601,24 @@ function(grid, rowIndex, columnIndex, e) {
     onRender : function(ct, position){\r
         Ext.grid.GridPanel.superclass.onRender.apply(this, arguments);\r
 \r
-        var c = this.body;\r
+        var c = this.getGridEl();\r
 \r
         this.el.addClass('x-grid-panel');\r
 \r
-        var view = this.getView();\r
-        view.init(this);\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
-            keydown: this.onKeyDown,\r
-            scope: this\r
+            contextmenu: this.onContextMenu\r
         });\r
 \r
-        this.relayEvents(c, ['mousedown','mouseup','mouseover','mouseout','keypress']);\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
-        this.view.render();\r
     },\r
 \r
     // private\r
@@ -512,12 +637,12 @@ function(grid, rowIndex, columnIndex, e) {
     },\r
 \r
     applyState : function(state){\r
-        var cm = this.colModel;\r
-        var cs = state.columns;\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
+                var s = cs[i],\r
+                    c = cm.getColumnById(s.id);\r
                 if(c){\r
                     c.hidden = s.hidden;\r
                     c.width = s.width;\r
@@ -531,9 +656,10 @@ function(grid, rowIndex, columnIndex, e) {
         if(state.sort && this.store){\r
             this.store[this.store.remoteSort ? 'setDefaultSort' : 'sort'](state.sort.field, state.sort.direction);\r
         }\r
-        delete state.columns;\r
-        delete state.sort;\r
-        Ext.grid.GridPanel.superclass.applyState.call(this, state);\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
@@ -559,11 +685,13 @@ function(grid, rowIndex, columnIndex, e) {
     // private\r
     afterRender : function(){\r
         Ext.grid.GridPanel.superclass.afterRender.call(this);\r
-        this.view.layout();\r
+        var v = this.view;\r
+        this.on('bodyresize', v.layout, v);\r
+        v.layout();\r
         if(this.deferRowRender){\r
-            this.view.afterRender.defer(10, this.view);\r
+            v.afterRender.defer(10, this.view);\r
         }else{\r
-            this.view.afterRender();\r
+            v.afterRender();\r
         }\r
         this.viewReady = true;\r
     },\r
@@ -581,31 +709,28 @@ function(grid, rowIndex, columnIndex, e) {
      * @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
+        var rendered = this.rendered;\r
+        if(rendered){\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
+        }\r
+        if(this.view){\r
+            this.view.initData(store, colModel);\r
         }\r
-        this.view.initData(store, colModel);\r
         this.store = store;\r
         this.colModel = colModel;\r
-        if(this.rendered){\r
+        if(rendered){\r
             this.view.refresh(true);\r
         }\r
         this.fireEvent('reconfigure', this, store, colModel);\r
     },\r
 \r
-    // private\r
-    onKeyDown : function(e){\r
-        this.fireEvent('keydown', e);\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
@@ -618,21 +743,31 @@ function(grid, rowIndex, columnIndex, e) {
     // 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
+        var t = e.getTarget(),\r
+            v = this.view,\r
+            header = v.findHeaderIndex(t);\r
+            \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
+            var row = v.findRowIndex(t),\r
+                cell,\r
+                body;\r
             if(row !== false){\r
                 this.fireEvent('row' + name, this, row, e);\r
+                cell = v.findCellIndex(t);\r
+                body = v.findRowBody(t);\r
                 if(cell !== false){\r
                     this.fireEvent('cell' + name, this, row, cell, e);\r
                 }\r
+                if(body){\r
+                    this.fireEvent('rowbody' + name, this, row, e);\r
+                }\r
+            }else{\r
+                this.fireEvent('container' + name, this, e);\r
             }\r
         }\r
+        this.view.processEvent(name, e);\r
     },\r
 \r
     // private\r
@@ -657,8 +792,11 @@ function(grid, rowIndex, columnIndex, e) {
 \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
+        var cm = this.colModel, \r
+            clen = cm.getColumnCount(),\r
+            ds = this.store, \r
+            rlen = ds.getCount(), \r
+            first = true;\r
         if(step < 0){\r
             if(col < 0){\r
                 row--;\r
@@ -876,7 +1014,7 @@ function(grid, rowIndex, columnIndex, e) {
      * @hide \r
      */\r
     /** \r
-     * @event afterLayout \r
+     * @event afterlayout \r
      * @hide \r
      */\r
     /** \r