X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.util.Grouper.js

diff --git a/docs/output/Ext.util.Grouper.js b/docs/output/Ext.util.Grouper.js
index 05a0752b..c2cf820d 100644
--- a/docs/output/Ext.util.Grouper.js
+++ b/docs/output/Ext.util.Grouper.js
@@ -1,137 +1,250 @@
 Ext.data.JsonP.Ext_util_Grouper({
-  "tagname": "class",
-  "name": "Ext.util.Grouper",
-  "doc": "\n",
-  "extends": "Ext.util.Sorter",
-  "mixins": [
-
-  ],
-  "alternateClassNames": [
+  "allMixins": [
 
   ],
-  "xtype": null,
-  "author": null,
+  "deprecated": null,
   "docauthor": null,
-  "singleton": false,
-  "private": false,
-  "cfg": [
-    {
-      "tagname": "cfg",
-      "name": "direction",
-      "member": "Ext.util.Sorter",
-      "type": "String",
-      "doc": "<p>The direction to sort by. Defaults to ASC</p>\n",
-      "private": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
-      "linenr": 27,
-      "html_filename": "Sorter.html",
-      "href": "Sorter.html#Ext-util-Sorter-cfg-direction"
-    },
-    {
-      "tagname": "cfg",
-      "name": "property",
-      "member": "Ext.util.Sorter",
-      "type": "String",
-      "doc": "<p>The property to sort by. Required unless <a href=\"#/api/Ext.util.Grouper--sorter\" rel=\"Ext.util.Grouper--sorter\" class=\"docClass\">sorter</a> is provided</p>\n",
-      "private": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
-      "linenr": 8,
-      "html_filename": "Sorter.html",
-      "href": "Sorter.html#Ext-util-Sorter-cfg-property"
-    },
-    {
-      "tagname": "cfg",
-      "name": "root",
-      "member": "Ext.util.Sorter",
-      "type": "String",
-      "doc": "<p>Optional root property. This is mostly useful when sorting a Store, in which case we set the\nroot to 'data' to make the filter pull the <a href=\"#/api/Ext.util.Grouper-cfg-property\" rel=\"Ext.util.Grouper-cfg-property\" class=\"docClass\">property</a> out of the data object of each item</p>\n",
-      "private": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
-      "linenr": 16,
-      "html_filename": "Sorter.html",
-      "href": "Sorter.html#Ext-util-Sorter-cfg-root",
-      "shortDoc": "Optional root property. This is mostly useful when sorting a Store, in which case we set the\nroot to 'data' to make t..."
-    },
-    {
-      "tagname": "cfg",
-      "name": "sorterFn",
-      "member": "Ext.util.Sorter",
-      "type": "Function",
-      "doc": "<p>A specific sorter function to execute. Can be passed instead of <a href=\"#/api/Ext.util.Grouper-cfg-property\" rel=\"Ext.util.Grouper-cfg-property\" class=\"docClass\">property</a></p>\n",
-      "private": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
-      "linenr": 12,
-      "html_filename": "Sorter.html",
-      "href": "Sorter.html#Ext-util-Sorter-cfg-sorterFn"
-    },
-    {
-      "tagname": "cfg",
-      "name": "transform",
-      "member": "Ext.util.Sorter",
-      "type": "Function",
-      "doc": "<p>A function that will be run on each value before\nit is compared in the sorter. The function will receive a single argument,\nthe value.</p>\n",
-      "private": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sorter.js",
-      "linenr": 21,
-      "html_filename": "Sorter.html",
-      "href": "Sorter.html#Ext-util-Sorter-cfg-transform",
-      "shortDoc": "A function that will be run on each value before\nit is compared in the sorter. The function will receive a single arg..."
-    }
-  ],
-  "method": [
-    {
-      "tagname": "method",
-      "name": "getGroupString",
-      "member": "Ext.util.Grouper",
-      "doc": "<p>Function description</p>\n",
-      "params": [
-        {
-          "type": "Ext.data.Model",
-          "name": "instance",
-          "doc": "<p>The Model instance</p>\n",
-          "optional": false
-        }
-      ],
-      "return": {
+  "members": {
+    "cfg": [
+      {
         "type": "String",
-        "doc": "<p>The group string for this model</p>\n"
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "cfg",
+        "href": "Sorter.html#Ext-util-Sorter-cfg-direction",
+        "shortDoc": "The direction to sort by. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "name": "direction",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>The direction to sort by. Defaults to ASC</p>\n",
+        "linenr": 87,
+        "html_filename": "Sorter.html"
       },
-      "private": false,
-      "static": false,
-      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Grouper.js",
-      "linenr": 14,
-      "html_filename": "Grouper.html",
-      "href": "Grouper.html#Ext-util-Grouper-method-getGroupString",
-      "shortDoc": "<p>Function description</p>\n"
-    }
-  ],
-  "property": [
+      {
+        "type": "String",
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "cfg",
+        "href": "Sorter.html#Ext-util-Sorter-cfg-property",
+        "shortDoc": "The property to sort by. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "name": "property",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>The property to sort by. Required unless <a href=\"#/api/Ext.util.Grouper-cfg-sorterFn\" rel=\"Ext.util.Grouper-cfg-sorterFn\" class=\"docClass\">sorterFn</a> is provided.\nThe property is extracted from the object directly and compared for sorting using the built in\ncomparison operators.</p>\n",
+        "linenr": 59,
+        "html_filename": "Sorter.html"
+      },
+      {
+        "type": "String",
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "cfg",
+        "href": "Sorter.html#Ext-util-Sorter-cfg-root",
+        "shortDoc": "Optional root property. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "name": "root",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>Optional root property. This is mostly useful when sorting a Store, in which case we set the\nroot to 'data' to make the filter pull the <a href=\"#/api/Ext.util.Grouper-cfg-property\" rel=\"Ext.util.Grouper-cfg-property\" class=\"docClass\">property</a> out of the data object of each item</p>\n",
+        "linenr": 76,
+        "html_filename": "Sorter.html"
+      },
+      {
+        "type": "Function",
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "cfg",
+        "href": "Sorter.html#Ext-util-Sorter-cfg-sorterFn",
+        "shortDoc": "A specific sorter function to execute. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "name": "sorterFn",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>A specific sorter function to execute. Can be passed instead of <a href=\"#/api/Ext.util.Grouper-cfg-property\" rel=\"Ext.util.Grouper-cfg-property\" class=\"docClass\">property</a>.\nThis sorter function allows for any kind of custom/complex comparisons.\nThe sorterFn receives two arguments, the objects being compared. The function should return:</p>\n\n<ul>\n<li>-1 if o1 is \"less than\" o2</li>\n<li>0 if o1 is \"equal\" to o2</li>\n<li>1 if o1 is \"greater than\" o2</li>\n</ul>\n\n",
+        "linenr": 65,
+        "html_filename": "Sorter.html"
+      },
+      {
+        "type": "Function",
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "cfg",
+        "href": "Sorter.html#Ext-util-Sorter-cfg-transform",
+        "shortDoc": "A function that will be run on each value before\nit is compared in the sorter. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "name": "transform",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>A function that will be run on each value before\nit is compared in the sorter. The function will receive a single argument,\nthe value.</p>\n",
+        "linenr": 81,
+        "html_filename": "Sorter.html"
+      }
+    ],
+    "method": [
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "Grouper.html#Ext-util-Grouper-method-getGroupString",
+        "shortDoc": "Returns the value for grouping to be used. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Grouper.js",
+        "private": false,
+        "params": [
+          {
+            "type": "Ext.data.Model",
+            "optional": false,
+            "doc": "<p>The Model instance</p>\n",
+            "name": "instance"
+          }
+        ],
+        "name": "getGroupString",
+        "owner": "Ext.util.Grouper",
+        "doc": "<p>Returns the value for grouping to be used.</p>\n",
+        "linenr": 19,
+        "return": {
+          "type": "String",
+          "doc": "<p>The group string for this model</p>\n"
+        },
+        "html_filename": "Grouper.html"
+      },
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "Sorter.html#Ext-util-Sorter-method-setDirection",
+        "shortDoc": "Set the sorting direction for this sorter. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "params": [
+          {
+            "type": "String",
+            "optional": false,
+            "doc": "<p>The direction to sort in. Should be either 'ASC' or 'DESC'.</p>\n",
+            "name": "direction"
+          }
+        ],
+        "name": "setDirection",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>Set the sorting direction for this sorter.</p>\n",
+        "linenr": 152,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "Sorter.html"
+      },
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "Sorter.html#Ext-util-Sorter-method-toggle",
+        "shortDoc": "Toggles the sorting direction for this sorter. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "params": [
 
-  ],
-  "event": [
+        ],
+        "name": "toggle",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>Toggles the sorting direction for this sorter.</p>\n",
+        "linenr": 162,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "Sorter.html"
+      },
+      {
+        "deprecated": null,
+        "alias": null,
+        "protected": false,
+        "tagname": "method",
+        "href": "Sorter.html#Ext-util-Sorter-method-updateSortFunction",
+        "shortDoc": "Update the sort function for this sorter. ...",
+        "static": false,
+        "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js",
+        "private": false,
+        "params": [
+          {
+            "type": "Function",
+            "optional": false,
+            "doc": "<p>(Optional) A new sorter function for this sorter. If not specified it will use the\ndefault sorting function.</p>\n",
+            "name": "fn"
+          }
+        ],
+        "name": "updateSortFunction",
+        "owner": "Ext.util.Sorter",
+        "doc": "<p>Update the sort function for this sorter.</p>\n",
+        "linenr": 171,
+        "return": {
+          "type": "void",
+          "doc": "\n"
+        },
+        "html_filename": "Sorter.html"
+      }
+    ],
+    "property": [
 
-  ],
-  "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Grouper.js",
-  "linenr": 1,
-  "html_filename": "Grouper.html",
-  "href": "Grouper.html#Ext-util-Grouper",
-  "cssVar": [
+    ],
+    "cssVar": [
 
-  ],
-  "cssMixin": [
+    ],
+    "cssMixin": [
 
-  ],
-  "component": false,
+    ],
+    "event": [
+
+    ]
+  },
+  "singleton": false,
+  "alias": null,
   "superclasses": [
     "Ext.util.Sorter"
   ],
+  "protected": false,
+  "tagname": "class",
+  "mixins": [
+
+  ],
+  "href": "Grouper.html#Ext-util-Grouper",
   "subclasses": [
 
   ],
+  "static": false,
+  "author": null,
+  "component": false,
+  "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Grouper.js",
+  "private": false,
+  "alternateClassNames": [
+
+  ],
+  "name": "Ext.util.Grouper",
+  "doc": "<p>Represents a single grouper that can be applied to a Store. The grouper works\nin the same fashion as the <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Ext.util.Sorter</a>.</p>\n",
   "mixedInto": [
 
   ],
-  "allMixins": [
+  "linenr": 1,
+  "xtypes": [
 
-  ]
+  ],
+  "html_filename": "Grouper.html",
+  "extends": "Ext.util.Sorter"
 });
\ No newline at end of file