Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Grouper.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><span id='Ext-util-Grouper'>/**
19 </span> * @class Ext.util.Grouper
20  * @extends Ext.util.Sorter
21
22 Represents a single grouper that can be applied to a Store. The grouper works
23 in the same fashion as the {@link Ext.util.Sorter}.
24
25  * @markdown
26  */
27  
28 Ext.define('Ext.util.Grouper', {
29
30     /* Begin Definitions */
31
32     extend: 'Ext.util.Sorter',
33
34     /* End Definitions */
35
36 <span id='Ext-util-Grouper-method-getGroupString'>    /**
37 </span>     * Returns the value for grouping to be used.
38      * @param {Ext.data.Model} instance The Model instance
39      * @return {String} The group string for this model
40      */
41     getGroupString: function(instance) {
42         return instance.get(this.property);
43     }
44 });</pre>
45 </body>
46 </html>