docs/output/Ext.data.Batch.js

   1 Ext.data.JsonP.Ext_data_Batch({
   2   "tagname": "class",
   3   "name": "Ext.data.Batch",
   4   "doc": "<p>Provides a mechanism to run one or more <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">operations</a> in a given order. Fires the 'operationcomplete' event\nafter the completion of each Operation, and the 'complete' event when all Operations have been successfully executed. Fires an 'exception'\nevent if any of the Operations encounter an exception.</p>\n\n\n\n\n<p>Usually these are only used internally by <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Ext.data.proxy.Proxy</a> classes</p>\n\n",
   5   "extends": null,
   6   "mixins": [
   7     "Ext.util.Observable"
   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": "listeners",
  21       "member": "Ext.util.Observable",
  22       "type": "Object",
  23       "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.Batch-method-addListener\" rel=\"Ext.data.Batch-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",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  26       "linenr": 103,
  27       "html_filename": "Observable.html",
  28       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  29       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  30     }
  31   ],
  32   "method": [
  33     {
  34       "tagname": "method",
  35       "name": "Batch",
  36       "member": "Ext.data.Batch",
  37       "doc": "\n",
  38       "params": [
  39         {
  40           "type": "Object",
  41           "name": "config",
  42           "doc": "<p>Optional config object</p>\n",
  43           "optional": false
  44         }
  45       ],
  46       "return": {
  47         "type": "void",
  48         "doc": "\n"
  49       },
  50       "private": false,
  51       "static": false,
  52       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
  53       "linenr": 1,
  54       "html_filename": "Batch.html",
  55       "href": "Batch.html#Ext-data-Batch-method-constructor",
  56       "shortDoc": "\n"
  57     },
  58     {
  59       "tagname": "method",
  60       "name": "add",
  61       "member": "Ext.data.Batch",
  62       "doc": "<p>Adds a new operation to this batch</p>\n",
  63       "params": [
  64         {
  65           "type": "Object",
  66           "name": "operation",
  67           "doc": "<p>The <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Operation</a> object</p>\n",
  68           "optional": false
  69         }
  70       ],
  71       "return": {
  72         "type": "void",
  73         "doc": "\n"
  74       },
  75       "private": false,
  76       "static": false,
  77       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
  78       "linenr": 107,
  79       "html_filename": "Batch.html",
  80       "href": "Batch.html#Ext-data-Batch-method-add",
  81       "shortDoc": "<p>Adds a new operation to this batch</p>\n"
  82     },
  83     {
  84       "tagname": "method",
  85       "name": "addEvents",
  86       "member": "Ext.util.Observable",
  87       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
  88       "params": [
  89         {
  90           "type": "Object/String",
  91           "name": "o",
  92           "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",
  93           "optional": false
  94         },
  95         {
  96           "type": "String",
  97           "name": "",
  98           "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",
  99           "optional": false
 100         }
 101       ],
 102       "return": {
 103         "type": "void",
 104         "doc": "\n"
 105       },
 106       "private": false,
 107       "static": false,
 108       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 109       "linenr": 452,
 110       "html_filename": "Observable.html",
 111       "href": "Observable.html#Ext-util-Observable-method-addEvents",
 112       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
 113     },
 114     {
 115       "tagname": "method",
 116       "name": "addListener",
 117       "member": "Ext.util.Observable",
 118       "doc": "<p>Appends an event handler to this object.</p>\n",
 119       "params": [
 120         {
 121           "type": "String",
 122           "name": "eventName",
 123           "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",
 124           "optional": false
 125         },
 126         {
 127           "type": "Function",
 128           "name": "handler",
 129           "doc": "<p>The method the event invokes.</p>\n",
 130           "optional": false
 131         },
 132         {
 133           "type": "Object",
 134           "name": "scope",
 135           "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",
 136           "optional": true
 137         },
 138         {
 139           "type": "Object",
 140           "name": "options",
 141           "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",
 142           "optional": true
 143         }
 144       ],
 145       "return": {
 146         "type": "void",
 147         "doc": "\n"
 148       },
 149       "private": false,
 150       "static": false,
 151       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 152       "linenr": 271,
 153       "html_filename": "Observable.html",
 154       "href": "Observable.html#Ext-util-Observable-method-addListener",
 155       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 156     },
 157     {
 158       "tagname": "method",
 159       "name": "addManagedListener",
 160       "member": "Ext.util.Observable",
 161       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 162       "params": [
 163         {
 164           "type": "Observable/Element",
 165           "name": "item",
 166           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 167           "optional": false
 168         },
 169         {
 170           "type": "Object/String",
 171           "name": "ename",
 172           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 173           "optional": false
 174         },
 175         {
 176           "type": "Function",
 177           "name": "fn",
 178           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 179           "optional": false
 180         },
 181         {
 182           "type": "Object",
 183           "name": "scope",
 184           "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",
 185           "optional": false
 186         },
 187         {
 188           "type": "Object",
 189           "name": "opt",
 190           "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",
 191           "optional": false
 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": 155,
 202       "html_filename": "Observable.html",
 203       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 204       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 205     },
 206     {
 207       "tagname": "method",
 208       "name": "capture",
 209       "member": "Ext.util.Observable",
 210       "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",
 211       "params": [
 212         {
 213           "type": "Observable",
 214           "name": "o",
 215           "doc": "<p>The Observable to capture events from.</p>\n",
 216           "optional": false
 217         },
 218         {
 219           "type": "Function",
 220           "name": "fn",
 221           "doc": "<p>The function to call when an event is fired.</p>\n",
 222           "optional": false
 223         },
 224         {
 225           "type": "Object",
 226           "name": "scope",
 227           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 228           "optional": true
 229         }
 230       ],
 231       "return": {
 232         "type": "void",
 233         "doc": "\n"
 234       },
 235       "private": false,
 236       "static": true,
 237       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 238       "linenr": 55,
 239       "html_filename": "Observable.html",
 240       "href": "Observable.html#Ext-util-Observable-method-capture",
 241       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 242     },
 243     {
 244       "tagname": "method",
 245       "name": "clearListeners",
 246       "member": "Ext.util.Observable",
 247       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 248       "params": [
 249
 250       ],
 251       "return": {
 252         "type": "void",
 253         "doc": "\n"
 254       },
 255       "private": false,
 256       "static": false,
 257       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 258       "linenr": 383,
 259       "html_filename": "Observable.html",
 260       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 261       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 262     },
 263     {
 264       "tagname": "method",
 265       "name": "clearManagedListeners",
 266       "member": "Ext.util.Observable",
 267       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 268       "params": [
 269
 270       ],
 271       "return": {
 272         "type": "void",
 273         "doc": "\n"
 274       },
 275       "private": false,
 276       "static": false,
 277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 278       "linenr": 412,
 279       "html_filename": "Observable.html",
 280       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 281       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 282     },
 283     {
 284       "tagname": "method",
 285       "name": "enableBubble",
 286       "member": "Ext.util.Observable",
 287       "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",
 288       "params": [
 289         {
 290           "type": "String/Array",
 291           "name": "events",
 292           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 293           "optional": false
 294         }
 295       ],
 296       "return": {
 297         "type": "void",
 298         "doc": "\n"
 299       },
 300       "private": false,
 301       "static": false,
 302       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 303       "linenr": 554,
 304       "html_filename": "Observable.html",
 305       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 306       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 307     },
 308     {
 309       "tagname": "method",
 310       "name": "fireEvent",
 311       "member": "Ext.util.Observable",
 312       "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.Batch-method-enableBubble\" rel=\"Ext.data.Batch-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 313       "params": [
 314         {
 315           "type": "String",
 316           "name": "eventName",
 317           "doc": "<p>The name of the event to fire.</p>\n",
 318           "optional": false
 319         },
 320         {
 321           "type": "Object...",
 322           "name": "args",
 323           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 324           "optional": false
 325         }
 326       ],
 327       "return": {
 328         "type": "Boolean",
 329         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 330       },
 331       "private": false,
 332       "static": false,
 333       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 334       "linenr": 232,
 335       "html_filename": "Observable.html",
 336       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 337       "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..."
 338     },
 339     {
 340       "tagname": "method",
 341       "name": "hasListener",
 342       "member": "Ext.util.Observable",
 343       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 344       "params": [
 345         {
 346           "type": "String",
 347           "name": "eventName",
 348           "doc": "<p>The name of the event to check for</p>\n",
 349           "optional": false
 350         }
 351       ],
 352       "return": {
 353         "type": "Boolean",
 354         "doc": "<p>True if the event is being listened for, else false</p>\n"
 355       },
 356       "private": false,
 357       "static": false,
 358       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 359       "linenr": 480,
 360       "html_filename": "Observable.html",
 361       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 362       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 363     },
 364     {
 365       "tagname": "method",
 366       "name": "observe",
 367       "member": "Ext.util.Observable",
 368       "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",
 369       "params": [
 370         {
 371           "type": "Function",
 372           "name": "c",
 373           "doc": "<p>The class constructor to make observable.</p>\n",
 374           "optional": false
 375         },
 376         {
 377           "type": "Object",
 378           "name": "listeners",
 379           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.data.Batch-method-addListener\" rel=\"Ext.data.Batch-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 380           "optional": false
 381         }
 382       ],
 383       "return": {
 384         "type": "void",
 385         "doc": "\n"
 386       },
 387       "private": false,
 388       "static": true,
 389       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 390       "linenr": 69,
 391       "html_filename": "Observable.html",
 392       "href": "Observable.html#Ext-util-Observable-method-observe",
 393       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 394     },
 395     {
 396       "tagname": "method",
 397       "name": "on",
 398       "member": "Ext.util.Observable",
 399       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.Batch-method-addListener\" rel=\"Ext.data.Batch-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 400       "params": [
 401         {
 402           "type": "String",
 403           "name": "eventName",
 404           "doc": "<p>The type of event to listen for</p>\n",
 405           "optional": false
 406         },
 407         {
 408           "type": "Function",
 409           "name": "handler",
 410           "doc": "<p>The method the event invokes</p>\n",
 411           "optional": false
 412         },
 413         {
 414           "type": "Object",
 415           "name": "scope",
 416           "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",
 417           "optional": true
 418         },
 419         {
 420           "type": "Object",
 421           "name": "options",
 422           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 423           "optional": true
 424         }
 425       ],
 426       "return": {
 427         "type": "void",
 428         "doc": "\n"
 429       },
 430       "private": false,
 431       "static": false,
 432       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 433       "linenr": 616,
 434       "html_filename": "Observable.html",
 435       "href": "Observable.html#Ext-util-Observable-method-on",
 436       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.Batch-method-addListener\" rel=\"Ext.data.Batch-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 437     },
 438     {
 439       "tagname": "method",
 440       "name": "pause",
 441       "member": "Ext.data.Batch",
 442       "doc": "<p>Pauses execution of the batch, but does not cancel the current operation</p>\n",
 443       "params": [
 444
 445       ],
 446       "return": {
 447         "type": "void",
 448         "doc": "\n"
 449       },
 450       "private": false,
 451       "static": false,
 452       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 453       "linenr": 138,
 454       "html_filename": "Batch.html",
 455       "href": "Batch.html#Ext-data-Batch-method-pause",
 456       "shortDoc": "<p>Pauses execution of the batch, but does not cancel the current operation</p>\n"
 457     },
 458     {
 459       "tagname": "method",
 460       "name": "relayEvents",
 461       "member": "Ext.util.Observable",
 462       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 463       "params": [
 464         {
 465           "type": "Object",
 466           "name": "origin",
 467           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 468           "optional": false
 469         },
 470         {
 471           "type": "Array",
 472           "name": "events",
 473           "doc": "<p>Array of event names to relay.</p>\n",
 474           "optional": false
 475         },
 476         {
 477           "type": "Object",
 478           "name": "prefix",
 479           "doc": "\n",
 480           "optional": false
 481         }
 482       ],
 483       "return": {
 484         "type": "void",
 485         "doc": "\n"
 486       },
 487       "private": false,
 488       "static": false,
 489       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 490       "linenr": 520,
 491       "html_filename": "Observable.html",
 492       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 493       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 494     },
 495     {
 496       "tagname": "method",
 497       "name": "releaseCapture",
 498       "member": "Ext.util.Observable",
 499       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 500       "params": [
 501         {
 502           "type": "Observable",
 503           "name": "o",
 504           "doc": "<p>The Observable to release</p>\n",
 505           "optional": false
 506         }
 507       ],
 508       "return": {
 509         "type": "void",
 510         "doc": "\n"
 511       },
 512       "private": false,
 513       "static": true,
 514       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 515       "linenr": 46,
 516       "html_filename": "Observable.html",
 517       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 518       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 519     },
 520     {
 521       "tagname": "method",
 522       "name": "removeListener",
 523       "member": "Ext.util.Observable",
 524       "doc": "<p>Removes an event handler.</p>\n",
 525       "params": [
 526         {
 527           "type": "String",
 528           "name": "eventName",
 529           "doc": "<p>The type of event the handler was associated with.</p>\n",
 530           "optional": false
 531         },
 532         {
 533           "type": "Function",
 534           "name": "handler",
 535           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.Batch-method-addListener\" rel=\"Ext.data.Batch-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 536           "optional": false
 537         },
 538         {
 539           "type": "Object",
 540           "name": "scope",
 541           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 542           "optional": true
 543         }
 544       ],
 545       "return": {
 546         "type": "void",
 547         "doc": "\n"
 548       },
 549       "private": false,
 550       "static": false,
 551       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 552       "linenr": 352,
 553       "html_filename": "Observable.html",
 554       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 555       "shortDoc": "<p>Removes an event handler.</p>\n"
 556     },
 557     {
 558       "tagname": "method",
 559       "name": "removeManagedListener",
 560       "member": "Ext.util.Observable",
 561       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.Batch--mon\" rel=\"Ext.data.Batch--mon\" class=\"docClass\">mon</a> method.</p>\n",
 562       "params": [
 563         {
 564           "type": "Observable|Element",
 565           "name": "item",
 566           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 567           "optional": false
 568         },
 569         {
 570           "type": "Object|String",
 571           "name": "ename",
 572           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 573           "optional": false
 574         },
 575         {
 576           "type": "Function",
 577           "name": "fn",
 578           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 579           "optional": false
 580         },
 581         {
 582           "type": "Object",
 583           "name": "scope",
 584           "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",
 585           "optional": false
 586         }
 587       ],
 588       "return": {
 589         "type": "void",
 590         "doc": "\n"
 591       },
 592       "private": false,
 593       "static": false,
 594       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 595       "linenr": 196,
 596       "html_filename": "Observable.html",
 597       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 598       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.Batch--mon\" rel=\"Ext.data.Batch--mon\" class=\"docClass\">mon</a> method.</p>\n"
 599     },
 600     {
 601       "tagname": "method",
 602       "name": "resumeEvents",
 603       "member": "Ext.util.Observable",
 604       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.data.Batch-method-suspendEvents\" rel=\"Ext.data.Batch-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",
 605       "params": [
 606
 607       ],
 608       "return": {
 609         "type": "void",
 610         "doc": "\n"
 611       },
 612       "private": false,
 613       "static": false,
 614       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 615       "linenr": 502,
 616       "html_filename": "Observable.html",
 617       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 618       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 619     },
 620     {
 621       "tagname": "method",
 622       "name": "runOperation",
 623       "member": "Ext.data.Batch",
 624       "doc": "<p>Executes a operation by its numeric index</p>\n",
 625       "params": [
 626         {
 627           "type": "Number",
 628           "name": "index",
 629           "doc": "<p>The operation index to run</p>\n",
 630           "optional": false
 631         }
 632       ],
 633       "return": {
 634         "type": "void",
 635         "doc": "\n"
 636       },
 637       "private": false,
 638       "static": false,
 639       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 640       "linenr": 145,
 641       "html_filename": "Batch.html",
 642       "href": "Batch.html#Ext-data-Batch-method-runOperation",
 643       "shortDoc": "<p>Executes a operation by its numeric index</p>\n"
 644     },
 645     {
 646       "tagname": "method",
 647       "name": "start",
 648       "member": "Ext.data.Batch",
 649       "doc": "<p>Kicks off the execution of the batch, continuing from the next operation if the previous\noperation encountered an exception, or if execution was paused</p>\n",
 650       "params": [
 651
 652       ],
 653       "return": {
 654         "type": "void",
 655         "doc": "\n"
 656       },
 657       "private": false,
 658       "static": false,
 659       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 660       "linenr": 119,
 661       "html_filename": "Batch.html",
 662       "href": "Batch.html#Ext-data-Batch-method-start",
 663       "shortDoc": "Kicks off the execution of the batch, continuing from the next operation if the previous\noperation encountered an exc..."
 664     },
 665     {
 666       "tagname": "method",
 667       "name": "suspendEvents",
 668       "member": "Ext.util.Observable",
 669       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.Batch-method-resumeEvents\" rel=\"Ext.data.Batch-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 670       "params": [
 671         {
 672           "type": "Boolean",
 673           "name": "queueSuspended",
 674           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.data.Batch-method-resumeEvents\" rel=\"Ext.data.Batch-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 675           "optional": false
 676         }
 677       ],
 678       "return": {
 679         "type": "void",
 680         "doc": "\n"
 681       },
 682       "private": false,
 683       "static": false,
 684       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 685       "linenr": 490,
 686       "html_filename": "Observable.html",
 687       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 688       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.Batch-method-resumeEvents\" rel=\"Ext.data.Batch-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 689     },
 690     {
 691       "tagname": "method",
 692       "name": "un",
 693       "member": "Ext.util.Observable",
 694       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.Batch-method-removeListener\" rel=\"Ext.data.Batch-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 695       "params": [
 696         {
 697           "type": "String",
 698           "name": "eventName",
 699           "doc": "<p>The type of event the handler was associated with.</p>\n",
 700           "optional": false
 701         },
 702         {
 703           "type": "Function",
 704           "name": "handler",
 705           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.Batch-method-addListener\" rel=\"Ext.data.Batch-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 706           "optional": false
 707         },
 708         {
 709           "type": "Object",
 710           "name": "scope",
 711           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 712           "optional": true
 713         }
 714       ],
 715       "return": {
 716         "type": "void",
 717         "doc": "\n"
 718       },
 719       "private": false,
 720       "static": false,
 721       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 722       "linenr": 608,
 723       "html_filename": "Observable.html",
 724       "href": "Observable.html#Ext-util-Observable-method-un",
 725       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.Batch-method-removeListener\" rel=\"Ext.data.Batch-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 726     }
 727   ],
 728   "property": [
 729     {
 730       "tagname": "property",
 731       "name": "autoStart",
 732       "member": "Ext.data.Batch",
 733       "type": "Boolean",
 734       "doc": "<p>True to immediately start processing the batch as soon as it is constructed (defaults to false)</p>\n",
 735       "private": false,
 736       "static": false,
 737       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 738       "linenr": 19,
 739       "html_filename": "Batch.html",
 740       "href": "Batch.html#Ext-data-Batch-property-autoStart"
 741     },
 742     {
 743       "tagname": "property",
 744       "name": "current",
 745       "member": "Ext.data.Batch",
 746       "type": "Number",
 747       "doc": "<p>The index of the current operation being executed</p>\n",
 748       "private": false,
 749       "static": false,
 750       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 751       "linenr": 26,
 752       "html_filename": "Batch.html",
 753       "href": "Batch.html#Ext-data-Batch-property-current"
 754     },
 755     {
 756       "tagname": "property",
 757       "name": "hasException",
 758       "member": "Ext.data.Batch",
 759       "type": "Boolean",
 760       "doc": "<p>True if this batch has encountered an exception. This is cleared at the start of each operation</p>\n",
 761       "private": false,
 762       "static": false,
 763       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 764       "linenr": 54,
 765       "html_filename": "Batch.html",
 766       "href": "Batch.html#Ext-data-Batch-property-hasException"
 767     },
 768     {
 769       "tagname": "property",
 770       "name": "isComplete",
 771       "member": "Ext.data.Batch",
 772       "type": "Boolean",
 773       "doc": "<p>True if this batch has been executed completely</p>\n",
 774       "private": false,
 775       "static": false,
 776       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 777       "linenr": 47,
 778       "html_filename": "Batch.html",
 779       "href": "Batch.html#Ext-data-Batch-property-isComplete"
 780     },
 781     {
 782       "tagname": "property",
 783       "name": "isRunning",
 784       "member": "Ext.data.Batch",
 785       "type": "Boolean",
 786       "doc": "<p>True if the batch is currently running</p>\n",
 787       "private": false,
 788       "static": false,
 789       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 790       "linenr": 40,
 791       "html_filename": "Batch.html",
 792       "href": "Batch.html#Ext-data-Batch-property-isRunning"
 793     },
 794     {
 795       "tagname": "property",
 796       "name": "operations",
 797       "member": "Ext.data.Batch",
 798       "type": "Array",
 799       "doc": "<p>Ordered array of operations that will be executed by this batch</p>\n",
 800       "private": false,
 801       "static": false,
 802       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 803       "linenr": 99,
 804       "html_filename": "Batch.html",
 805       "href": "Batch.html#Ext-data-Batch-property-operations"
 806     },
 807     {
 808       "tagname": "property",
 809       "name": "pauseOnException",
 810       "member": "Ext.data.Batch",
 811       "type": "Boolean",
 812       "doc": "<p>True to automatically pause the execution of the batch if any operation encounters an exception (defaults to true)</p>\n",
 813       "private": false,
 814       "static": false,
 815       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 816       "linenr": 61,
 817       "html_filename": "Batch.html",
 818       "href": "Batch.html#Ext-data-Batch-property-pauseOnException"
 819     },
 820     {
 821       "tagname": "property",
 822       "name": "total",
 823       "member": "Ext.data.Batch",
 824       "type": "Number",
 825       "doc": "<p>The total number of operations in this batch. Read only</p>\n",
 826       "private": false,
 827       "static": false,
 828       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 829       "linenr": 33,
 830       "html_filename": "Batch.html",
 831       "href": "Batch.html#Ext-data-Batch-property-total"
 832     }
 833   ],
 834   "event": [
 835     {
 836       "tagname": "event",
 837       "name": "complete",
 838       "member": "Ext.data.Batch",
 839       "doc": "<p>Fired when all operations of this batch have been completed</p>\n",
 840       "params": [
 841         {
 842           "type": "Ext.data.Batch",
 843           "name": "batch",
 844           "doc": "<p>The batch object</p>\n",
 845           "optional": false
 846         },
 847         {
 848           "type": "Object",
 849           "name": "operation",
 850           "doc": "<p>The last operation that was executed</p>\n",
 851           "optional": false
 852         }
 853       ],
 854       "private": false,
 855       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 856       "linenr": 72,
 857       "html_filename": "Batch.html",
 858       "href": "Batch.html#Ext-data-Batch-event-complete",
 859       "shortDoc": "<p>Fired when all operations of this batch have been completed</p>\n"
 860     },
 861     {
 862       "tagname": "event",
 863       "name": "exception",
 864       "member": "Ext.data.Batch",
 865       "doc": "<p>Fired when a operation encountered an exception</p>\n",
 866       "params": [
 867         {
 868           "type": "Ext.data.Batch",
 869           "name": "batch",
 870           "doc": "<p>The batch object</p>\n",
 871           "optional": false
 872         },
 873         {
 874           "type": "Object",
 875           "name": "operation",
 876           "doc": "<p>The operation that encountered the exception</p>\n",
 877           "optional": false
 878         }
 879       ],
 880       "private": false,
 881       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 882       "linenr": 80,
 883       "html_filename": "Batch.html",
 884       "href": "Batch.html#Ext-data-Batch-event-exception",
 885       "shortDoc": "<p>Fired when a operation encountered an exception</p>\n"
 886     },
 887     {
 888       "tagname": "event",
 889       "name": "operationcomplete",
 890       "member": "Ext.data.Batch",
 891       "doc": "<p>Fired when each operation of the batch completes</p>\n",
 892       "params": [
 893         {
 894           "type": "Ext.data.Batch",
 895           "name": "batch",
 896           "doc": "<p>The batch object</p>\n",
 897           "optional": false
 898         },
 899         {
 900           "type": "Object",
 901           "name": "operation",
 902           "doc": "<p>The operation that just completed</p>\n",
 903           "optional": false
 904         }
 905       ],
 906       "private": false,
 907       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 908       "linenr": 88,
 909       "html_filename": "Batch.html",
 910       "href": "Batch.html#Ext-data-Batch-event-operationcomplete",
 911       "shortDoc": "<p>Fired when each operation of the batch completes</p>\n"
 912     }
 913   ],
 914   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Batch.js",
 915   "linenr": 1,
 916   "html_filename": "Batch.html",
 917   "href": "Batch.html#Ext-data-Batch",
 918   "cssVar": [
 919
 920   ],
 921   "cssMixin": [
 922
 923   ],
 924   "component": false,
 925   "superclasses": [
 926
 927   ],
 928   "subclasses": [
 929
 930   ],
 931   "mixedInto": [
 932
 933   ],
 934   "allMixins": [
 935     "Ext.util.Observable"
 936   ]
 937 });