source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.grid.GroupingView.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 67.4 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.grid.GroupingView-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.grid.GroupingView-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.grid.GroupingView-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                            <a class="inner-link" href="#Ext.grid.GroupingView-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                        <a class="bookmark" href="../docs/?class=Ext.grid.GroupingView"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8        </div>
9                <div class="inheritance res-block">
10<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11  <img src="resources/elbow-end.gif"/><a ext:cls="Ext.grid.GridView" ext:member="" href="output/Ext.grid.GridView.html">GridView</a>
12    <img src="resources/elbow-end.gif"/>GroupingView</pre></div>
13                <h1>Class Ext.grid.GroupingView</h1>
14        <table cellspacing="0">
15            <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
16            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/GroupingView.js" target="_blank">GroupingView.js</a></td></tr>
17            <tr><td class="label">Class:</td><td class="hd-info">GroupingView</td></tr>
18                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.grid.GridView" ext:member="" href="output/Ext.grid.GridView.html">GridView</a></td></tr>
19                    </table>
20        <div class="description">
21            *
22Adds the ability for single level grouping to the grid.
23<pre><code>var grid = <b>new</b> Ext.grid.GridPanel({
24    <i>// A groupingStore is required <b>for</b> a GroupingView</i>
25    store: <b>new</b> Ext.data.GroupingStore({
26        reader: reader,
27        data: xg.dummyData,
28        sortInfo:{field: <em>'company'</em>, direction: <em>"ASC"</em>},
29        groupField:<em>'industry'</em>
30    }),
31
32    columns: [
33        {id:<em>'company'</em>,header: <em>"Company"</em>, width: 60, sortable: true, dataIndex: <em>'company'</em>},
34        {header: <em>"Price"</em>, width: 20, sortable: true, renderer: Ext.util.Format.usMoney, dataIndex: <em>'price'</em>},
35        {header: <em>"Change"</em>, width: 20, sortable: true, dataIndex: <em>'change'</em>, renderer: Ext.util.Format.usMoney},
36        {header: <em>"Industry"</em>, width: 20, sortable: true, dataIndex: <em>'industry'</em>},
37        {header: <em>"Last Updated"</em>, width: 20, sortable: true, renderer: Ext.util.Format.dateRenderer(<em>'m/d/Y'</em>), dataIndex: <em>'lastChange'</em>}
38    ],
39
40    view: <b>new</b> Ext.grid.GroupingView({
41        forceFit:true,
42        <i>// custom grouping text template to display the number of items per group</i>
43        groupTextTpl: <em>'{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'</em>
44    }),
45
46    frame:true,
47    width: 700,
48    height: 450,
49    collapsible: true,
50    animCollapse: false,
51    title: <em>'Grouping Example'</em>,
52    iconCls: <em>'icon-grid'</em>,
53    renderTo: document.body
54});</code></pre>        </div>
55       
56        <div class="hr"></div>
57                <a id="Ext.grid.GroupingView-configs"></a>
58        <h2>Config Options</h2>
59        <table cellspacing="0" class="member-table">
60            <tr>
61                <th class="sig-header" colspan="2">Config Options</th>
62                <th class="msource-header">Defined By</th>
63            </tr>
64                <tr class="config-row inherited">
65        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
66        <td class="sig">
67        <a id="Ext.grid.GroupingView-autoFill"></a>
68            <b>autoFill</b> : Boolean            <div class="mdesc">
69                            True to auto expand the columns to fit the grid <b>when the grid is created</b>.                        </div>
70        </td>
71        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#autoFill" href="output/Ext.grid.GridView.html#autoFill">GridView</a></td>
72    </tr>
73        <tr class="config-row inherited alt">
74        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
75        <td class="sig">
76        <a id="Ext.grid.GroupingView-cellSelector"></a>
77            <b>cellSelector</b> : String            <div class="mdesc">
78                            The selector used to find cells internally                        </div>
79        </td>
80        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#cellSelector" href="output/Ext.grid.GridView.html#cellSelector">GridView</a></td>
81    </tr>
82        <tr class="config-row inherited">
83        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
84        <td class="sig">
85        <a id="Ext.grid.GroupingView-cellSelectorDepth"></a>
86            <b>cellSelectorDepth</b> : Number            <div class="mdesc">
87                            The number of levels to search for cells in event delegation (defaults to 4)                        </div>
88        </td>
89        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#cellSelectorDepth" href="output/Ext.grid.GridView.html#cellSelectorDepth">GridView</a></td>
90    </tr>
91        <tr class="config-row inherited alt">
92        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
93        <td class="sig">
94        <a id="Ext.grid.GroupingView-deferEmptyText"></a>
95            <b>deferEmptyText</b> : Boolean            <div class="mdesc">
96                            True to defer emptyText being applied until the store's first load                        </div>
97        </td>
98        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#deferEmptyText" href="output/Ext.grid.GridView.html#deferEmptyText">GridView</a></td>
99    </tr>
100        <tr class="config-row">
101        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
102        <td class="sig">
103        <a id="Ext.grid.GroupingView-emptyGroupText"></a>
104            <b>emptyGroupText</b> : String            <div class="mdesc">
105                            The text to display when there is an empty group value                        </div>
106        </td>
107        <td class="msource">GroupingView</td>
108    </tr>
109        <tr class="config-row inherited alt">
110        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
111        <td class="sig">
112        <a id="Ext.grid.GroupingView-emptyText"></a>
113            <b>emptyText</b> : String            <div class="mdesc">
114                            Default text to display in the grid body when no rows are available (defaults to '').                        </div>
115        </td>
116        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#emptyText" href="output/Ext.grid.GridView.html#emptyText">GridView</a></td>
117    </tr>
118        <tr class="config-row">
119        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
120        <td class="sig">
121        <a id="Ext.grid.GroupingView-enableGrouping"></a>
122            <b>enableGrouping</b> : Boolean            <div class="mdesc">
123                            False to disable grouping functionality (defaults to true)                        </div>
124        </td>
125        <td class="msource">GroupingView</td>
126    </tr>
127        <tr class="config-row alt">
128        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
129        <td class="sig">
130        <a id="Ext.grid.GroupingView-enableGroupingMenu"></a>
131            <b>enableGroupingMenu</b> : Boolean            <div class="mdesc">
132                            True to enable the grouping control in the column menu                        </div>
133        </td>
134        <td class="msource">GroupingView</td>
135    </tr>
136        <tr class="config-row">
137        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
138        <td class="sig">
139        <a id="Ext.grid.GroupingView-enableNoGroups"></a>
140            <b>enableNoGroups</b> : Boolean            <div class="mdesc">
141                            True to allow the user to turn off grouping                        </div>
142        </td>
143        <td class="msource">GroupingView</td>
144    </tr>
145        <tr class="config-row inherited alt expandable">
146        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
147        <td class="sig">
148        <a id="Ext.grid.GroupingView-enableRowBody"></a>
149            <b>enableRowBody</b> : Boolean            <div class="mdesc">
150                        <div class="short">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 t...</div>
151            <div class="long">
152                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 <a ext:cls="Ext.grid.GridView" ext:member="getRowClass" href="output/Ext.grid.GridView.html#getRowClass">getRowClass</a> method's rowParams config to customize the row body.            </div>
153                        </div>
154        </td>
155        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#enableRowBody" href="output/Ext.grid.GridView.html#enableRowBody">GridView</a></td>
156    </tr>
157        <tr class="config-row inherited expandable">
158        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
159        <td class="sig">
160        <a id="Ext.grid.GroupingView-forceFit"></a>
161            <b>forceFit</b> : Boolean            <div class="mdesc">
162                        <div class="short">True to auto expand/contract the size of the columns to fit the grid width and prevent horizontal scrolling. This opt...</div>
163            <div class="long">
164                True to auto expand/contract the size of the columns to fit the grid width and prevent horizontal scrolling. This option overrides any (@link Ext.grid.ColumnModel#width width} settings in the ColumnModel.            </div>
165                        </div>
166        </td>
167        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#forceFit" href="output/Ext.grid.GridView.html#forceFit">GridView</a></td>
168    </tr>
169        <tr class="config-row alt">
170        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
171        <td class="sig">
172        <a id="Ext.grid.GroupingView-groupByText"></a>
173            <b>groupByText</b> : String            <div class="mdesc">
174                            Text displayed in the grid header menu for grouping by a column (defaults to 'Group By This Field').                        </div>
175        </td>
176        <td class="msource">GroupingView</td>
177    </tr>
178        <tr class="config-row expandable">
179        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
180        <td class="sig">
181        <a id="Ext.grid.GroupingView-groupRenderer"></a>
182            <b>groupRenderer</b> : Function            <div class="mdesc">
183                        <div class="short">The function used to format the grouping field value for display in the group header. Should return a string value. T...</div>
184            <div class="long">
185                The function used to format the grouping field value for display in the group header. Should return a string value. This takes 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>            </div>
186                        </div>
187        </td>
188        <td class="msource">GroupingView</td>
189    </tr>
190        <tr class="config-row alt expandable">
191        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
192        <td class="sig">
193        <a id="Ext.grid.GroupingView-groupTextTpl"></a>
194            <b>groupTextTpl</b> : String            <div class="mdesc">
195                        <div class="short">The template used to render the group header. This is used to format an object which contains the following propertie...</div>
196            <div class="long">
197                The template used to render the group header. This is used to format an object which contains the following properties: <div class="mdetail-params"><ul> <li><b>group</b> : String<p class="sub-desc">The <i>rendered</i> value of the group field. By default this is the unchanged value of the group field. If a <a ext:cls="Ext.grid.GroupingView" ext:member="groupRenderer" href="output/Ext.grid.GroupingView.html#groupRenderer">groupRenderer</a> is specified, it is the result of a call to that.</p></li> <li><b>gvalue</b> : Object<p class="sub-desc">The <i>raw</i> value of the group field.</p></li> <li><b>text</b> : String<p class="sub-desc">The configured <a ext:cls="Ext.grid.GroupingView" ext:member="header" href="output/Ext.grid.GroupingView.html#header">header</a> (If <a ext:cls="Ext.grid.GroupingView" ext:member="showGroupName" href="output/Ext.grid.GroupingView.html#showGroupName">showGroupName</a> is true) plus the <i>rendered</i>group field value.</p></li> <li><b>groupId</b> : String<p class="sub-desc">A unique, generated ID which is applied to the View Element which contains the group.</p></li> <li><b>startRow</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li> <li><b>rs</b> : Array<p class="sub-desc">.Contains a single element: The Record providing the data for the row which caused group change.</p></li> <li><b>cls</b> : String<p class="sub-desc">The generated class name string to apply to the group header Element.</p></li> <li><b>style</b> : String<p class="sub-desc">The inline style rules to apply to the group header Element.</p></li> </ul></div></p> See <a ext:cls="Ext.XTemplate" href="output/Ext.XTemplate.html">Ext.XTemplate</a> for information on how to format data using a template.            </div>
198                        </div>
199        </td>
200        <td class="msource">GroupingView</td>
201    </tr>
202        <tr class="config-row">
203        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
204        <td class="sig">
205        <a id="Ext.grid.GroupingView-header"></a>
206            <b>header</b> : String            <div class="mdesc">
207                            The text with which to prefix the group field value in the group header line.                        </div>
208        </td>
209        <td class="msource">GroupingView</td>
210    </tr>
211        <tr class="config-row alt">
212        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
213        <td class="sig">
214        <a id="Ext.grid.GroupingView-hideGroupedColumn"></a>
215            <b>hideGroupedColumn</b> : Boolean            <div class="mdesc">
216                            True to hide the column that is currently grouped                        </div>
217        </td>
218        <td class="msource">GroupingView</td>
219    </tr>
220        <tr class="config-row">
221        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
222        <td class="sig">
223        <a id="Ext.grid.GroupingView-ignoreAdd"></a>
224            <b>ignoreAdd</b> : Boolean            <div class="mdesc">
225                            True to skip refreshing the view when new rows are added (defaults to false)                        </div>
226        </td>
227        <td class="msource">GroupingView</td>
228    </tr>
229        <tr class="config-row inherited alt expandable">
230        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
231        <td class="sig">
232        <a id="Ext.grid.GroupingView-listeners"></a>
233            <b>listeners</b> : Object            <div class="mdesc">
234                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
235            <div class="long">
236                (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>
237                        </div>
238        </td>
239        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
240    </tr>
241        <tr class="config-row inherited">
242        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
243        <td class="sig">
244        <a id="Ext.grid.GroupingView-rowSelector"></a>
245            <b>rowSelector</b> : String            <div class="mdesc">
246                            The selector used to find rows internally                        </div>
247        </td>
248        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#rowSelector" href="output/Ext.grid.GridView.html#rowSelector">GridView</a></td>
249    </tr>
250        <tr class="config-row inherited alt">
251        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
252        <td class="sig">
253        <a id="Ext.grid.GroupingView-rowSelectorDepth"></a>
254            <b>rowSelectorDepth</b> : Number            <div class="mdesc">
255                            The number of levels to search for rows in event delegation (defaults to 10)                        </div>
256        </td>
257        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#rowSelectorDepth" href="output/Ext.grid.GridView.html#rowSelectorDepth">GridView</a></td>
258    </tr>
259        <tr class="config-row">
260        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
261        <td class="sig">
262        <a id="Ext.grid.GroupingView-showGroupName"></a>
263            <b>showGroupName</b> : Boolean            <div class="mdesc">
264                            True to display the name for each set of grouped rows (defaults to true)                        </div>
265        </td>
266        <td class="msource">GroupingView</td>
267    </tr>
268        <tr class="config-row alt">
269        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
270        <td class="sig">
271        <a id="Ext.grid.GroupingView-showGroupsText"></a>
272            <b>showGroupsText</b> : String            <div class="mdesc">
273                            Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').                        </div>
274        </td>
275        <td class="msource">GroupingView</td>
276    </tr>
277        <tr class="config-row">
278        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
279        <td class="sig">
280        <a id="Ext.grid.GroupingView-startCollapsed"></a>
281            <b>startCollapsed</b> : Boolean            <div class="mdesc">
282                            True to start all groups collapsed                        </div>
283        </td>
284        <td class="msource">GroupingView</td>
285    </tr>
286            </table>
287                <a id="Ext.grid.GroupingView-props"></a>
288        <h2>Public Properties</h2>
289                <table cellspacing="0" class="member-table">
290            <tr>
291                <th class="sig-header" colspan="2">Property</th>
292                <th class="msource-header">Defined By</th>
293            </tr>
294                <tr class="property-row inherited">
295        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
296        <td class="sig">
297        <a id="Ext.grid.GroupingView-columnsText"></a>
298            <b>columnsText</b> : String            <div class="mdesc">
299                            The text displayed in the "Columns" menu item                        </div>
300        </td>
301        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#columnsText" href="output/Ext.grid.GridView.html#columnsText">GridView</a></td>
302    </tr>
303        <tr class="property-row inherited alt">
304        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
305        <td class="sig">
306        <a id="Ext.grid.GroupingView-dragZone"></a>
307            <b>dragZone</b> : Ext.grid.GridDragZone
308<p><b>This            <div class="mdesc">
309                                                    </div>
310        </td>
311        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#dragZone" href="output/Ext.grid.GridView.html#dragZone">GridView</a></td>
312    </tr>
313        <tr class="property-row inherited expandable">
314        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
315        <td class="sig">
316        <a id="Ext.grid.GroupingView-mainBody"></a>
317            <b>mainBody</b> : Ext.Element            <div class="mdesc">
318                        <div class="short">The GridView's body Element which encapsulates all rows in the Grid. Element. Read-only.
319This Element is only availab...</div>
320            <div class="long">
321                The GridView's body Element which encapsulates all rows in the Grid. <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a>. Read-only.
322<p>This Element is only available after the GridPanel has been rendered.</p>            </div>
323                        </div>
324        </td>
325        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#mainBody" href="output/Ext.grid.GridView.html#mainBody">GridView</a></td>
326    </tr>
327        <tr class="property-row inherited alt">
328        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
329        <td class="sig">
330        <a id="Ext.grid.GroupingView-scrollOffset"></a>
331            <b>scrollOffset</b> : Number            <div class="mdesc">
332                            The amount of space to reserve for the scrollbar (defaults to 19 pixels)                        </div>
333        </td>
334        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#scrollOffset" href="output/Ext.grid.GridView.html#scrollOffset">GridView</a></td>
335    </tr>
336        <tr class="property-row inherited">
337        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
338        <td class="sig">
339        <a id="Ext.grid.GroupingView-sortAscText"></a>
340            <b>sortAscText</b> : String            <div class="mdesc">
341                            The text displayed in the "Sort Ascending" menu item                        </div>
342        </td>
343        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#sortAscText" href="output/Ext.grid.GridView.html#sortAscText">GridView</a></td>
344    </tr>
345        <tr class="property-row inherited alt">
346        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
347        <td class="sig">
348        <a id="Ext.grid.GroupingView-sortClasses"></a>
349            <b>sortClasses</b> : Array            <div class="mdesc">
350                            The CSS classes applied to a header when it is sorted. (defaults to ["sort-asc", "sort-desc"])                        </div>
351        </td>
352        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#sortClasses" href="output/Ext.grid.GridView.html#sortClasses">GridView</a></td>
353    </tr>
354        <tr class="property-row inherited">
355        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
356        <td class="sig">
357        <a id="Ext.grid.GroupingView-sortDescText"></a>
358            <b>sortDescText</b> : String            <div class="mdesc">
359                            The text displayed in the "Sort Descending" menu item                        </div>
360        </td>
361        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#sortDescText" href="output/Ext.grid.GridView.html#sortDescText">GridView</a></td>
362    </tr>
363            </table>
364                <a id="Ext.grid.GroupingView-methods"></a>
365        <h2>Public Methods</h2>
366                <table cellspacing="0" class="member-table">
367            <tr>
368                <th class="sig-header" colspan="2">Method</th>
369                <th class="msource-header">Defined By</th>
370            </tr>
371                <tr class="method-row expandable">
372        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
373        <td class="sig">
374        <a id="Ext.grid.GroupingView-GroupingView"></a>
375            <b>GroupingView</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">
376                        <div class="short"></div>
377            <div class="long">
378                    <div class="mdetail-params">
379        <strong>Parameters:</strong>
380        <ul><li><code>config</code> : Object<div class="sub-desc"></div></li>        </ul>
381        <strong>Returns:</strong>
382        <ul>
383            <li><code></code></li>
384        </ul>
385    </div>
386                </div>
387                        </div>
388        </td>
389        <td class="msource">GroupingView</td>
390    </tr>
391        <tr class="method-row inherited alt expandable">
392        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
393        <td class="sig">
394        <a id="Ext.grid.GroupingView-addEvents"></a>
395            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
396                        <div class="short">Used to define events on this Observable</div>
397            <div class="long">
398                Used to define events on this Observable    <div class="mdetail-params">
399        <strong>Parameters:</strong>
400        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
401        <strong>Returns:</strong>
402        <ul>
403            <li><code>void</code></li>
404        </ul>
405    </div>
406                </div>
407                        </div>
408        </td>
409        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
410    </tr>
411        <tr class="method-row inherited expandable">
412        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
413        <td class="sig">
414        <a id="Ext.grid.GroupingView-addListener"></a>
415            <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
416                        <div class="short">Appends an event handler to this component</div>
417            <div class="long">
418                Appends an event handler to this component    <div class="mdetail-params">
419        <strong>Parameters:</strong>
420        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
421function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
422properties. This may contain any of the following properties:<ul>
423<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
424<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
425<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
426<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
427by the specified number of milliseconds. If the event fires again within that time, the original
428handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
429</ul><br>
430<p>
431<b>Combining Options</b><br>
432Using the options argument, it is possible to combine different types of listeners:<br>
433<br>
434A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
435<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
436    single: true,
437    delay: 100,
438    forumId: 4
439});</code></pre>
440<p>
441<b>Attaching multiple handlers in 1 call</b><br>
442The method also allows for a single argument to be passed which is a config object containing properties
443which specify multiple handlers.
444<p>
445<pre><code>foo.on({
446    <em>'click'</em> : {
447        fn: <b>this</b>.onClick,
448        scope: <b>this</b>,
449        delay: 100
450    },
451    <em>'mouseover'</em> : {
452        fn: <b>this</b>.onMouseOver,
453        scope: <b>this</b>
454    },
455    <em>'mouseout'</em> : {
456        fn: <b>this</b>.onMouseOut,
457        scope: <b>this</b>
458    }
459});</code></pre>
460<p>
461Or a shorthand syntax:<br>
462<pre><code>foo.on({
463    <em>'click'</em> : <b>this</b>.onClick,
464    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
465    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
466     scope: <b>this</b>
467});</code></pre></div></li>        </ul>
468        <strong>Returns:</strong>
469        <ul>
470            <li><code>void</code></li>
471        </ul>
472    </div>
473                </div>
474                        </div>
475        </td>
476        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
477    </tr>
478        <tr class="method-row alt expandable">
479        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
480        <td class="sig">
481        <a id="Ext.grid.GroupingView-collapseAllGroups"></a>
482            <b>collapseAllGroups</b>() : void            <div class="mdesc">
483                        <div class="short">Collapses all grouped rows.</div>
484            <div class="long">
485                Collapses all grouped rows.    <div class="mdetail-params">
486        <strong>Parameters:</strong>
487        <ul><li>None.</li>        </ul>
488        <strong>Returns:</strong>
489        <ul>
490            <li><code>void</code></li>
491        </ul>
492    </div>
493                </div>
494                        </div>
495        </td>
496        <td class="msource">GroupingView</td>
497    </tr>
498        <tr class="method-row expandable">
499        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
500        <td class="sig">
501        <a id="Ext.grid.GroupingView-expandAllGroups"></a>
502            <b>expandAllGroups</b>() : void            <div class="mdesc">
503                        <div class="short">Expands all grouped rows.</div>
504            <div class="long">
505                Expands all grouped rows.    <div class="mdetail-params">
506        <strong>Parameters:</strong>
507        <ul><li>None.</li>        </ul>
508        <strong>Returns:</strong>
509        <ul>
510            <li><code>void</code></li>
511        </ul>
512    </div>
513                </div>
514                        </div>
515        </td>
516        <td class="msource">GroupingView</td>
517    </tr>
518        <tr class="method-row inherited alt expandable">
519        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
520        <td class="sig">
521        <a id="Ext.grid.GroupingView-findRow"></a>
522            <b>findRow</b>(&nbsp;<code>Element el</code>&nbsp;) : The            <div class="mdesc">
523                        <div class="short">Return the HtmlElement representing the grid row which contains the passed element.</div>
524            <div class="long">
525                Return the HtmlElement representing the grid row which contains the passed element.    <div class="mdetail-params">
526        <strong>Parameters:</strong>
527        <ul><li><code>el</code> : Element<div class="sub-desc">The target element</div></li>        </ul>
528        <strong>Returns:</strong>
529        <ul>
530            <li><code>The</code><div class="sub-desc">row element, or null if the target element is not within a row of this GridView.</div></li>
531        </ul>
532    </div>
533                </div>
534                        </div>
535        </td>
536        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#findRow" href="output/Ext.grid.GridView.html#findRow">GridView</a></td>
537    </tr>
538        <tr class="method-row inherited expandable">
539        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
540        <td class="sig">
541        <a id="Ext.grid.GroupingView-findRowIndex"></a>
542            <b>findRowIndex</b>(&nbsp;<code>Element el</code>&nbsp;) : The            <div class="mdesc">
543                        <div class="short">Return the index of the grid row which contains the passed element.</div>
544            <div class="long">
545                Return the index of the grid row which contains the passed element.    <div class="mdetail-params">
546        <strong>Parameters:</strong>
547        <ul><li><code>el</code> : Element<div class="sub-desc">The target element</div></li>        </ul>
548        <strong>Returns:</strong>
549        <ul>
550            <li><code>The</code><div class="sub-desc">row index, or <b>false</b> if the target element is not within a row of this GridView.</div></li>
551        </ul>
552    </div>
553                </div>
554                        </div>
555        </td>
556        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#findRowIndex" href="output/Ext.grid.GridView.html#findRowIndex">GridView</a></td>
557    </tr>
558        <tr class="method-row inherited alt expandable">
559        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
560        <td class="sig">
561        <a id="Ext.grid.GroupingView-fireEvent"></a>
562            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
563                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
564            <div class="long">
565                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
566        <strong>Parameters:</strong>
567        <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>
568        <strong>Returns:</strong>
569        <ul>
570            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
571        </ul>
572    </div>
573                </div>
574                        </div>
575        </td>
576        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
577    </tr>
578        <tr class="method-row inherited expandable">
579        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
580        <td class="sig">
581        <a id="Ext.grid.GroupingView-focusCell"></a>
582            <b>focusCell</b>(&nbsp;<code>Number row</code>, <code>Number col</code>&nbsp;) : void            <div class="mdesc">
583                        <div class="short">Focuses the specified cell.</div>
584            <div class="long">
585                Focuses the specified cell.    <div class="mdetail-params">
586        <strong>Parameters:</strong>
587        <ul><li><code>row</code> : Number<div class="sub-desc">The row index</div></li><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
588        <strong>Returns:</strong>
589        <ul>
590            <li><code>void</code></li>
591        </ul>
592    </div>
593                </div>
594                        </div>
595        </td>
596        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#focusCell" href="output/Ext.grid.GridView.html#focusCell">GridView</a></td>
597    </tr>
598        <tr class="method-row inherited alt expandable">
599        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
600        <td class="sig">
601        <a id="Ext.grid.GroupingView-focusRow"></a>
602            <b>focusRow</b>(&nbsp;<code>Number row</code>&nbsp;) : void            <div class="mdesc">
603                        <div class="short">Focuses the specified row.</div>
604            <div class="long">
605                Focuses the specified row.    <div class="mdetail-params">
606        <strong>Parameters:</strong>
607        <ul><li><code>row</code> : Number<div class="sub-desc">The row index</div></li>        </ul>
608        <strong>Returns:</strong>
609        <ul>
610            <li><code>void</code></li>
611        </ul>
612    </div>
613                </div>
614                        </div>
615        </td>
616        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#focusRow" href="output/Ext.grid.GridView.html#focusRow">GridView</a></td>
617    </tr>
618        <tr class="method-row inherited expandable">
619        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
620        <td class="sig">
621        <a id="Ext.grid.GroupingView-getCell"></a>
622            <b>getCell</b>(&nbsp;<code>Number row</code>, <code>Number col</code>&nbsp;) : HtmlElement            <div class="mdesc">
623                        <div class="short">Returns the grid's &lt;TD> HtmlElement at the specified coordinates.</div>
624            <div class="long">
625                Returns the grid's &lt;TD> HtmlElement at the specified coordinates.    <div class="mdetail-params">
626        <strong>Parameters:</strong>
627        <ul><li><code>row</code> : Number<div class="sub-desc">The row index in which to find the cell.</div></li><li><code>col</code> : Number<div class="sub-desc">The column index of the cell.</div></li>        </ul>
628        <strong>Returns:</strong>
629        <ul>
630            <li><code>HtmlElement</code><div class="sub-desc">The &lt;TD> at the specified coordinates.</div></li>
631        </ul>
632    </div>
633                </div>
634                        </div>
635        </td>
636        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#getCell" href="output/Ext.grid.GridView.html#getCell">GridView</a></td>
637    </tr>
638        <tr class="method-row alt expandable">
639        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
640        <td class="sig">
641        <a id="Ext.grid.GroupingView-getGroupId"></a>
642            <b>getGroupId</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
643                        <div class="short">Dynamically tries to determine the groupId of a specific value</div>
644            <div class="long">
645                Dynamically tries to determine the groupId of a specific value    <div class="mdetail-params">
646        <strong>Parameters:</strong>
647        <ul><li><code>value</code> : String<div class="sub-desc"></div></li>        </ul>
648        <strong>Returns:</strong>
649        <ul>
650            <li><code>String</code><div class="sub-desc">The group id</div></li>
651        </ul>
652    </div>
653                </div>
654                        </div>
655        </td>
656        <td class="msource">GroupingView</td>
657    </tr>
658        <tr class="method-row inherited expandable">
659        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
660        <td class="sig">
661        <a id="Ext.grid.GroupingView-getHeaderCell"></a>
662            <b>getHeaderCell</b>(&nbsp;<code>Number index</code>&nbsp;) : HtmlElement            <div class="mdesc">
663                        <div class="short">Return the &lt;TD> HtmlElement which represents the Grid's header cell for the specified column index.</div>
664            <div class="long">
665                Return the &lt;TD> HtmlElement which represents the Grid's header cell for the specified column index.    <div class="mdetail-params">
666        <strong>Parameters:</strong>
667        <ul><li><code>index</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
668        <strong>Returns:</strong>
669        <ul>
670            <li><code>HtmlElement</code><div class="sub-desc">The &lt;TD> element.</div></li>
671        </ul>
672    </div>
673                </div>
674                        </div>
675        </td>
676        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#getHeaderCell" href="output/Ext.grid.GridView.html#getHeaderCell">GridView</a></td>
677    </tr>
678        <tr class="method-row inherited alt expandable">
679        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
680        <td class="sig">
681        <a id="Ext.grid.GroupingView-getRow"></a>
682            <b>getRow</b>(&nbsp;<code>Number index</code>&nbsp;) : HtmlElement            <div class="mdesc">
683                        <div class="short">Return the &lt;TR> HtmlElement which represents a Grid row for the specified index.</div>
684            <div class="long">
685                Return the &lt;TR> HtmlElement which represents a Grid row for the specified index.    <div class="mdetail-params">
686        <strong>Parameters:</strong>
687        <ul><li><code>index</code> : Number<div class="sub-desc">The row index</div></li>        </ul>
688        <strong>Returns:</strong>
689        <ul>
690            <li><code>HtmlElement</code><div class="sub-desc">The &lt;TR> element.</div></li>
691        </ul>
692    </div>
693                </div>
694                        </div>
695        </td>
696        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#getRow" href="output/Ext.grid.GridView.html#getRow">GridView</a></td>
697    </tr>
698        <tr class="method-row inherited expandable">
699        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
700        <td class="sig">
701        <a id="Ext.grid.GroupingView-getRowClass"></a>
702            <b>getRowClass</b>(&nbsp;<code>Record record</code>, <code>Number index</code>, <code>Object rowParams</code>, <code>Store store</code>&nbsp;) : String            <div class="mdesc">
703                        <div class="short">Override this function to apply custom CSS classes to rows during rendering.  You can also supply custom
704parameters t...</div>
705            <div class="long">
706                Override this function to apply custom CSS classes to rows during rendering.  You can also supply custom
707parameters to the row template for the current row to customize how it is rendered using the <b>rowParams</b>
708parameter.  This function should return the CSS class name (or empty string '' for none) that will be added
709to the row's wrapping div.  To apply multiple class names, simply return them space-delimited within the string
710(e.g., 'my-class another-class').    <div class="mdetail-params">
711        <strong>Parameters:</strong>
712        <ul><li><code>record</code> : Record<div class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> corresponding to the current row</div></li><li><code>index</code> : Number<div class="sub-desc">The row index</div></li><li><code>rowParams</code> : Object<div class="sub-desc">A config object that is passed to the row template during rendering that allows
713customization of various aspects of a body row, if applicable. Note that this object will only be applied if
714<a ext:cls="Ext.grid.GridView" ext:member="enableRowBody" href="output/Ext.grid.GridView.html#enableRowBody">enableRowBody</a> = true, otherwise it will be ignored. The object may contain any of these properties:<ul>
715<li><code>body</code> : String <div class="sub-desc">An HTML fragment to be rendered as the cell's body content (defaults to '').</div></li>
716<li><code>bodyStyle</code> : String <div class="sub-desc">A CSS style string that will be applied to the row's TR style attribute (defaults to '').</div></li>
717<li><code>cols</code> : Number <div class="sub-desc">The column count to apply to the body row's TD colspan attribute (defaults to the current
718column count of the grid).</div></li>
719</ul></div></li><li><code>store</code> : Store<div class="sub-desc">The <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> this grid is bound to</div></li>        </ul>
720        <strong>Returns:</strong>
721        <ul>
722            <li><code>String</code><div class="sub-desc">a CSS class name to add to the row.</div></li>
723        </ul>
724    </div>
725                </div>
726                        </div>
727        </td>
728        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#getRowClass" href="output/Ext.grid.GridView.html#getRowClass">GridView</a></td>
729    </tr>
730        <tr class="method-row inherited alt expandable">
731        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
732        <td class="sig">
733        <a id="Ext.grid.GroupingView-hasListener"></a>
734            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
735                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
736            <div class="long">
737                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
738        <strong>Parameters:</strong>
739        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
740        <strong>Returns:</strong>
741        <ul>
742            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
743        </ul>
744    </div>
745                </div>
746                        </div>
747        </td>
748        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
749    </tr>
750        <tr class="method-row inherited expandable">
751        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
752        <td class="sig">
753        <a id="Ext.grid.GroupingView-on"></a>
754            <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
755                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
756            <div class="long">
757                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
758        <strong>Parameters:</strong>
759        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
760function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
761        <strong>Returns:</strong>
762        <ul>
763            <li><code>void</code></li>
764        </ul>
765    </div>
766                </div>
767                        </div>
768        </td>
769        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
770    </tr>
771        <tr class="method-row inherited alt expandable">
772        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
773        <td class="sig">
774        <a id="Ext.grid.GroupingView-purgeListeners"></a>
775            <b>purgeListeners</b>() : void            <div class="mdesc">
776                        <div class="short">Removes all listeners for this object</div>
777            <div class="long">
778                Removes all listeners for this object    <div class="mdetail-params">
779        <strong>Parameters:</strong>
780        <ul><li>None.</li>        </ul>
781        <strong>Returns:</strong>
782        <ul>
783            <li><code>void</code></li>
784        </ul>
785    </div>
786                </div>
787                        </div>
788        </td>
789        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
790    </tr>
791        <tr class="method-row inherited expandable">
792        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
793        <td class="sig">
794        <a id="Ext.grid.GroupingView-refresh"></a>
795            <b>refresh</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean headersToo</code>]</span>&nbsp;) : void            <div class="mdesc">
796                        <div class="short">Refreshs the grid UI</div>
797            <div class="long">
798                Refreshs the grid UI    <div class="mdetail-params">
799        <strong>Parameters:</strong>
800        <ul><li><code>headersToo</code> : Boolean<div class="sub-desc">(optional) True to also refresh the headers</div></li>        </ul>
801        <strong>Returns:</strong>
802        <ul>
803            <li><code>void</code></li>
804        </ul>
805    </div>
806                </div>
807                        </div>
808        </td>
809        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#refresh" href="output/Ext.grid.GridView.html#refresh">GridView</a></td>
810    </tr>
811        <tr class="method-row inherited alt expandable">
812        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
813        <td class="sig">
814        <a id="Ext.grid.GroupingView-relayEvents"></a>
815            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
816                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
817            <div class="long">
818                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
819        <strong>Parameters:</strong>
820        <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>
821        <strong>Returns:</strong>
822        <ul>
823            <li><code>void</code></li>
824        </ul>
825    </div>
826                </div>
827                        </div>
828        </td>
829        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
830    </tr>
831        <tr class="method-row inherited expandable">
832        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
833        <td class="sig">
834        <a id="Ext.grid.GroupingView-removeListener"></a>
835            <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
836                        <div class="short">Removes a listener</div>
837            <div class="long">
838                Removes a listener    <div class="mdetail-params">
839        <strong>Parameters:</strong>
840        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
841        <strong>Returns:</strong>
842        <ul>
843            <li><code>void</code></li>
844        </ul>
845    </div>
846                </div>
847                        </div>
848        </td>
849        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
850    </tr>
851        <tr class="method-row inherited alt expandable">
852        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
853        <td class="sig">
854        <a id="Ext.grid.GroupingView-resumeEvents"></a>
855            <b>resumeEvents</b>() : void            <div class="mdesc">
856                        <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
857            <div class="long">
858                Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">
859        <strong>Parameters:</strong>
860        <ul><li>None.</li>        </ul>
861        <strong>Returns:</strong>
862        <ul>
863            <li><code>void</code></li>
864        </ul>
865    </div>
866                </div>
867                        </div>
868        </td>
869        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
870    </tr>
871        <tr class="method-row inherited expandable">
872        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
873        <td class="sig">
874        <a id="Ext.grid.GroupingView-scrollToTop"></a>
875            <b>scrollToTop</b>() : void            <div class="mdesc">
876                        <div class="short">Scrolls the grid to the top</div>
877            <div class="long">
878                Scrolls the grid to the top    <div class="mdetail-params">
879        <strong>Parameters:</strong>
880        <ul><li>None.</li>        </ul>
881        <strong>Returns:</strong>
882        <ul>
883            <li><code>void</code></li>
884        </ul>
885    </div>
886                </div>
887                        </div>
888        </td>
889        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#scrollToTop" href="output/Ext.grid.GridView.html#scrollToTop">GridView</a></td>
890    </tr>
891        <tr class="method-row inherited alt expandable">
892        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
893        <td class="sig">
894        <a id="Ext.grid.GroupingView-suspendEvents"></a>
895            <b>suspendEvents</b>() : void            <div class="mdesc">
896                        <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
897            <div class="long">
898                Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">
899        <strong>Parameters:</strong>
900        <ul><li>None.</li>        </ul>
901        <strong>Returns:</strong>
902        <ul>
903            <li><code>void</code></li>
904        </ul>
905    </div>
906                </div>
907                        </div>
908        </td>
909        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
910    </tr>
911        <tr class="method-row expandable">
912        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
913        <td class="sig">
914        <a id="Ext.grid.GroupingView-toggleAllGroups"></a>
915            <b>toggleAllGroups</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean expanded</code>]</span>&nbsp;) : void            <div class="mdesc">
916                        <div class="short">Toggles all groups if no value is passed, otherwise sets the expanded state of all groups to the value passed.</div>
917            <div class="long">
918                Toggles all groups if no value is passed, otherwise sets the expanded state of all groups to the value passed.    <div class="mdetail-params">
919        <strong>Parameters:</strong>
920        <ul><li><code>expanded</code> : Boolean<div class="sub-desc">(optional)</div></li>        </ul>
921        <strong>Returns:</strong>
922        <ul>
923            <li><code>void</code></li>
924        </ul>
925    </div>
926                </div>
927                        </div>
928        </td>
929        <td class="msource">GroupingView</td>
930    </tr>
931        <tr class="method-row alt expandable">
932        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
933        <td class="sig">
934        <a id="Ext.grid.GroupingView-toggleGroup"></a>
935            <b>toggleGroup</b>(&nbsp;<code>String groupId</code>, <span class="optional" title="Optional">[<code>Boolean expanded</code>]</span>&nbsp;) : void            <div class="mdesc">
936                        <div class="short">Toggles the specified group if no value is passed, otherwise sets the expanded state of the group to the value passed.</div>
937            <div class="long">
938                Toggles the specified group if no value is passed, otherwise sets the expanded state of the group to the value passed.    <div class="mdetail-params">
939        <strong>Parameters:</strong>
940        <ul><li><code>groupId</code> : String<div class="sub-desc">The groupId assigned to the group (see getGroupId)</div></li><li><code>expanded</code> : Boolean<div class="sub-desc">(optional)</div></li>        </ul>
941        <strong>Returns:</strong>
942        <ul>
943            <li><code>void</code></li>
944        </ul>
945    </div>
946                </div>
947                        </div>
948        </td>
949        <td class="msource">GroupingView</td>
950    </tr>
951        <tr class="method-row inherited expandable">
952        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
953        <td class="sig">
954        <a id="Ext.grid.GroupingView-un"></a>
955            <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
956                        <div class="short">Removes a listener (shorthand for removeListener)</div>
957            <div class="long">
958                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
959        <strong>Parameters:</strong>
960        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
961        <strong>Returns:</strong>
962        <ul>
963            <li><code>void</code></li>
964        </ul>
965    </div>
966                </div>
967                        </div>
968        </td>
969        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
970    </tr>
971            </table>
972                <a id="Ext.grid.GroupingView-events"></a>
973        <h2>Public Events</h2>
974                <table cellspacing="0" class="member-table">
975            <tr>
976                <th class="sig-header" colspan="2">Event</th>
977                <th class="msource-header">Defined By</th>
978            </tr>
979                <tr class="event-row inherited expandable">
980        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
981        <td class="sig">
982        <a id="Ext.grid.GroupingView-beforerefresh"></a>
983            <b>beforerefresh</b> : (&nbsp;<code>Ext.grid.GridView view</code>&nbsp;)            <div class="mdesc">
984                        <div class="short">Internal UI Event. Fired before the view is refreshed.</div>
985            <div class="long">
986                Internal UI Event. Fired before the view is refreshed.    <div class="mdetail-params">
987        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
988        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li>        </ul>
989    </div>
990                </div>
991                        </div>
992        </td>
993        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-beforerefresh" href="output/Ext.grid.GridView.html#event-beforerefresh">GridView</a></td>
994    </tr>
995        <tr class="event-row inherited alt expandable">
996        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
997        <td class="sig">
998        <a id="Ext.grid.GroupingView-beforerowremoved"></a>
999            <b>beforerowremoved</b> : (&nbsp;<code>Ext.grid.GridView view</code>, <code>Number rowIndex</code>, <code>Ext.data.Record record</code>&nbsp;)            <div class="mdesc">
1000                        <div class="short">Internal UI Event. Fired before a row is removed.</div>
1001            <div class="long">
1002                Internal UI Event. Fired before a row is removed.    <div class="mdetail-params">
1003        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1004        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The index of the row to be removed.</div></li><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Record to be removed</div></li>        </ul>
1005    </div>
1006                </div>
1007                        </div>
1008        </td>
1009        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-beforerowremoved" href="output/Ext.grid.GridView.html#event-beforerowremoved">GridView</a></td>
1010    </tr>
1011        <tr class="event-row inherited expandable">
1012        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1013        <td class="sig">
1014        <a id="Ext.grid.GroupingView-beforerowsinserted"></a>
1015            <b>beforerowsinserted</b> : (&nbsp;<code>Ext.grid.GridView view</code>, <code>Number firstRow</code>, <code>Number lastRow</code>&nbsp;)            <div class="mdesc">
1016                        <div class="short">Internal UI Event. Fired before rows are inserted.</div>
1017            <div class="long">
1018                Internal UI Event. Fired before rows are inserted.    <div class="mdetail-params">
1019        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1020        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li><li><code>firstRow</code> : Number<div class="sub-desc">The index of the first row to be inserted.</div></li><li><code>lastRow</code> : Number<div class="sub-desc">The index of the last row to be inserted.</div></li>        </ul>
1021    </div>
1022                </div>
1023                        </div>
1024        </td>
1025        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-beforerowsinserted" href="output/Ext.grid.GridView.html#event-beforerowsinserted">GridView</a></td>
1026    </tr>
1027        <tr class="event-row inherited alt expandable">
1028        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1029        <td class="sig">
1030        <a id="Ext.grid.GroupingView-refresh"></a>
1031            <b>refresh</b> : (&nbsp;<code>Ext.grid.GridView view</code>&nbsp;)            <div class="mdesc">
1032                        <div class="short">Internal UI Event. Fired after the GridView's body has been refreshed.</div>
1033            <div class="long">
1034                Internal UI Event. Fired after the GridView's body has been refreshed.    <div class="mdetail-params">
1035        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1036        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li>        </ul>
1037    </div>
1038                </div>
1039                        </div>
1040        </td>
1041        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-refresh" href="output/Ext.grid.GridView.html#event-refresh">GridView</a></td>
1042    </tr>
1043        <tr class="event-row inherited expandable">
1044        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1045        <td class="sig">
1046        <a id="Ext.grid.GroupingView-rowremoved"></a>
1047            <b>rowremoved</b> : (&nbsp;<code>Ext.grid.GridView view</code>, <code>Number rowIndex</code>, <code>Ext.data.Record record</code>&nbsp;)            <div class="mdesc">
1048                        <div class="short">Internal UI Event. Fired after a row is removed.</div>
1049            <div class="long">
1050                Internal UI Event. Fired after a row is removed.    <div class="mdetail-params">
1051        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1052        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The index of the row that was removed.</div></li><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Record that was removed</div></li>        </ul>
1053    </div>
1054                </div>
1055                        </div>
1056        </td>
1057        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-rowremoved" href="output/Ext.grid.GridView.html#event-rowremoved">GridView</a></td>
1058    </tr>
1059        <tr class="event-row inherited alt expandable">
1060        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1061        <td class="sig">
1062        <a id="Ext.grid.GroupingView-rowsinserted"></a>
1063            <b>rowsinserted</b> : (&nbsp;<code>Ext.grid.GridView view</code>, <code>Number firstRow</code>, <code>Number lastRow</code>&nbsp;)            <div class="mdesc">
1064                        <div class="short">Internal UI Event. Fired after rows are inserted.</div>
1065            <div class="long">
1066                Internal UI Event. Fired after rows are inserted.    <div class="mdetail-params">
1067        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1068        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li><li><code>firstRow</code> : Number<div class="sub-desc">The index of the first inserted.</div></li><li><code>lastRow</code> : Number<div class="sub-desc">The index of the last row inserted.</div></li>        </ul>
1069    </div>
1070                </div>
1071                        </div>
1072        </td>
1073        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-rowsinserted" href="output/Ext.grid.GridView.html#event-rowsinserted">GridView</a></td>
1074    </tr>
1075        <tr class="event-row inherited expandable">
1076        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1077        <td class="sig">
1078        <a id="Ext.grid.GroupingView-rowupdated"></a>
1079            <b>rowupdated</b> : (&nbsp;<code>Ext.grid.GridView view</code>, <code>Number firstRow</code>, <code>Ext.data.record record</code>&nbsp;)            <div class="mdesc">
1080                        <div class="short">Internal UI Event. Fired after a row has been updated.</div>
1081            <div class="long">
1082                Internal UI Event. Fired after a row has been updated.    <div class="mdetail-params">
1083        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1084        <ul><li><code>view</code> : Ext.grid.GridView<div class="sub-desc"></div></li><li><code>firstRow</code> : Number<div class="sub-desc">The index of the row updated.</div></li><li><code>record</code> : Ext.data.record<div class="sub-desc">The Record backing the row updated.</div></li>        </ul>
1085    </div>
1086                </div>
1087                        </div>
1088        </td>
1089        <td class="msource"><a ext:cls="Ext.grid.GridView" ext:member="#event-rowupdated" href="output/Ext.grid.GridView.html#event-rowupdated">GridView</a></td>
1090    </tr>
1091            </table>
1092       
1093        </div>
Note: See TracBrowser for help on using the repository browser.