Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / Grouping.html
index 2368eb6..a984ce9 100644 (file)
@@ -1,4 +1,21 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-grid.feature.Grouping'>/**
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-grid-feature-Grouping'>/**
 </span> * @class Ext.grid.feature.Grouping
  * @extends Ext.grid.feature.Feature
  * 
@@ -46,59 +63,54 @@ Ext.define('Ext.grid.feature.Grouping', {
         this.callParent(arguments);
     },
     
-<span id='Ext-grid.feature.Grouping-event-groupclick'>    /**
+<span id='Ext-grid-feature-Grouping-event-groupclick'>    /**
 </span>     * @event groupclick
      * @param {Ext.view.Table} view
      * @param {HTMLElement} node
-     * @param {Number} unused
-     * @param {Number} unused
+     * @param {String} group The name of the group
      * @param {Ext.EventObject} e
      */
 
-<span id='Ext-grid.feature.Grouping-event-groupdblclick'>    /**
+<span id='Ext-grid-feature-Grouping-event-groupdblclick'>    /**
 </span>     * @event groupdblclick
      * @param {Ext.view.Table} view
      * @param {HTMLElement} node
-     * @param {Number} unused
-     * @param {Number} unused
+     * @param {String} group The name of the group
      * @param {Ext.EventObject} e
      */
 
-<span id='Ext-grid.feature.Grouping-event-groupcontextmenu'>    /**
+<span id='Ext-grid-feature-Grouping-event-groupcontextmenu'>    /**
 </span>     * @event groupcontextmenu
      * @param {Ext.view.Table} view
      * @param {HTMLElement} node
-     * @param {Number} unused
-     * @param {Number} unused
+     * @param {String} group The name of the group
      * @param {Ext.EventObject} e
      */
 
-<span id='Ext-grid.feature.Grouping-event-groupcollapse'>    /**
+<span id='Ext-grid-feature-Grouping-event-groupcollapse'>    /**
 </span>     * @event groupcollapse
      * @param {Ext.view.Table} view
      * @param {HTMLElement} node
-     * @param {Number} unused
-     * @param {Number} unused
+     * @param {String} group The name of the group
      * @param {Ext.EventObject} e
      */
 
-<span id='Ext-grid.feature.Grouping-event-groupexpand'>    /**
+<span id='Ext-grid-feature-Grouping-event-groupexpand'>    /**
 </span>     * @event groupexpand
      * @param {Ext.view.Table} view
      * @param {HTMLElement} node
-     * @param {Number} unused
-     * @param {Number} unused
+     * @param {String} group The name of the group
      * @param {Ext.EventObject} e
      */
 
-<span id='Ext-grid.feature.Grouping-cfg-groupHeaderTpl'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-groupHeaderTpl'>    /**
 </span>     * @cfg {String} groupHeaderTpl
      * Template snippet, this cannot be an actual template. {name} will be replaced with the current group.
      * Defaults to 'Group: {name}'
      */
     groupHeaderTpl: 'Group: {name}',
 
-<span id='Ext-grid.feature.Grouping-cfg-depthToIndent'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-depthToIndent'>    /**
 </span>     * @cfg {Number} depthToIndent
      * Number of pixels to indent per grouping level
      */
@@ -107,33 +119,33 @@ Ext.define('Ext.grid.feature.Grouping', {
     collapsedCls: Ext.baseCSSPrefix + 'grid-group-collapsed',
     hdCollapsedCls: Ext.baseCSSPrefix + 'grid-group-hd-collapsed',
 
-<span id='Ext-grid.feature.Grouping-cfg-groupByText'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-groupByText'>    /**
 </span>     * @cfg {String} groupByText Text displayed in the grid header menu for grouping by header
      * (defaults to 'Group By This Field').
      */
     groupByText : 'Group By This Field',
-<span id='Ext-grid.feature.Grouping-cfg-showGroupsText'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-showGroupsText'>    /**
 </span>     * @cfg {String} showGroupsText Text displayed in the grid header for enabling/disabling grouping
      * (defaults to 'Show in Groups').
      */
     showGroupsText : 'Show in Groups',
 
-<span id='Ext-grid.feature.Grouping-cfg-hideGroupedHeader'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-hideGroupedHeader'>    /**
 </span>     * @cfg {Boolean} hideGroupedHeader&lt;tt&gt;true&lt;/tt&gt; to hide the header that is currently grouped (defaults to &lt;tt&gt;false&lt;/tt&gt;)
      */
     hideGroupedHeader : false,
 
-<span id='Ext-grid.feature.Grouping-cfg-startCollapsed'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-startCollapsed'>    /**
 </span>     * @cfg {Boolean} startCollapsed &lt;tt&gt;true&lt;/tt&gt; to start all groups collapsed (defaults to &lt;tt&gt;false&lt;/tt&gt;)
      */
     startCollapsed : false,
 
-<span id='Ext-grid.feature.Grouping-cfg-enableGroupingMenu'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-enableGroupingMenu'>    /**
 </span>     * @cfg {Boolean} enableGroupingMenu &lt;tt&gt;true&lt;/tt&gt; to enable the grouping control in the header menu (defaults to &lt;tt&gt;true&lt;/tt&gt;)
      */
     enableGroupingMenu : true,
 
-<span id='Ext-grid.feature.Grouping-cfg-enableNoGroups'>    /**
+<span id='Ext-grid-feature-Grouping-cfg-enableNoGroups'>    /**
 </span>     * @cfg {Boolean} enableNoGroups &lt;tt&gt;true&lt;/tt&gt; to allow the user to turn off grouping (defaults to &lt;tt&gt;true&lt;/tt&gt;)
      */
     enableNoGroups : true,
@@ -261,7 +273,7 @@ Ext.define('Ext.grid.feature.Grouping', {
             showGroupsText     = me.showGroupsText,
             enableNoGroups     = me.enableNoGroups,
             groupMenuItemClick = Ext.Function.bind(me.onGroupMenuItemClick, me),
-            groupToggleMenuItemClick = Ext.Function.bind(me.onGroupToggleMenuItemClick, me)
+            groupToggleMenuItemClick = Ext.Function.bind(me.onGroupToggleMenuItemClick, me);
         
         // runs in the scope of headerCt
         return function() {
@@ -284,7 +296,7 @@ Ext.define('Ext.grid.feature.Grouping', {
     },
 
 
-<span id='Ext-grid.feature.Grouping-method-onGroupMenuItemClick'>    /**
+<span id='Ext-grid-feature-Grouping-method-onGroupMenuItemClick'>    /**
 </span>     * Group by the header the user has clicked on.
      * @private
      */
@@ -300,7 +312,7 @@ Ext.define('Ext.grid.feature.Grouping', {
         
     },
 
-<span id='Ext-grid.feature.Grouping-method-onGroupToggleMenuItemClick'>    /**
+<span id='Ext-grid-feature-Grouping-method-onGroupToggleMenuItemClick'>    /**
 </span>     * Turn on and off grouping via the menu
      * @private
      */
@@ -308,7 +320,7 @@ Ext.define('Ext.grid.feature.Grouping', {
         this[checked ? 'enable' : 'disable']();
     },
 
-<span id='Ext-grid.feature.Grouping-method-pruneGroupedHeader'>    /**
+<span id='Ext-grid-feature-Grouping-method-pruneGroupedHeader'>    /**
 </span>     * Prunes the grouped header from the header container
      * @private
      */
@@ -337,7 +349,7 @@ Ext.define('Ext.grid.feature.Grouping', {
         return ''; 
     },
 
-<span id='Ext-grid.feature.Grouping-method-onRowFocus'>    /**
+<span id='Ext-grid-feature-Grouping-method-onRowFocus'>    /**
 </span>     * When a row gains focus, expand the groups above it
      * @private
      */
@@ -352,7 +364,7 @@ Ext.define('Ext.grid.feature.Grouping', {
         }
     },
 
-<span id='Ext-grid.feature.Grouping-method-expand'>    /**
+<span id='Ext-grid-feature-Grouping-method-expand'>    /**
 </span>     * Expand a group by the groupBody
      * @param {Ext.core.Element} groupBd
      * @private
@@ -373,7 +385,7 @@ Ext.define('Ext.grid.feature.Grouping', {
         view.fireEvent('groupexpand');
     },
 
-<span id='Ext-grid.feature.Grouping-method-collapse'>    /**
+<span id='Ext-grid-feature-Grouping-method-collapse'>    /**
 </span>     * Collapse a group by the groupBody
      * @param {Ext.core.Element} groupBd
      * @private
@@ -398,7 +410,7 @@ Ext.define('Ext.grid.feature.Grouping', {
         this.view.refresh();
     },
 
-<span id='Ext-grid.feature.Grouping-method-onGroupClick'>    /**
+<span id='Ext-grid-feature-Grouping-method-onGroupClick'>    /**
 </span>     * Toggle between expanded/collapsed state when clicking on
      * the group.
      * @private
@@ -504,16 +516,18 @@ Ext.define('Ext.grid.feature.Grouping', {
     // events that are fired on the view. Chose not to return the actual
     // group itself because of its expense and because developers can simply
     // grab the group via store.getGroups(groupName)
-    getFireEventArgs: function(type, view, featureTarget) {
+    getFireEventArgs: function(type, view, featureTarget, e) {
         var returnArray = [type, view, featureTarget],
             groupBd     = Ext.fly(featureTarget.nextSibling, '_grouping'),
             groupBdId   = Ext.getDom(groupBd).id,
             prefix      = view.id + '-gp-',
             groupName   = groupBdId.substr(prefix.length);
         
-        returnArray.push(groupName);
+        returnArray.push(groupName, e);
         
         return returnArray;
     }
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>