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