docs/output/Ext.data.Errors.js

   1 Ext.data.JsonP.Ext_data_Errors({
   2   "tagname": "class",
   3   "name": "Ext.data.Errors",
   4   "doc": "<p>Wraps a collection of validation error responses and provides convenient functions for\naccessing and errors for specific fields.</p>\n\n\n\n\n<p>Usually this class does not need to be instantiated directly - instances are instead created\nautomatically when <a href=\"#/api/Ext.data.Model-method-validate\" rel=\"Ext.data.Model-method-validate\" class=\"docClass\">validate</a> on a model instance:</p>\n\n\n\n\n<pre><code>//validate some existing model instance - in this case it returned 2 failures messages\nvar errors = myModel.validate();\n\nerrors.isValid(); //false\n\nerrors.length; //2\nerrors.getByField('name');  // [{field: 'name',  message: 'must be present'}]\nerrors.getByField('title'); // [{field: 'title', message: 'is too short'}]\n</code></pre>\n\n",
   5   "extends": "Ext.util.MixedCollection",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": "Ed Spencer",
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "allowFunctions",
  21       "member": "Ext.util.AbstractMixedCollection",
  22       "type": "Boolean",
  23       "doc": "<p>Specify <tt>true</tt> if the <a href=\"#/api/Ext.data.Errors-method-addAll\" rel=\"Ext.data.Errors-method-addAll\" class=\"docClass\">addAll</a>\nfunction should add function references to the collection. Defaults to\n<tt>false</tt>.</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
  26       "linenr": 62,
  27       "html_filename": "AbstractMixedCollection.html",
  28       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-cfg-allowFunctions"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "listeners",
  33       "member": "Ext.util.Observable",
  34       "type": "Object",
  35       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.data.Errors-method-addListener\" rel=\"Ext.data.Errors-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  38       "linenr": 103,
  39       "html_filename": "Observable.html",
  40       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  41       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  42     }
  43   ],
  44   "method": [
  45     {
  46       "tagname": "method",
  47       "name": "Errors",
  48       "member": "Ext.util.MixedCollection",
  49       "doc": "\n",
  50       "params": [
  51         {
  52           "type": "Boolean",
  53           "name": "allowFunctions",
  54           "doc": "<p>Specify <tt>true</tt> if the <a href=\"#/api/Ext.data.Errors-method-addAll\" rel=\"Ext.data.Errors-method-addAll\" class=\"docClass\">addAll</a>\nfunction should add function references to the collection. Defaults to\n<tt>false</tt>.</p>\n",
  55           "optional": false
  56         },
  57         {
  58           "type": "Function",
  59           "name": "keyFn",
  60           "doc": "<p>A function that can accept an item of the type(s) stored in this MixedCollection\nand return the key value for that item.  This is used when available to look up the key on items that\nwere passed without an explicit key parameter to a MixedCollection method.  Passing this parameter is\nequivalent to providing an implementation for the <a href=\"#/api/Ext.data.Errors-method-getKey\" rel=\"Ext.data.Errors-method-getKey\" class=\"docClass\">getKey</a> method.</p>\n",
  61           "optional": false
  62         }
  63       ],
  64       "return": {
  65         "type": "void",
  66         "doc": "\n"
  67       },
  68       "private": false,
  69       "static": false,
  70       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/MixedCollection.js",
  71       "linenr": 1,
  72       "html_filename": "MixedCollection.html",
  73       "href": "MixedCollection.html#Ext-util-MixedCollection-method-constructor",
  74       "shortDoc": "\n"
  75     },
  76     {
  77       "tagname": "method",
  78       "name": "add",
  79       "member": "Ext.util.AbstractMixedCollection",
  80       "doc": "<p>Adds an item to the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-add\" rel=\"Ext.data.Errors-event-add\" class=\"docClass\">add</a> event when complete.</p>\n",
  81       "params": [
  82         {
  83           "type": "String",
  84           "name": "key",
  85           "doc": "<p>The key to associate with the item, or the new item.</p>\n\n\n<p>If a <a href=\"#/api/Ext.data.Errors-method-getKey\" rel=\"Ext.data.Errors-method-getKey\" class=\"docClass\">getKey</a> implementation was specified for this MixedCollection,\nor if the key of the stored items is in a property called <tt><b>id</b></tt>,\nthe MixedCollection will be able to <i>derive</i> the key for the new item.\nIn this case just pass the new item in this parameter.</p>\n\n",
  86           "optional": false
  87         },
  88         {
  89           "type": "Object",
  90           "name": "o",
  91           "doc": "<p>The item to add.</p>\n",
  92           "optional": false
  93         }
  94       ],
  95       "return": {
  96         "type": "Object",
  97         "doc": "<p>The item added.</p>\n"
  98       },
  99       "private": false,
 100       "static": false,
 101       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 102       "linenr": 69,
 103       "html_filename": "AbstractMixedCollection.html",
 104       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-add",
 105       "shortDoc": "<p>Adds an item to the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-add\" rel=\"Ext.data.Errors-event-add\" class=\"docClass\">add</a> event when complete.</p>\n"
 106     },
 107     {
 108       "tagname": "method",
 109       "name": "addAll",
 110       "member": "Ext.util.AbstractMixedCollection",
 111       "doc": "<p>Adds all elements of an Array or an Object to the collection.</p>\n",
 112       "params": [
 113         {
 114           "type": "Object/Array",
 115           "name": "objs",
 116           "doc": "<p>An Object containing properties which will be added\nto the collection, or an Array of values, each of which are added to the collection.\nFunctions references will be added to the collection if <code><a href=\"#/api/Ext.data.Errors-cfg-allowFunctions\" rel=\"Ext.data.Errors-cfg-allowFunctions\" class=\"docClass\">allowFunctions</a></code>\nhas been set to <tt>true</tt>.</p>\n",
 117           "optional": false
 118         }
 119       ],
 120       "return": {
 121         "type": "void",
 122         "doc": "\n"
 123       },
 124       "private": false,
 125       "static": false,
 126       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 127       "linenr": 166,
 128       "html_filename": "AbstractMixedCollection.html",
 129       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-addAll",
 130       "shortDoc": "<p>Adds all elements of an Array or an Object to the collection.</p>\n"
 131     },
 132     {
 133       "tagname": "method",
 134       "name": "addEvents",
 135       "member": "Ext.util.Observable",
 136       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
 137       "params": [
 138         {
 139           "type": "Object/String",
 140           "name": "o",
 141           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
 142           "optional": false
 143         },
 144         {
 145           "type": "String",
 146           "name": "",
 147           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
 148           "optional": false
 149         }
 150       ],
 151       "return": {
 152         "type": "void",
 153         "doc": "\n"
 154       },
 155       "private": false,
 156       "static": false,
 157       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 158       "linenr": 452,
 159       "html_filename": "Observable.html",
 160       "href": "Observable.html#Ext-util-Observable-method-addEvents",
 161       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
 162     },
 163     {
 164       "tagname": "method",
 165       "name": "addListener",
 166       "member": "Ext.util.Observable",
 167       "doc": "<p>Appends an event handler to this object.</p>\n",
 168       "params": [
 169         {
 170           "type": "String",
 171           "name": "eventName",
 172           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
 173           "optional": false
 174         },
 175         {
 176           "type": "Function",
 177           "name": "handler",
 178           "doc": "<p>The method the event invokes.</p>\n",
 179           "optional": false
 180         },
 181         {
 182           "type": "Object",
 183           "name": "scope",
 184           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
 185           "optional": true
 186         },
 187         {
 188           "type": "Object",
 189           "name": "options",
 190           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
 191           "optional": true
 192         }
 193       ],
 194       "return": {
 195         "type": "void",
 196         "doc": "\n"
 197       },
 198       "private": false,
 199       "static": false,
 200       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 201       "linenr": 271,
 202       "html_filename": "Observable.html",
 203       "href": "Observable.html#Ext-util-Observable-method-addListener",
 204       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 205     },
 206     {
 207       "tagname": "method",
 208       "name": "addManagedListener",
 209       "member": "Ext.util.Observable",
 210       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 211       "params": [
 212         {
 213           "type": "Observable/Element",
 214           "name": "item",
 215           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 216           "optional": false
 217         },
 218         {
 219           "type": "Object/String",
 220           "name": "ename",
 221           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 222           "optional": false
 223         },
 224         {
 225           "type": "Function",
 226           "name": "fn",
 227           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 228           "optional": false
 229         },
 230         {
 231           "type": "Object",
 232           "name": "scope",
 233           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
 234           "optional": false
 235         },
 236         {
 237           "type": "Object",
 238           "name": "opt",
 239           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
 240           "optional": false
 241         }
 242       ],
 243       "return": {
 244         "type": "void",
 245         "doc": "\n"
 246       },
 247       "private": false,
 248       "static": false,
 249       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 250       "linenr": 155,
 251       "html_filename": "Observable.html",
 252       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 253       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 254     },
 255     {
 256       "tagname": "method",
 257       "name": "capture",
 258       "member": "Ext.util.Observable",
 259       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
 260       "params": [
 261         {
 262           "type": "Observable",
 263           "name": "o",
 264           "doc": "<p>The Observable to capture events from.</p>\n",
 265           "optional": false
 266         },
 267         {
 268           "type": "Function",
 269           "name": "fn",
 270           "doc": "<p>The function to call when an event is fired.</p>\n",
 271           "optional": false
 272         },
 273         {
 274           "type": "Object",
 275           "name": "scope",
 276           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 277           "optional": true
 278         }
 279       ],
 280       "return": {
 281         "type": "void",
 282         "doc": "\n"
 283       },
 284       "private": false,
 285       "static": true,
 286       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 287       "linenr": 55,
 288       "html_filename": "Observable.html",
 289       "href": "Observable.html#Ext-util-Observable-method-capture",
 290       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 291     },
 292     {
 293       "tagname": "method",
 294       "name": "clear",
 295       "member": "Ext.util.AbstractMixedCollection",
 296       "doc": "<p>Removes all items from the collection.  Fires the <a href=\"#/api/Ext.data.Errors-event-clear\" rel=\"Ext.data.Errors-event-clear\" class=\"docClass\">clear</a> event when complete.</p>\n",
 297       "params": [
 298
 299       ],
 300       "return": {
 301         "type": "void",
 302         "doc": "\n"
 303       },
 304       "private": false,
 305       "static": false,
 306       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 307       "linenr": 435,
 308       "html_filename": "AbstractMixedCollection.html",
 309       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-clear",
 310       "shortDoc": "<p>Removes all items from the collection.  Fires the <a href=\"#/api/Ext.data.Errors-event-clear\" rel=\"Ext.data.Errors-event-clear\" class=\"docClass\">clear</a> event when complete.</p>\n"
 311     },
 312     {
 313       "tagname": "method",
 314       "name": "clearListeners",
 315       "member": "Ext.util.Observable",
 316       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 317       "params": [
 318
 319       ],
 320       "return": {
 321         "type": "void",
 322         "doc": "\n"
 323       },
 324       "private": false,
 325       "static": false,
 326       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 327       "linenr": 383,
 328       "html_filename": "Observable.html",
 329       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 330       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 331     },
 332     {
 333       "tagname": "method",
 334       "name": "clearManagedListeners",
 335       "member": "Ext.util.Observable",
 336       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 337       "params": [
 338
 339       ],
 340       "return": {
 341         "type": "void",
 342         "doc": "\n"
 343       },
 344       "private": false,
 345       "static": false,
 346       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 347       "linenr": 412,
 348       "html_filename": "Observable.html",
 349       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 350       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 351     },
 352     {
 353       "tagname": "method",
 354       "name": "clone",
 355       "member": "Ext.util.AbstractMixedCollection",
 356       "doc": "<p>Creates a shallow copy of this collection</p>\n",
 357       "params": [
 358
 359       ],
 360       "return": {
 361         "type": "MixedCollection",
 362         "doc": "\n"
 363       },
 364       "private": false,
 365       "static": false,
 366       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 367       "linenr": 727,
 368       "html_filename": "AbstractMixedCollection.html",
 369       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-clone",
 370       "shortDoc": "<p>Creates a shallow copy of this collection</p>\n"
 371     },
 372     {
 373       "tagname": "method",
 374       "name": "collect",
 375       "member": "Ext.util.AbstractMixedCollection",
 376       "doc": "<p>Collects unique values of a particular property in this MixedCollection</p>\n",
 377       "params": [
 378         {
 379           "type": "String",
 380           "name": "property",
 381           "doc": "<p>The property to collect on</p>\n",
 382           "optional": false
 383         },
 384         {
 385           "type": "String",
 386           "name": "root",
 387           "doc": "<p>Optional 'root' property to extract the first argument from. This is used mainly when\nsumming fields in records, where the fields are all stored inside the 'data' object</p>\n",
 388           "optional": false
 389         },
 390         {
 391           "type": "Boolean",
 392           "name": "allowBlank",
 393           "doc": "<p>(optional) Pass true to allow null, undefined or empty string values</p>\n",
 394           "optional": true
 395         }
 396       ],
 397       "return": {
 398         "type": "Array",
 399         "doc": "<p>The unique values</p>\n"
 400       },
 401       "private": false,
 402       "static": false,
 403       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 404       "linenr": 489,
 405       "html_filename": "AbstractMixedCollection.html",
 406       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-collect",
 407       "shortDoc": "<p>Collects unique values of a particular property in this MixedCollection</p>\n"
 408     },
 409     {
 410       "tagname": "method",
 411       "name": "contains",
 412       "member": "Ext.util.AbstractMixedCollection",
 413       "doc": "<p>Returns true if the collection contains the passed Object as an item.</p>\n",
 414       "params": [
 415         {
 416           "type": "Object",
 417           "name": "o",
 418           "doc": "<p>The Object to look for in the collection.</p>\n",
 419           "optional": false
 420         }
 421       ],
 422       "return": {
 423         "type": "Boolean",
 424         "doc": "<p>True if the collection contains the Object as an item.</p>\n"
 425       },
 426       "private": false,
 427       "static": false,
 428       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 429       "linenr": 417,
 430       "html_filename": "AbstractMixedCollection.html",
 431       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-contains",
 432       "shortDoc": "<p>Returns true if the collection contains the passed Object as an item.</p>\n"
 433     },
 434     {
 435       "tagname": "method",
 436       "name": "containsKey",
 437       "member": "Ext.util.AbstractMixedCollection",
 438       "doc": "<p>Returns true if the collection contains the passed Object as a key.</p>\n",
 439       "params": [
 440         {
 441           "type": "String",
 442           "name": "key",
 443           "doc": "<p>The key to look for in the collection.</p>\n",
 444           "optional": false
 445         }
 446       ],
 447       "return": {
 448         "type": "Boolean",
 449         "doc": "<p>True if the collection contains the Object as a key.</p>\n"
 450       },
 451       "private": false,
 452       "static": false,
 453       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 454       "linenr": 426,
 455       "html_filename": "AbstractMixedCollection.html",
 456       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-containsKey",
 457       "shortDoc": "<p>Returns true if the collection contains the passed Object as a key.</p>\n"
 458     },
 459     {
 460       "tagname": "method",
 461       "name": "each",
 462       "member": "Ext.util.AbstractMixedCollection",
 463       "doc": "<p>Executes the specified function once for every item in the collection, passing the following arguments:</p>\n\n<div class=\"mdetail-params\"><ul>\n<li><b>item</b> : Mixed<p class=\"sub-desc\">The collection item</p></li>\n<li><b>index</b> : Number<p class=\"sub-desc\">The item's index</p></li>\n<li><b>length</b> : Number<p class=\"sub-desc\">The total number of items in the collection</p></li>\n</ul></div>\n\n\n<p>The function should return a boolean value. Returning false from the function will stop the iteration.</p>\n",
 464       "params": [
 465         {
 466           "type": "Function",
 467           "name": "fn",
 468           "doc": "<p>The function to execute for each item.</p>\n",
 469           "optional": false
 470         },
 471         {
 472           "type": "Object",
 473           "name": "scope",
 474           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the current item in the iteration.</p>\n",
 475           "optional": true
 476         }
 477       ],
 478       "return": {
 479         "type": "void",
 480         "doc": "\n"
 481       },
 482       "private": false,
 483       "static": false,
 484       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 485       "linenr": 196,
 486       "html_filename": "AbstractMixedCollection.html",
 487       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-each",
 488       "shortDoc": "Executes the specified function once for every item in the collection, passing the following arguments:\n\n\nitem : Mixe..."
 489     },
 490     {
 491       "tagname": "method",
 492       "name": "eachKey",
 493       "member": "Ext.util.AbstractMixedCollection",
 494       "doc": "<p>Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.</p>\n",
 495       "params": [
 496         {
 497           "type": "Function",
 498           "name": "fn",
 499           "doc": "<p>The function to execute for each item.</p>\n",
 500           "optional": false
 501         },
 502         {
 503           "type": "Object",
 504           "name": "scope",
 505           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</p>\n",
 506           "optional": true
 507         }
 508       ],
 509       "return": {
 510         "type": "void",
 511         "doc": "\n"
 512       },
 513       "private": false,
 514       "static": false,
 515       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 516       "linenr": 221,
 517       "html_filename": "AbstractMixedCollection.html",
 518       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-eachKey",
 519       "shortDoc": "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as th..."
 520     },
 521     {
 522       "tagname": "method",
 523       "name": "enableBubble",
 524       "member": "Ext.util.Observable",
 525       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
 526       "params": [
 527         {
 528           "type": "String/Array",
 529           "name": "events",
 530           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 531           "optional": false
 532         }
 533       ],
 534       "return": {
 535         "type": "void",
 536         "doc": "\n"
 537       },
 538       "private": false,
 539       "static": false,
 540       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 541       "linenr": 554,
 542       "html_filename": "Observable.html",
 543       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 544       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 545     },
 546     {
 547       "tagname": "method",
 548       "name": "filter",
 549       "member": "Ext.util.AbstractMixedCollection",
 550       "doc": "<p>Filters the objects in this collection by a set of <a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Filter</a>s, or by a single\nproperty/value pair with optional parameters for substring matching and case sensitivity. See\n<a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Filter</a> for an example of using Filter objects (preferred). Alternatively,\nMixedCollection can be easily filtered by property like this:</p>\n\n\n<pre><code>//create a simple store with a few people defined\nvar people = new Ext.util.MixedCollection();\npeople.addAll([\n    {id: 1, age: 25, name: 'Ed'},\n    {id: 2, age: 24, name: 'Tommy'},\n    {id: 3, age: 24, name: 'Arne'},\n    {id: 4, age: 26, name: 'Aaron'}\n]);\n\n//a new MixedCollection containing only the items where age == 24\nvar middleAged = people.filter('age', 24);\n</code></pre>\n\n",
 551       "params": [
 552         {
 553           "type": "Array/String",
 554           "name": "property",
 555           "doc": "<p>A property on your objects, or an array of <a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Filter</a> objects</p>\n",
 556           "optional": false
 557         },
 558         {
 559           "type": "String/RegExp",
 560           "name": "value",
 561           "doc": "<p>Either string that the property values\nshould start with or a RegExp to test against the property</p>\n",
 562           "optional": false
 563         },
 564         {
 565           "type": "Boolean",
 566           "name": "anyMatch",
 567           "doc": "<p>(optional) True to match any part of the string, not just the beginning</p>\n",
 568           "optional": true
 569         },
 570         {
 571           "type": "Boolean",
 572           "name": "caseSensitive",
 573           "doc": "<p>(optional) True for case sensitive comparison (defaults to False).</p>\n",
 574           "optional": true
 575         }
 576       ],
 577       "return": {
 578         "type": "MixedCollection",
 579         "doc": "<p>The new filtered collection</p>\n"
 580       },
 581       "private": false,
 582       "static": false,
 583       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 584       "linenr": 566,
 585       "html_filename": "AbstractMixedCollection.html",
 586       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-filter",
 587       "shortDoc": "Filters the objects in this collection by a set of Filters, or by a single\nproperty/value pair with optional paramete..."
 588     },
 589     {
 590       "tagname": "method",
 591       "name": "filterBy",
 592       "member": "Ext.util.AbstractMixedCollection",
 593       "doc": "<p>Filter by a function. Returns a <i>new</i> collection that has been filtered.\nThe passed function will be called with each object in the collection.\nIf the function returns true, the value is included otherwise it is filtered.</p>\n",
 594       "params": [
 595         {
 596           "type": "Function",
 597           "name": "fn",
 598           "doc": "<p>The function to be called, it will receive the args o (the object), k (the key)</p>\n",
 599           "optional": false
 600         },
 601         {
 602           "type": "Object",
 603           "name": "scope",
 604           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.</p>\n",
 605           "optional": true
 606         }
 607       ],
 608       "return": {
 609         "type": "MixedCollection",
 610         "doc": "<p>The new filtered collection</p>\n"
 611       },
 612       "private": false,
 613       "static": false,
 614       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 615       "linenr": 630,
 616       "html_filename": "AbstractMixedCollection.html",
 617       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-filterBy",
 618       "shortDoc": "Filter by a function. Returns a new collection that has been filtered.\nThe passed function will be called with each o..."
 619     },
 620     {
 621       "tagname": "method",
 622       "name": "findBy",
 623       "member": "Ext.util.AbstractMixedCollection",
 624       "doc": "<p>Returns the first item in the collection which elicits a true return value from the\npassed selection function.</p>\n",
 625       "params": [
 626         {
 627           "type": "Function",
 628           "name": "fn",
 629           "doc": "<p>The selection function to execute for each item.</p>\n",
 630           "optional": false
 631         },
 632         {
 633           "type": "Object",
 634           "name": "scope",
 635           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</p>\n",
 636           "optional": true
 637         }
 638       ],
 639       "return": {
 640         "type": "Object",
 641         "doc": "<p>The first item in the collection which returned true from the selection function.</p>\n"
 642       },
 643       "private": false,
 644       "static": false,
 645       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 646       "linenr": 238,
 647       "html_filename": "AbstractMixedCollection.html",
 648       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-findBy",
 649       "shortDoc": "<p>Returns the first item in the collection which elicits a true return value from the\npassed selection function.</p>\n"
 650     },
 651     {
 652       "tagname": "method",
 653       "name": "findIndex",
 654       "member": "Ext.util.AbstractMixedCollection",
 655       "doc": "<p>Finds the index of the first matching object in this collection by a specific property/value.</p>\n",
 656       "params": [
 657         {
 658           "type": "String",
 659           "name": "property",
 660           "doc": "<p>The name of a property on your objects.</p>\n",
 661           "optional": false
 662         },
 663         {
 664           "type": "String/RegExp",
 665           "name": "value",
 666           "doc": "<p>A string that the property values\nshould start with or a RegExp to test against the property.</p>\n",
 667           "optional": false
 668         },
 669         {
 670           "type": "Number",
 671           "name": "start",
 672           "doc": "<p>(optional) The index to start searching at (defaults to 0).</p>\n",
 673           "optional": true
 674         },
 675         {
 676           "type": "Boolean",
 677           "name": "anyMatch",
 678           "doc": "<p>(optional) True to match any part of the string, not just the beginning.</p>\n",
 679           "optional": true
 680         },
 681         {
 682           "type": "Boolean",
 683           "name": "caseSensitive",
 684           "doc": "<p>(optional) True for case sensitive comparison.</p>\n",
 685           "optional": true
 686         }
 687       ],
 688       "return": {
 689         "type": "Number",
 690         "doc": "<p>The matched index or -1</p>\n"
 691       },
 692       "private": false,
 693       "static": false,
 694       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 695       "linenr": 657,
 696       "html_filename": "AbstractMixedCollection.html",
 697       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-findIndex",
 698       "shortDoc": "<p>Finds the index of the first matching object in this collection by a specific property/value.</p>\n"
 699     },
 700     {
 701       "tagname": "method",
 702       "name": "findIndexBy",
 703       "member": "Ext.util.AbstractMixedCollection",
 704       "doc": "<p>Find the index of the first matching object in this collection by a function.\nIf the function returns <i>true</i> it is considered a match.</p>\n",
 705       "params": [
 706         {
 707           "type": "Function",
 708           "name": "fn",
 709           "doc": "<p>The function to be called, it will receive the args o (the object), k (the key).</p>\n",
 710           "optional": false
 711         },
 712         {
 713           "type": "Object",
 714           "name": "scope",
 715           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this MixedCollection.</p>\n",
 716           "optional": true
 717         },
 718         {
 719           "type": "Number",
 720           "name": "start",
 721           "doc": "<p>(optional) The index to start searching at (defaults to 0).</p>\n",
 722           "optional": true
 723         }
 724       ],
 725       "return": {
 726         "type": "Number",
 727         "doc": "<p>The matched index or -1</p>\n"
 728       },
 729       "private": false,
 730       "static": false,
 731       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 732       "linenr": 677,
 733       "html_filename": "AbstractMixedCollection.html",
 734       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-findIndexBy",
 735       "shortDoc": "Find the index of the first matching object in this collection by a function.\nIf the function returns true it is cons..."
 736     },
 737     {
 738       "tagname": "method",
 739       "name": "fireEvent",
 740       "member": "Ext.util.Observable",
 741       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.data.Errors-method-enableBubble\" rel=\"Ext.data.Errors-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 742       "params": [
 743         {
 744           "type": "String",
 745           "name": "eventName",
 746           "doc": "<p>The name of the event to fire.</p>\n",
 747           "optional": false
 748         },
 749         {
 750           "type": "Object...",
 751           "name": "args",
 752           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 753           "optional": false
 754         }
 755       ],
 756       "return": {
 757         "type": "Boolean",
 758         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 759       },
 760       "private": false,
 761       "static": false,
 762       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 763       "linenr": 232,
 764       "html_filename": "Observable.html",
 765       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 766       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
 767     },
 768     {
 769       "tagname": "method",
 770       "name": "first",
 771       "member": "Ext.util.AbstractMixedCollection",
 772       "doc": "<p>Returns the first item in the collection.</p>\n",
 773       "params": [
 774
 775       ],
 776       "return": {
 777         "type": "Object",
 778         "doc": "<p>the first item in the collection..</p>\n"
 779       },
 780       "private": false,
 781       "static": false,
 782       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 783       "linenr": 448,
 784       "html_filename": "AbstractMixedCollection.html",
 785       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-first",
 786       "shortDoc": "<p>Returns the first item in the collection.</p>\n"
 787     },
 788     {
 789       "tagname": "method",
 790       "name": "get",
 791       "member": "Ext.util.AbstractMixedCollection",
 792       "doc": "<p>Returns the item associated with the passed key OR index.\nKey has priority over index.  This is the equivalent\nof calling <a href=\"#/api/Ext.data.Errors--key\" rel=\"Ext.data.Errors--key\" class=\"docClass\">key</a> first, then if nothing matched calling <a href=\"#/api/Ext.data.Errors-method-getAt\" rel=\"Ext.data.Errors-method-getAt\" class=\"docClass\">getAt</a>.</p>\n",
 793       "params": [
 794         {
 795           "type": "String/Number",
 796           "name": "key",
 797           "doc": "<p>The key or index of the item.</p>\n",
 798           "optional": false
 799         }
 800       ],
 801       "return": {
 802         "type": "Object",
 803         "doc": "<p>If the item is found, returns the item.  If the item was not found, returns <tt>undefined</tt>.\nIf an item was found, but is a Class, returns <tt>null</tt>.</p>\n"
 804       },
 805       "private": false,
 806       "static": false,
 807       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 808       "linenr": 384,
 809       "html_filename": "AbstractMixedCollection.html",
 810       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-get",
 811       "shortDoc": "Returns the item associated with the passed key OR index.\nKey has priority over index.  This is the equivalent\nof cal..."
 812     },
 813     {
 814       "tagname": "method",
 815       "name": "getAt",
 816       "member": "Ext.util.AbstractMixedCollection",
 817       "doc": "<p>Returns the item at the specified index.</p>\n",
 818       "params": [
 819         {
 820           "type": "Number",
 821           "name": "index",
 822           "doc": "<p>The index of the item.</p>\n",
 823           "optional": false
 824         }
 825       ],
 826       "return": {
 827         "type": "Object",
 828         "doc": "<p>The item at the specified index.</p>\n"
 829       },
 830       "private": false,
 831       "static": false,
 832       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 833       "linenr": 399,
 834       "html_filename": "AbstractMixedCollection.html",
 835       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getAt",
 836       "shortDoc": "<p>Returns the item at the specified index.</p>\n"
 837     },
 838     {
 839       "tagname": "method",
 840       "name": "getByField",
 841       "member": "Ext.data.Errors",
 842       "doc": "<p>Returns all of the errors for the given field</p>\n",
 843       "params": [
 844         {
 845           "type": "String",
 846           "name": "fieldName",
 847           "doc": "<p>The field to get errors for</p>\n",
 848           "optional": false
 849         }
 850       ],
 851       "return": {
 852         "type": "Array",
 853         "doc": "<p>All errors for the given field</p>\n"
 854       },
 855       "private": false,
 856       "static": false,
 857       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Errors.js",
 858       "linenr": 34,
 859       "html_filename": "Errors.html",
 860       "href": "Errors.html#Ext-data-Errors-method-getByField",
 861       "shortDoc": "<p>Returns all of the errors for the given field</p>\n"
 862     },
 863     {
 864       "tagname": "method",
 865       "name": "getByKey",
 866       "member": "Ext.util.AbstractMixedCollection",
 867       "doc": "<p>Returns the item associated with the passed key.</p>\n",
 868       "params": [
 869         {
 870           "type": "String/Number",
 871           "name": "key",
 872           "doc": "<p>The key of the item.</p>\n",
 873           "optional": false
 874         }
 875       ],
 876       "return": {
 877         "type": "Object",
 878         "doc": "<p>The item associated with the passed key.</p>\n"
 879       },
 880       "private": false,
 881       "static": false,
 882       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 883       "linenr": 408,
 884       "html_filename": "AbstractMixedCollection.html",
 885       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getByKey",
 886       "shortDoc": "<p>Returns the item associated with the passed key.</p>\n"
 887     },
 888     {
 889       "tagname": "method",
 890       "name": "getCount",
 891       "member": "Ext.util.AbstractMixedCollection",
 892       "doc": "<p>Returns the number of items in the collection.</p>\n",
 893       "params": [
 894
 895       ],
 896       "return": {
 897         "type": "Number",
 898         "doc": "<p>the number of items in the collection.</p>\n"
 899       },
 900       "private": false,
 901       "static": false,
 902       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 903       "linenr": 358,
 904       "html_filename": "AbstractMixedCollection.html",
 905       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getCount",
 906       "shortDoc": "<p>Returns the number of items in the collection.</p>\n"
 907     },
 908     {
 909       "tagname": "method",
 910       "name": "getKey",
 911       "member": "Ext.util.AbstractMixedCollection",
 912       "doc": "<p>MixedCollection has a generic way to fetch keys if you implement getKey.  The default implementation\nsimply returns <b><code>item.id</code></b> but you can provide your own implementation\nto return a different value as in the following examples:</p>\n\n<pre><code>// normal way\nvar mc = new Ext.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Ext.util.MixedCollection();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Ext.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n</code></pre>\n\n",
 913       "params": [
 914         {
 915           "type": "Object",
 916           "name": "item",
 917           "doc": "<p>The item for which to find the key.</p>\n",
 918           "optional": false
 919         }
 920       ],
 921       "return": {
 922         "type": "Object",
 923         "doc": "<p>The key for the passed item.</p>\n"
 924       },
 925       "private": false,
 926       "static": false,
 927       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 928       "linenr": 103,
 929       "html_filename": "AbstractMixedCollection.html",
 930       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getKey",
 931       "shortDoc": "MixedCollection has a generic way to fetch keys if you implement getKey.  The default implementation\nsimply returns i..."
 932     },
 933     {
 934       "tagname": "method",
 935       "name": "getRange",
 936       "member": "Ext.util.AbstractMixedCollection",
 937       "doc": "<p>Returns a range of items in this collection</p>\n",
 938       "params": [
 939         {
 940           "type": "Number",
 941           "name": "startIndex",
 942           "doc": "<p>(optional) The starting index. Defaults to 0.</p>\n",
 943           "optional": true
 944         },
 945         {
 946           "type": "Number",
 947           "name": "endIndex",
 948           "doc": "<p>(optional) The ending index. Defaults to the last item.</p>\n",
 949           "optional": true
 950         }
 951       ],
 952       "return": {
 953         "type": "Array",
 954         "doc": "<p>An array of items</p>\n"
 955       },
 956       "private": false,
 957       "static": false,
 958       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
 959       "linenr": 536,
 960       "html_filename": "AbstractMixedCollection.html",
 961       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getRange",
 962       "shortDoc": "<p>Returns a range of items in this collection</p>\n"
 963     },
 964     {
 965       "tagname": "method",
 966       "name": "hasListener",
 967       "member": "Ext.util.Observable",
 968       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 969       "params": [
 970         {
 971           "type": "String",
 972           "name": "eventName",
 973           "doc": "<p>The name of the event to check for</p>\n",
 974           "optional": false
 975         }
 976       ],
 977       "return": {
 978         "type": "Boolean",
 979         "doc": "<p>True if the event is being listened for, else false</p>\n"
 980       },
 981       "private": false,
 982       "static": false,
 983       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 984       "linenr": 480,
 985       "html_filename": "Observable.html",
 986       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 987       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 988     },
 989     {
 990       "tagname": "method",
 991       "name": "indexOf",
 992       "member": "Ext.util.AbstractMixedCollection",
 993       "doc": "<p>Returns index within the collection of the passed Object.</p>\n",
 994       "params": [
 995         {
 996           "type": "Object",
 997           "name": "o",
 998           "doc": "<p>The item to find the index of.</p>\n",
 999           "optional": false
1000         }
1001       ],
1002       "return": {
1003         "type": "Number",
1004         "doc": "<p>index of the item. Returns -1 if not found.</p>\n"
1005       },
1006       "private": false,
1007       "static": false,
1008       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1009       "linenr": 366,
1010       "html_filename": "AbstractMixedCollection.html",
1011       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-indexOf",
1012       "shortDoc": "<p>Returns index within the collection of the passed Object.</p>\n"
1013     },
1014     {
1015       "tagname": "method",
1016       "name": "indexOfKey",
1017       "member": "Ext.util.AbstractMixedCollection",
1018       "doc": "<p>Returns index within the collection of the passed key.</p>\n",
1019       "params": [
1020         {
1021           "type": "String",
1022           "name": "key",
1023           "doc": "<p>The key to find the index of.</p>\n",
1024           "optional": false
1025         }
1026       ],
1027       "return": {
1028         "type": "Number",
1029         "doc": "<p>index of the key.</p>\n"
1030       },
1031       "private": false,
1032       "static": false,
1033       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1034       "linenr": 375,
1035       "html_filename": "AbstractMixedCollection.html",
1036       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-indexOfKey",
1037       "shortDoc": "<p>Returns index within the collection of the passed key.</p>\n"
1038     },
1039     {
1040       "tagname": "method",
1041       "name": "initSortable",
1042       "member": "Ext.util.Sortable",
1043       "doc": "<p>Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.</p>\n",
1044       "params": [
1045
1046       ],
1047       "return": {
1048         "type": "void",
1049         "doc": "\n"
1050       },
1051       "private": false,
1052       "static": false,
1053       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
1054       "linenr": 37,
1055       "html_filename": "Sortable.html",
1056       "href": "Sortable.html#Ext-util-Sortable-method-initSortable",
1057       "shortDoc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own in..."
1058     },
1059     {
1060       "tagname": "method",
1061       "name": "insert",
1062       "member": "Ext.util.AbstractMixedCollection",
1063       "doc": "<p>Inserts an item at the specified index in the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-add\" rel=\"Ext.data.Errors-event-add\" class=\"docClass\">add</a> event when complete.</p>\n",
1064       "params": [
1065         {
1066           "type": "Number",
1067           "name": "index",
1068           "doc": "<p>The index to insert the item at.</p>\n",
1069           "optional": false
1070         },
1071         {
1072           "type": "String",
1073           "name": "key",
1074           "doc": "<p>The key to associate with the new item, or the item itself.</p>\n",
1075           "optional": false
1076         },
1077         {
1078           "type": "Object",
1079           "name": "o",
1080           "doc": "<p>(optional) If the second parameter was a key, the new item.</p>\n",
1081           "optional": true
1082         }
1083       ],
1084       "return": {
1085         "type": "Object",
1086         "doc": "<p>The item inserted.</p>\n"
1087       },
1088       "private": false,
1089       "static": false,
1090       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1091       "linenr": 268,
1092       "html_filename": "AbstractMixedCollection.html",
1093       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-insert",
1094       "shortDoc": "<p>Inserts an item at the specified index in the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-add\" rel=\"Ext.data.Errors-event-add\" class=\"docClass\">add</a> event when complete.</p>\n"
1095     },
1096     {
1097       "tagname": "method",
1098       "name": "isValid",
1099       "member": "Ext.data.Errors",
1100       "doc": "<p>Returns true if there are no errors in the collection</p>\n",
1101       "params": [
1102
1103       ],
1104       "return": {
1105         "type": "Boolean",
1106         "doc": "\n"
1107       },
1108       "private": false,
1109       "static": false,
1110       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Errors.js",
1111       "linenr": 26,
1112       "html_filename": "Errors.html",
1113       "href": "Errors.html#Ext-data-Errors-method-isValid",
1114       "shortDoc": "<p>Returns true if there are no errors in the collection</p>\n"
1115     },
1116     {
1117       "tagname": "method",
1118       "name": "last",
1119       "member": "Ext.util.AbstractMixedCollection",
1120       "doc": "<p>Returns the last item in the collection.</p>\n",
1121       "params": [
1122
1123       ],
1124       "return": {
1125         "type": "Object",
1126         "doc": "<p>the last item in the collection..</p>\n"
1127       },
1128       "private": false,
1129       "static": false,
1130       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1131       "linenr": 456,
1132       "html_filename": "AbstractMixedCollection.html",
1133       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-last",
1134       "shortDoc": "<p>Returns the last item in the collection.</p>\n"
1135     },
1136     {
1137       "tagname": "method",
1138       "name": "observe",
1139       "member": "Ext.util.Observable",
1140       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
1141       "params": [
1142         {
1143           "type": "Function",
1144           "name": "c",
1145           "doc": "<p>The class constructor to make observable.</p>\n",
1146           "optional": false
1147         },
1148         {
1149           "type": "Object",
1150           "name": "listeners",
1151           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.data.Errors-method-addListener\" rel=\"Ext.data.Errors-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
1152           "optional": false
1153         }
1154       ],
1155       "return": {
1156         "type": "void",
1157         "doc": "\n"
1158       },
1159       "private": false,
1160       "static": true,
1161       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1162       "linenr": 69,
1163       "html_filename": "Observable.html",
1164       "href": "Observable.html#Ext-util-Observable-method-observe",
1165       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
1166     },
1167     {
1168       "tagname": "method",
1169       "name": "on",
1170       "member": "Ext.util.Observable",
1171       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.Errors-method-addListener\" rel=\"Ext.data.Errors-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
1172       "params": [
1173         {
1174           "type": "String",
1175           "name": "eventName",
1176           "doc": "<p>The type of event to listen for</p>\n",
1177           "optional": false
1178         },
1179         {
1180           "type": "Function",
1181           "name": "handler",
1182           "doc": "<p>The method the event invokes</p>\n",
1183           "optional": false
1184         },
1185         {
1186           "type": "Object",
1187           "name": "scope",
1188           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
1189           "optional": true
1190         },
1191         {
1192           "type": "Object",
1193           "name": "options",
1194           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
1195           "optional": true
1196         }
1197       ],
1198       "return": {
1199         "type": "void",
1200         "doc": "\n"
1201       },
1202       "private": false,
1203       "static": false,
1204       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1205       "linenr": 616,
1206       "html_filename": "Observable.html",
1207       "href": "Observable.html#Ext-util-Observable-method-on",
1208       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.Errors-method-addListener\" rel=\"Ext.data.Errors-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
1209     },
1210     {
1211       "tagname": "method",
1212       "name": "relayEvents",
1213       "member": "Ext.util.Observable",
1214       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
1215       "params": [
1216         {
1217           "type": "Object",
1218           "name": "origin",
1219           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
1220           "optional": false
1221         },
1222         {
1223           "type": "Array",
1224           "name": "events",
1225           "doc": "<p>Array of event names to relay.</p>\n",
1226           "optional": false
1227         },
1228         {
1229           "type": "Object",
1230           "name": "prefix",
1231           "doc": "\n",
1232           "optional": false
1233         }
1234       ],
1235       "return": {
1236         "type": "void",
1237         "doc": "\n"
1238       },
1239       "private": false,
1240       "static": false,
1241       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1242       "linenr": 520,
1243       "html_filename": "Observable.html",
1244       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
1245       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
1246     },
1247     {
1248       "tagname": "method",
1249       "name": "releaseCapture",
1250       "member": "Ext.util.Observable",
1251       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
1252       "params": [
1253         {
1254           "type": "Observable",
1255           "name": "o",
1256           "doc": "<p>The Observable to release</p>\n",
1257           "optional": false
1258         }
1259       ],
1260       "return": {
1261         "type": "void",
1262         "doc": "\n"
1263       },
1264       "private": false,
1265       "static": true,
1266       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1267       "linenr": 46,
1268       "html_filename": "Observable.html",
1269       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
1270       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
1271     },
1272     {
1273       "tagname": "method",
1274       "name": "remove",
1275       "member": "Ext.util.AbstractMixedCollection",
1276       "doc": "<p>Remove an item from the collection.</p>\n",
1277       "params": [
1278         {
1279           "type": "Object",
1280           "name": "o",
1281           "doc": "<p>The item to remove.</p>\n",
1282           "optional": false
1283         }
1284       ],
1285       "return": {
1286         "type": "Object",
1287         "doc": "<p>The item removed or false if no item was removed.</p>\n"
1288       },
1289       "private": false,
1290       "static": false,
1291       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1292       "linenr": 302,
1293       "html_filename": "AbstractMixedCollection.html",
1294       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-remove",
1295       "shortDoc": "<p>Remove an item from the collection.</p>\n"
1296     },
1297     {
1298       "tagname": "method",
1299       "name": "removeAll",
1300       "member": "Ext.util.AbstractMixedCollection",
1301       "doc": "<p>Remove all items in the passed array from the collection.</p>\n",
1302       "params": [
1303         {
1304           "type": "Array",
1305           "name": "items",
1306           "doc": "<p>An array of items to be removed.</p>\n",
1307           "optional": false
1308         }
1309       ],
1310       "return": {
1311         "type": "Ext.util.MixedCollection",
1312         "doc": "<p>this object</p>\n"
1313       },
1314       "private": false,
1315       "static": false,
1316       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1317       "linenr": 311,
1318       "html_filename": "AbstractMixedCollection.html",
1319       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-removeAll",
1320       "shortDoc": "<p>Remove all items in the passed array from the collection.</p>\n"
1321     },
1322     {
1323       "tagname": "method",
1324       "name": "removeAt",
1325       "member": "Ext.util.AbstractMixedCollection",
1326       "doc": "<p>Remove an item from a specified index in the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-remove\" rel=\"Ext.data.Errors-event-remove\" class=\"docClass\">remove</a> event when complete.</p>\n",
1327       "params": [
1328         {
1329           "type": "Number",
1330           "name": "index",
1331           "doc": "<p>The index within the collection of the item to remove.</p>\n",
1332           "optional": false
1333         }
1334       ],
1335       "return": {
1336         "type": "Object",
1337         "doc": "<p>The item removed or false if no item was removed.</p>\n"
1338       },
1339       "private": false,
1340       "static": false,
1341       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1342       "linenr": 324,
1343       "html_filename": "AbstractMixedCollection.html",
1344       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-removeAt",
1345       "shortDoc": "<p>Remove an item from a specified index in the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-remove\" rel=\"Ext.data.Errors-event-remove\" class=\"docClass\">remove</a> event when complete.</p>\n"
1346     },
1347     {
1348       "tagname": "method",
1349       "name": "removeAtKey",
1350       "member": "Ext.util.AbstractMixedCollection",
1351       "doc": "<p>Removed an item associated with the passed key fom the collection.</p>\n",
1352       "params": [
1353         {
1354           "type": "String",
1355           "name": "key",
1356           "doc": "<p>The key of the item to remove.</p>\n",
1357           "optional": false
1358         }
1359       ],
1360       "return": {
1361         "type": "Object",
1362         "doc": "<p>The item removed or false if no item was removed.</p>\n"
1363       },
1364       "private": false,
1365       "static": false,
1366       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1367       "linenr": 349,
1368       "html_filename": "AbstractMixedCollection.html",
1369       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-removeAtKey",
1370       "shortDoc": "<p>Removed an item associated with the passed key fom the collection.</p>\n"
1371     },
1372     {
1373       "tagname": "method",
1374       "name": "removeListener",
1375       "member": "Ext.util.Observable",
1376       "doc": "<p>Removes an event handler.</p>\n",
1377       "params": [
1378         {
1379           "type": "String",
1380           "name": "eventName",
1381           "doc": "<p>The type of event the handler was associated with.</p>\n",
1382           "optional": false
1383         },
1384         {
1385           "type": "Function",
1386           "name": "handler",
1387           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.Errors-method-addListener\" rel=\"Ext.data.Errors-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1388           "optional": false
1389         },
1390         {
1391           "type": "Object",
1392           "name": "scope",
1393           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1394           "optional": true
1395         }
1396       ],
1397       "return": {
1398         "type": "void",
1399         "doc": "\n"
1400       },
1401       "private": false,
1402       "static": false,
1403       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1404       "linenr": 352,
1405       "html_filename": "Observable.html",
1406       "href": "Observable.html#Ext-util-Observable-method-removeListener",
1407       "shortDoc": "<p>Removes an event handler.</p>\n"
1408     },
1409     {
1410       "tagname": "method",
1411       "name": "removeManagedListener",
1412       "member": "Ext.util.Observable",
1413       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.Errors--mon\" rel=\"Ext.data.Errors--mon\" class=\"docClass\">mon</a> method.</p>\n",
1414       "params": [
1415         {
1416           "type": "Observable|Element",
1417           "name": "item",
1418           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1419           "optional": false
1420         },
1421         {
1422           "type": "Object|String",
1423           "name": "ename",
1424           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1425           "optional": false
1426         },
1427         {
1428           "type": "Function",
1429           "name": "fn",
1430           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
1431           "optional": false
1432         },
1433         {
1434           "type": "Object",
1435           "name": "scope",
1436           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
1437           "optional": false
1438         }
1439       ],
1440       "return": {
1441         "type": "void",
1442         "doc": "\n"
1443       },
1444       "private": false,
1445       "static": false,
1446       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1447       "linenr": 196,
1448       "html_filename": "Observable.html",
1449       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1450       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.Errors--mon\" rel=\"Ext.data.Errors--mon\" class=\"docClass\">mon</a> method.</p>\n"
1451     },
1452     {
1453       "tagname": "method",
1454       "name": "reorder",
1455       "member": "Ext.util.MixedCollection",
1456       "doc": "<p>Reorders each of the items based on a mapping from old index to new index. Internally this\njust translates into a sort. The 'sort' event is fired whenever reordering has occured.</p>\n",
1457       "params": [
1458         {
1459           "type": "Object",
1460           "name": "mapping",
1461           "doc": "<p>Mapping from old item index to new item index</p>\n",
1462           "optional": false
1463         }
1464       ],
1465       "return": {
1466         "type": "void",
1467         "doc": "\n"
1468       },
1469       "private": false,
1470       "static": false,
1471       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/MixedCollection.js",
1472       "linenr": 151,
1473       "html_filename": "MixedCollection.html",
1474       "href": "MixedCollection.html#Ext-util-MixedCollection-method-reorder",
1475       "shortDoc": "Reorders each of the items based on a mapping from old index to new index. Internally this\njust translates into a sor..."
1476     },
1477     {
1478       "tagname": "method",
1479       "name": "replace",
1480       "member": "Ext.util.AbstractMixedCollection",
1481       "doc": "<p>Replaces an item in the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-replace\" rel=\"Ext.data.Errors-event-replace\" class=\"docClass\">replace</a> event when complete.</p>\n",
1482       "params": [
1483         {
1484           "type": "String",
1485           "name": "key",
1486           "doc": "<p>The key associated with the item to replace, or the replacement item.</p>\n\n\n<p>If you supplied a <a href=\"#/api/Ext.data.Errors-method-getKey\" rel=\"Ext.data.Errors-method-getKey\" class=\"docClass\">getKey</a> implementation for this MixedCollection, or if the key\nof your stored items is in a property called <tt><b>id</b></tt>, then the MixedCollection\nwill be able to <i>derive</i> the key of the replacement item. If you want to replace an item\nwith one having the same key value, then just pass the replacement item in this parameter.</p>\n\n",
1487           "optional": false
1488         },
1489         {
1490           "type": "Object",
1491           "name": "o",
1492           "doc": "<p>{Object} o (optional) If the first parameter passed was a key, the item to associate\nwith that key.</p>\n",
1493           "optional": true
1494         }
1495       ],
1496       "return": {
1497         "type": "Object",
1498         "doc": "<p>The new item.</p>\n"
1499       },
1500       "private": false,
1501       "static": false,
1502       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1503       "linenr": 135,
1504       "html_filename": "AbstractMixedCollection.html",
1505       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-replace",
1506       "shortDoc": "<p>Replaces an item in the collection. Fires the <a href=\"#/api/Ext.data.Errors-event-replace\" rel=\"Ext.data.Errors-event-replace\" class=\"docClass\">replace</a> event when complete.</p>\n"
1507     },
1508     {
1509       "tagname": "method",
1510       "name": "resumeEvents",
1511       "member": "Ext.util.Observable",
1512       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.data.Errors-method-suspendEvents\" rel=\"Ext.data.Errors-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
1513       "params": [
1514
1515       ],
1516       "return": {
1517         "type": "void",
1518         "doc": "\n"
1519       },
1520       "private": false,
1521       "static": false,
1522       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1523       "linenr": 502,
1524       "html_filename": "Observable.html",
1525       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1526       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
1527     },
1528     {
1529       "tagname": "method",
1530       "name": "sort",
1531       "member": "Ext.util.Sortable",
1532       "doc": "<p>Sorts the data in the Store by one or more of its properties. Example usage:</p>\n\n\n<pre><code>//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n    {\n        property : 'age',\n        direction: 'ASC'\n    },\n    {\n        property : 'name',\n        direction: 'DESC'\n    }\n]);\n</code></pre>\n\n\n<p>Internally, Store converts the passed arguments into an array of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Ext.util.Sorter</a> instances, and delegates the actual\nsorting to its internal <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">Ext.util.MixedCollection</a>.</p>\n\n\n<p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>\n\n\n<pre><code>store.sort('myField');\nstore.sort('myField');\n     </code></pre>\n\n\n<p>Is equivalent to this code, because Store handles the toggling automatically:</p>\n\n\n<pre><code>store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n</code></pre>\n\n",
1533       "params": [
1534         {
1535           "type": "String|Array",
1536           "name": "sorters",
1537           "doc": "<p>Either a string name of one of the fields in this Store's configured <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>,\nor an Array of sorter configurations.</p>\n",
1538           "optional": false
1539         },
1540         {
1541           "type": "String",
1542           "name": "direction",
1543           "doc": "<p>The overall direction to sort the data by. Defaults to \"ASC\".</p>\n",
1544           "optional": false
1545         },
1546         {
1547           "type": "Object",
1548           "name": "where",
1549           "doc": "\n",
1550           "optional": false
1551         },
1552         {
1553           "type": "Object",
1554           "name": "doSort",
1555           "doc": "\n",
1556           "optional": false
1557         }
1558       ],
1559       "return": {
1560         "type": "void",
1561         "doc": "\n"
1562       },
1563       "private": false,
1564       "static": false,
1565       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
1566       "linenr": 59,
1567       "html_filename": "Sortable.html",
1568       "href": "Sortable.html#Ext-util-Sortable-method-sort",
1569       "shortDoc": "Sorts the data in the Store by one or more of its properties. Example usage:\n\n\n//sort by a single field\nmyStore.sort(..."
1570     },
1571     {
1572       "tagname": "method",
1573       "name": "sortBy",
1574       "member": "Ext.util.MixedCollection",
1575       "doc": "<p>Sorts the collection by a single sorter function</p>\n",
1576       "params": [
1577         {
1578           "type": "Function",
1579           "name": "sorterFn",
1580           "doc": "<p>The function to sort by</p>\n",
1581           "optional": false
1582         }
1583       ],
1584       "return": {
1585         "type": "void",
1586         "doc": "\n"
1587       },
1588       "private": false,
1589       "static": false,
1590       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/MixedCollection.js",
1591       "linenr": 112,
1592       "html_filename": "MixedCollection.html",
1593       "href": "MixedCollection.html#Ext-util-MixedCollection-method-sortBy",
1594       "shortDoc": "<p>Sorts the collection by a single sorter function</p>\n"
1595     },
1596     {
1597       "tagname": "method",
1598       "name": "sortByKey",
1599       "member": "Ext.util.MixedCollection",
1600       "doc": "<p>Sorts this collection by <b>key</b>s.</p>\n",
1601       "params": [
1602         {
1603           "type": "String",
1604           "name": "direction",
1605           "doc": "<p>(optional) 'ASC' or 'DESC'. Defaults to 'ASC'.</p>\n",
1606           "optional": true
1607         },
1608         {
1609           "type": "Function",
1610           "name": "fn",
1611           "doc": "<p>(optional) Comparison function that defines the sort order.\nDefaults to sorting by case insensitive string.</p>\n",
1612           "optional": true
1613         }
1614       ],
1615       "return": {
1616         "type": "void",
1617         "doc": "\n"
1618       },
1619       "private": false,
1620       "static": false,
1621       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/MixedCollection.js",
1622       "linenr": 191,
1623       "html_filename": "MixedCollection.html",
1624       "href": "MixedCollection.html#Ext-util-MixedCollection-method-sortByKey",
1625       "shortDoc": "<p>Sorts this collection by <b>key</b>s.</p>\n"
1626     },
1627     {
1628       "tagname": "method",
1629       "name": "sum",
1630       "member": "Ext.util.AbstractMixedCollection",
1631       "doc": "<p>Collects all of the values of the given property and returns their sum</p>\n",
1632       "params": [
1633         {
1634           "type": "String",
1635           "name": "property",
1636           "doc": "<p>The property to sum by</p>\n",
1637           "optional": false
1638         },
1639         {
1640           "type": "String",
1641           "name": "root",
1642           "doc": "<p>Optional 'root' property to extract the first argument from. This is used mainly when\nsumming fields in records, where the fields are all stored inside the 'data' object</p>\n",
1643           "optional": false
1644         },
1645         {
1646           "type": "Number",
1647           "name": "start",
1648           "doc": "<p>(optional) The record index to start at (defaults to <tt>0</tt>)</p>\n",
1649           "optional": true
1650         },
1651         {
1652           "type": "Number",
1653           "name": "end",
1654           "doc": "<p>(optional) The record index to end at (defaults to <tt>-1</tt>)</p>\n",
1655           "optional": true
1656         }
1657       ],
1658       "return": {
1659         "type": "Number",
1660         "doc": "<p>The total</p>\n"
1661       },
1662       "private": false,
1663       "static": false,
1664       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1665       "linenr": 464,
1666       "html_filename": "AbstractMixedCollection.html",
1667       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-sum",
1668       "shortDoc": "<p>Collects all of the values of the given property and returns their sum</p>\n"
1669     },
1670     {
1671       "tagname": "method",
1672       "name": "suspendEvents",
1673       "member": "Ext.util.Observable",
1674       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.Errors-method-resumeEvents\" rel=\"Ext.data.Errors-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1675       "params": [
1676         {
1677           "type": "Boolean",
1678           "name": "queueSuspended",
1679           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.data.Errors-method-resumeEvents\" rel=\"Ext.data.Errors-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
1680           "optional": false
1681         }
1682       ],
1683       "return": {
1684         "type": "void",
1685         "doc": "\n"
1686       },
1687       "private": false,
1688       "static": false,
1689       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1690       "linenr": 490,
1691       "html_filename": "Observable.html",
1692       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1693       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.Errors-method-resumeEvents\" rel=\"Ext.data.Errors-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
1694     },
1695     {
1696       "tagname": "method",
1697       "name": "un",
1698       "member": "Ext.util.Observable",
1699       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.Errors-method-removeListener\" rel=\"Ext.data.Errors-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
1700       "params": [
1701         {
1702           "type": "String",
1703           "name": "eventName",
1704           "doc": "<p>The type of event the handler was associated with.</p>\n",
1705           "optional": false
1706         },
1707         {
1708           "type": "Function",
1709           "name": "handler",
1710           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.Errors-method-addListener\" rel=\"Ext.data.Errors-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1711           "optional": false
1712         },
1713         {
1714           "type": "Object",
1715           "name": "scope",
1716           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1717           "optional": true
1718         }
1719       ],
1720       "return": {
1721         "type": "void",
1722         "doc": "\n"
1723       },
1724       "private": false,
1725       "static": false,
1726       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1727       "linenr": 608,
1728       "html_filename": "Observable.html",
1729       "href": "Observable.html#Ext-util-Observable-method-un",
1730       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.Errors-method-removeListener\" rel=\"Ext.data.Errors-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
1731     }
1732   ],
1733   "property": [
1734     {
1735       "tagname": "property",
1736       "name": "defaultSortDirection",
1737       "member": "Ext.util.Sortable",
1738       "type": "String",
1739       "doc": "<p>The default sort direction to use if one is not specified (defaults to \"ASC\")</p>\n",
1740       "private": false,
1741       "static": false,
1742       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
1743       "linenr": 20,
1744       "html_filename": "Sortable.html",
1745       "href": "Sortable.html#Ext-util-Sortable-property-defaultSortDirection"
1746     },
1747     {
1748       "tagname": "property",
1749       "name": "isSortable",
1750       "member": "Ext.util.Sortable",
1751       "type": "Boolean",
1752       "doc": "<p>Flag denoting that this object is sortable. Always true.</p>\n",
1753       "private": false,
1754       "static": false,
1755       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
1756       "linenr": 13,
1757       "html_filename": "Sortable.html",
1758       "href": "Sortable.html#Ext-util-Sortable-property-isSortable"
1759     },
1760     {
1761       "tagname": "property",
1762       "name": "sortRoot",
1763       "member": "Ext.util.Sortable",
1764       "type": "String",
1765       "doc": "<p>The property in each item that contains the data to sort. (defaults to null)</p>\n",
1766       "private": false,
1767       "static": false,
1768       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
1769       "linenr": 31,
1770       "html_filename": "Sortable.html",
1771       "href": "Sortable.html#Ext-util-Sortable-property-sortRoot"
1772     },
1773     {
1774       "tagname": "property",
1775       "name": "sorters",
1776       "member": "Ext.util.Sortable",
1777       "type": "Ext.util.MixedCollection",
1778       "doc": "<p>The collection of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Sorters</a> currently applied to this Store</p>\n",
1779       "private": false,
1780       "static": false,
1781       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
1782       "linenr": 45,
1783       "html_filename": "Sortable.html",
1784       "href": "Sortable.html#Ext-util-Sortable-property-sorters"
1785     }
1786   ],
1787   "event": [
1788     {
1789       "tagname": "event",
1790       "name": "add",
1791       "member": "Ext.util.AbstractMixedCollection",
1792       "doc": "<p>Fires when an item is added to the collection.</p>\n",
1793       "params": [
1794         {
1795           "type": "Number",
1796           "name": "index",
1797           "doc": "<p>The index at which the item was added.</p>\n",
1798           "optional": false
1799         },
1800         {
1801           "type": "Object",
1802           "name": "o",
1803           "doc": "<p>The item added.</p>\n",
1804           "optional": false
1805         },
1806         {
1807           "type": "String",
1808           "name": "key",
1809           "doc": "<p>The key associated with the added item.</p>\n",
1810           "optional": false
1811         }
1812       ],
1813       "private": false,
1814       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1815       "linenr": 26,
1816       "html_filename": "AbstractMixedCollection.html",
1817       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-add",
1818       "shortDoc": "<p>Fires when an item is added to the collection.</p>\n"
1819     },
1820     {
1821       "tagname": "event",
1822       "name": "clear",
1823       "member": "Ext.util.AbstractMixedCollection",
1824       "doc": "<p>Fires when the collection is cleared.</p>\n",
1825       "params": [
1826
1827       ],
1828       "private": false,
1829       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1830       "linenr": 20,
1831       "html_filename": "AbstractMixedCollection.html",
1832       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-clear",
1833       "shortDoc": "<p>Fires when the collection is cleared.</p>\n"
1834     },
1835     {
1836       "tagname": "event",
1837       "name": "remove",
1838       "member": "Ext.util.AbstractMixedCollection",
1839       "doc": "<p>Fires when an item is removed from the collection.</p>\n",
1840       "params": [
1841         {
1842           "type": "Object",
1843           "name": "o",
1844           "doc": "<p>The item being removed.</p>\n",
1845           "optional": false
1846         },
1847         {
1848           "type": "String",
1849           "name": "key",
1850           "doc": "<p>(optional) The key associated with the removed item.</p>\n",
1851           "optional": true
1852         }
1853       ],
1854       "private": false,
1855       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1856       "linenr": 44,
1857       "html_filename": "AbstractMixedCollection.html",
1858       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-remove",
1859       "shortDoc": "<p>Fires when an item is removed from the collection.</p>\n"
1860     },
1861     {
1862       "tagname": "event",
1863       "name": "replace",
1864       "member": "Ext.util.AbstractMixedCollection",
1865       "doc": "<p>Fires when an item is replaced in the collection.</p>\n",
1866       "params": [
1867         {
1868           "type": "String",
1869           "name": "key",
1870           "doc": "<p>he key associated with the new added.</p>\n",
1871           "optional": false
1872         },
1873         {
1874           "type": "Object",
1875           "name": "old",
1876           "doc": "<p>The item being replaced.</p>\n",
1877           "optional": false
1878         },
1879         {
1880           "type": "Object",
1881           "name": "new",
1882           "doc": "<p>The new item.</p>\n",
1883           "optional": false
1884         }
1885       ],
1886       "private": false,
1887       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/AbstractMixedCollection.js",
1888       "linenr": 35,
1889       "html_filename": "AbstractMixedCollection.html",
1890       "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-replace",
1891       "shortDoc": "<p>Fires when an item is replaced in the collection.</p>\n"
1892     }
1893   ],
1894   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Errors.js",
1895   "linenr": 1,
1896   "html_filename": "Errors.html",
1897   "href": "Errors.html#Ext-data-Errors",
1898   "cssVar": [
1899
1900   ],
1901   "cssMixin": [
1902
1903   ],
1904   "component": false,
1905   "superclasses": [
1906     "Ext.util.AbstractMixedCollection",
1907     "Ext.util.MixedCollection"
1908   ],
1909   "subclasses": [
1910
1911   ],
1912   "mixedInto": [
1913
1914   ],
1915   "allMixins": [
1916     "Ext.util.Sortable",
1917     "Ext.util.Observable"
1918   ]
1919 });