docs/api/Ext.data.Batch.html

   1 <!DOCTYPE html><html><head><title>Ext.data.Batch | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.data.Batch',
  13         docClass: 'Ext.data.Batch',
  14         docReq: 'Ext.data.Batch',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Batch.html#Ext-data.Batch';
  33     clsInfo = {"methods":["Batch","add","addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","hasListener","observe","on","pause","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","runOperation","start","suspendEvents","un"],"cfgs":["listeners"],"properties":["autoStart","current","hasException","isComplete","isRunning","operations","pauseOnException","total"],"events":["complete","exception","operationcomplete"],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Batch.html#Ext-data.Batch" target="_blank">Ext.data.Batch</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>Provides a mechanism to run one or more <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">operations</a> in a given order. Fires the 'operationcomplete' event
  38 after the completion of each Operation, and the 'complete' event when all Operations have been successfully executed. Fires an 'exception'
  39 event if any of the Operations encounter an exception.</p>
  40
  41
  42
  43
  44 <p>Usually these are only used internally by <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Ext.data.proxy.Proxy</a> classes</p>
  45
  46 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-listeners" class="member f inherited"><a href="Ext.data.Batch.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.data.Batch.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
  47 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
  48 object during initialization.  This should be a valid listeners config object as specified in the
  49 <a href="Ext.data.Batch.html#addListener" rel="Ext.data.Batch#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
  50
  51 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
  52
  53
  54 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  55
  56
  57 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
  58 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
  59 events directly from a child element of a Component, we need to specify the <code>element</code> option to
  60 identify the Component property to add a DOM listener to:</p>
  61
  62 <pre><code>new Ext.panel.Panel({
  63     width: 400,
  64     height: 200,
  65     dockedItems: [{
  66         xtype: 'toolbar'
  67     }],
  68     listeners: {
  69         click: {
  70             element: 'el', //bind to the underlying el property on the panel
  71             fn: function(){ console.log('click el'); }
  72         },
  73         dblclick: {
  74             element: 'body', //bind to the underlying body property on the panel
  75             fn: function(){ console.log('dblclick body'); }
  76         }
  77     }
  78 });
  79 </code></pre>
  80
  81
  82 <p></p></p>
  83 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-autoStart" class="member f ni"><a href="Ext.data.Batch.html#property-autoStart" rel="property-autoStart" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-autoStart" class="viewSource">view source</a></div><a name="autoStart"></a><a name="property-autoStart"></a><a href="Ext.data.Batch.html#" rel="property-autoStart" class="cls expand">autoStart</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to immediately start processing the batch as soon as it is constructed (defaults to false)</p>
  84 </div><div class="long"><p>True to immediately start processing the batch as soon as it is constructed (defaults to false)</p>
  85 </div></div></div><div id="property-current" class="member ni"><a href="Ext.data.Batch.html#property-current" rel="property-current" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-current" class="viewSource">view source</a></div><a name="current"></a><a name="property-current"></a><a href="Ext.data.Batch.html#" rel="property-current" class="cls expand">current</a><span> : Number</span></div><div class="description"><div class="short"><p>The index of the current operation being executed</p>
  86 </div><div class="long"><p>The index of the current operation being executed</p>
  87 </div></div></div><div id="property-hasException" class="member ni"><a href="Ext.data.Batch.html#property-hasException" rel="property-hasException" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-hasException" class="viewSource">view source</a></div><a name="hasException"></a><a name="property-hasException"></a><a href="Ext.data.Batch.html#" rel="property-hasException" class="cls expand">hasException</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True if this batch has encountered an exception. This is cleared at the start of each operation</p>
  88 </div><div class="long"><p>True if this batch has encountered an exception. This is cleared at the start of each operation</p>
  89 </div></div></div><div id="property-isComplete" class="member ni"><a href="Ext.data.Batch.html#property-isComplete" rel="property-isComplete" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-isComplete" class="viewSource">view source</a></div><a name="isComplete"></a><a name="property-isComplete"></a><a href="Ext.data.Batch.html#" rel="property-isComplete" class="cls expand">isComplete</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True if this batch has been executed completely</p>
  90 </div><div class="long"><p>True if this batch has been executed completely</p>
  91 </div></div></div><div id="property-isRunning" class="member ni"><a href="Ext.data.Batch.html#property-isRunning" rel="property-isRunning" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-isRunning" class="viewSource">view source</a></div><a name="isRunning"></a><a name="property-isRunning"></a><a href="Ext.data.Batch.html#" rel="property-isRunning" class="cls expand">isRunning</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True if the batch is currently running</p>
  92 </div><div class="long"><p>True if the batch is currently running</p>
  93 </div></div></div><div id="property-operations" class="member ni"><a href="Ext.data.Batch.html#property-operations" rel="property-operations" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-operations" class="viewSource">view source</a></div><a name="operations"></a><a name="property-operations"></a><a href="Ext.data.Batch.html#" rel="property-operations" class="cls expand">operations</a><span> : Array</span></div><div class="description"><div class="short"><p>Ordered array of operations that will be executed by this batch</p>
  94 </div><div class="long"><p>Ordered array of operations that will be executed by this batch</p>
  95 </div></div></div><div id="property-pauseOnException" class="member ni"><a href="Ext.data.Batch.html#property-pauseOnException" rel="property-pauseOnException" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-pauseOnException" class="viewSource">view source</a></div><a name="pauseOnException"></a><a name="property-pauseOnException"></a><a href="Ext.data.Batch.html#" rel="property-pauseOnException" class="cls expand">pauseOnException</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to automatically pause the execution of the batch if any operation encounters an exception (defaults to true)</p>
  96 </div><div class="long"><p>True to automatically pause the execution of the batch if any operation encounters an exception (defaults to true)</p>
  97 </div></div></div><div id="property-total" class="member ni"><a href="Ext.data.Batch.html#property-total" rel="property-total" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-property-total" class="viewSource">view source</a></div><a name="total"></a><a name="property-total"></a><a href="Ext.data.Batch.html#" rel="property-total" class="cls expand">total</a><span> : Number</span></div><div class="description"><div class="short"><p>The total number of operations in this batch. Read only</p>
  98 </div><div class="long"><p>The total number of operations in this batch. Read only</p>
  99 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Batch" class="member f ni"><a href="Ext.data.Batch.html#method-Batch" rel="method-Batch" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-method-constructor" class="viewSource">view source</a></div><a name="Batch"></a><a name="method-Batch"></a><a href="Ext.data.Batch.html#" rel="method-Batch" class="cls expand">Batch</a>(
 100 <span class="pre">Object config</span>)
 101  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
 102 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Optional config object</p>
 103 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 104 </li></ul></div></div></div><div id="method-add" class="member ni"><a href="Ext.data.Batch.html#method-add" rel="method-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-method-add" class="viewSource">view source</a></div><a name="add"></a><a name="method-add"></a><a href="Ext.data.Batch.html#" rel="method-add" class="cls expand">add</a>(
 105 <span class="pre">Object operation</span>)
 106  : void</div><div class="description"><div class="short"><p>Adds a new operation to this batch</p>
 107 </div><div class="long"><p>Adds a new operation to this batch</p>
 108 <h3 class="pa">Parameters</h3><ul><li><span class="pre">operation</span> : Object<div class="sub-desc"><p>The <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Operation</a> object</p>
 109 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 110 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.Batch.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.data.Batch.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
 111 <span class="pre">Object/String o, String </span>)
 112  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 113 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 114 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
 115 or the first event name string if multiple event names are being passed as separate parameters.</p>
 116 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
 117 Usage:</p>
 118
 119 <pre><code>this.addEvents('storeloaded', 'storecleared');
 120 </code></pre>
 121
 122 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 123 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.Batch.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.data.Batch.html#" rel="method-addListener" class="cls expand">addListener</a>(
 124 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 125  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
 126 </div><div class="long"><p>Appends an event handler to this object.</p>
 127 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
 128 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
 129 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 130 <b>If omitted, defaults to the object which fired the event.</b></p>
 131 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
 132 properties. This may contain any of the following properties:<ul>
 133 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 134 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 135 <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>
 136 <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>
 137 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
 138 by the specified number of milliseconds. If the event fires again within that time, the original
 139 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 140 <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>
 141 if the event was bubbled up from a child Observable.</div></li>
 142 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
 143 The name of a Component property which references an element to add a listener to.</p>
 144
 145 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
 146 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
 147 <pre><code>new Ext.panel.Panel({
 148     title: 'The title',
 149     listeners: {
 150         click: this.handlePanelClick,
 151         element: 'body'
 152     }
 153 });
 154 </code></pre></p>
 155
 156
 157 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
 158
 159
 160 <p></div></li>
 161 </ul><br></p>
 162
 163 <p>
 164 <b>Combining Options</b><br>
 165 Using the options argument, it is possible to combine different types of listeners:<br>
 166 <br>
 167 A delayed, one-time listener.
 168 <pre><code>myPanel.on('hide', this.handleClick, this, {
 169 single: true,
 170 delay: 100
 171 });</code></pre>
 172 <p>
 173 <b>Attaching multiple handlers in 1 call</b><br>
 174 The method also allows for a single argument to be passed which is a config object containing properties
 175 which specify multiple events. For example:
 176 <pre><code>myGridPanel.on({
 177     cellClick: this.onCellClick,
 178     mouseover: this.onMouseOver,
 179     mouseout: this.onMouseOut,
 180     scope: this // Important. Ensure "this" is correct during handler execution
 181 });
 182 </code></pre>.
 183 <p>
 184
 185 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 186 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.Batch.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.data.Batch.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
 187 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
 188  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 189 is destroyed.
 190
 191 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 192 is destroyed.
 193
 194 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
 195 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 196 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 197 is the handler function.</p>
 198 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 199 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 200 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 201 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
 202 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 203 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.Batch.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.data.Batch.html#" rel="method-capture" class="cls expand">capture</a>(
 204 <span class="pre">Observable o, Function fn, [Object scope]</span>)
 205  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
 206 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
 207 to the supplied function with the event name + standard signature of the event
 208 <b>before</b> the event is fired. If the supplied function returns false,
 209 the event will not fire.</p>
 210 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
 211 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
 212 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
 213 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 214 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.Batch.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.data.Batch.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
 215 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
 216 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 217 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.Batch.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.data.Batch.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
 218 </div><div class="long"><p>Removes all managed listeners for this object.</p>
 219 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 220 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.Batch.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.data.Batch.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
 221 <span class="pre">String/Array events</span>)
 222  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
 223 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
 224 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
 225
 226
 227 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
 228 implementation in <a href="Ext.Component.html" 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
 229 access the required target more quickly.</p>
 230
 231
 232 <p>Example:</p>
 233
 234
 235 <pre><code>Ext.override(Ext.form.field.Base, {
 236 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
 237 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
 238     this.enableBubble('change');
 239 }),
 240
 241 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
 242 getBubbleTarget : function() {
 243     if (!this.formPanel) {
 244         this.formPanel = this.findParentByType('form');
 245     }
 246     return this.formPanel;
 247 }
 248 });
 249
 250 var myForm = new Ext.formPanel({
 251 title: 'User Details',
 252 items: [{
 253     ...
 254 }],
 255 listeners: {
 256     change: function() {
 257         // Title goes red if form has been modified.
 258         myForm.header.setStyle('color', 'red');
 259     }
 260 }
 261 });
 262 </code></pre>
 263
 264 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
 265 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 266 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.Batch.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.data.Batch.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
 267 <span class="pre">String eventName, Object... args</span>)
 268  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 269
 270
 271 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
 272
 273
 274 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
 275 by calling <a href="Ext.data.Batch.html#enableBubble" rel="Ext.data.Batch#enableBubble" class="docClass">enableBubble</a>.</p>
 276
 277 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
 278 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
 279 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
 280 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.Batch.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.data.Batch.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
 281 <span class="pre">String eventName</span>)
 282  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
 283 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
 284 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
 285 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
 286 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.Batch.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.data.Batch.html#" rel="method-observe" class="cls expand">observe</a>(
 287 <span class="pre">Function c, Object listeners</span>)
 288  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
 289
 290 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
 291
 292 <p>This makes any event fired on any instance of the passed class also fire a single event through
 293 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
 294
 295 <p>Usage:</p>
 296
 297 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
 298 Ext.data.Connection.on('beforerequest', function(con, options) {
 299     console.log('Ajax request made to ' + options.url);
 300 });
 301 </code></pre>
 302 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
 303 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.data.Batch.html#addListener" rel="Ext.data.Batch#addListener" class="docClass">addListener</a>.</p>
 304 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 305 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.Batch.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.data.Batch.html#" rel="method-on" class="cls expand">on</a>(
 306 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 307  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Batch.html#addListener" rel="Ext.data.Batch#addListener" class="docClass">addListener</a>.)</p>
 308 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Batch.html#addListener" rel="Ext.data.Batch#addListener" class="docClass">addListener</a>.)</p>
 309 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
 310 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
 311 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 312 <b>If omitted, defaults to the object which fired the event.</b></p>
 313 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
 314 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 315 </li></ul></div></div></div><div id="method-pause" class="member ni"><a href="Ext.data.Batch.html#method-pause" rel="method-pause" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-method-pause" class="viewSource">view source</a></div><a name="pause"></a><a name="method-pause"></a><a href="Ext.data.Batch.html#" rel="method-pause" class="cls expand">pause</a> : void</div><div class="description"><div class="short"><p>Pauses execution of the batch, but does not cancel the current operation</p>
 316 </div><div class="long"><p>Pauses execution of the batch, but does not cancel the current operation</p>
 317 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 318 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.Batch.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.data.Batch.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
 319 <span class="pre">Object origin, Array events, Object prefix</span>)
 320  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 321 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 322 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
 323 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
 324 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
 325 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 326 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.Batch.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.data.Batch.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
 327 <span class="pre">Observable o</span>)
 328  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
 329 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
 330 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
 331 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 332 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.Batch.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.data.Batch.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
 333 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 334  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
 335 </div><div class="long"><p>Removes an event handler.</p>
 336 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 337 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Batch.html#addListener" rel="Ext.data.Batch#addListener" class="docClass">addListener</a> call.</b></p>
 338 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 339 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 340 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.Batch.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.data.Batch.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
 341 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
 342  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.Batch.html#mon" rel="Ext.data.Batch#mon" class="docClass">mon</a> method.</p>
 343 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.Batch.html#mon" rel="Ext.data.Batch#mon" class="docClass">mon</a> method.</p>
 344 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
 345 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 346 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 347 is the handler function.</p>
 348 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 349 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 350 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 351 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.Batch.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.data.Batch.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
 352 If events were suspended using the queueSuspended parameter, then all
 353 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.Batch.html#suspendEvents" rel="Ext.data.Batch#suspendEvents" class="docClass">suspendEvents</a>)
 354 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
 355 events fired during event suspension will be sent to any listeners now.</p>
 356 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 357 </li></ul></div></div></div><div id="method-runOperation" class="member ni"><a href="Ext.data.Batch.html#method-runOperation" rel="method-runOperation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-method-runOperation" class="viewSource">view source</a></div><a name="runOperation"></a><a name="method-runOperation"></a><a href="Ext.data.Batch.html#" rel="method-runOperation" class="cls expand">runOperation</a>(
 358 <span class="pre">Number index</span>)
 359  : void</div><div class="description"><div class="short"><p>Executes a operation by its numeric index</p>
 360 </div><div class="long"><p>Executes a operation by its numeric index</p>
 361 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The operation index to run</p>
 362 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 363 </li></ul></div></div></div><div id="method-start" class="member ni"><a href="Ext.data.Batch.html#method-start" rel="method-start" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-method-start" class="viewSource">view source</a></div><a name="start"></a><a name="method-start"></a><a href="Ext.data.Batch.html#" rel="method-start" class="cls expand">start</a> : void</div><div class="description"><div class="short">Kicks off the execution of the batch, continuing from the next operation if the previous
 364 operation encountered an exc...</div><div class="long"><p>Kicks off the execution of the batch, continuing from the next operation if the previous
 365 operation encountered an exception, or if execution was paused</p>
 366 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 367 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.Batch.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.data.Batch.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
 368 <span class="pre">Boolean queueSuspended</span>)
 369  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.Batch.html#resumeEvents" rel="Ext.data.Batch#resumeEvents" class="docClass">resumeEvents</a>)</p>
 370 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.Batch.html#resumeEvents" rel="Ext.data.Batch#resumeEvents" class="docClass">resumeEvents</a>)</p>
 371 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
 372 after the <a href="Ext.data.Batch.html#resumeEvents" rel="Ext.data.Batch#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
 373 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 374 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.Batch.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.data.Batch.html#" rel="method-un" class="cls expand">un</a>(
 375 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 376  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.Batch.html#removeListener" rel="Ext.data.Batch#removeListener" class="docClass">removeListener</a>.)</p>
 377 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.Batch.html#removeListener" rel="Ext.data.Batch#removeListener" class="docClass">removeListener</a>.)</p>
 378 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 379 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Batch.html#addListener" rel="Ext.data.Batch#addListener" class="docClass">addListener</a> call.</b></p>
 380 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 381 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 382 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-complete" class="member f ni"><a href="Ext.data.Batch.html#event-complete" rel="event-complete" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-event-complete" class="viewSource">view source</a></div><a name="complete"></a><a name="event-complete"></a><a href="Ext.data.Batch.html#" rel="event-complete" class="cls expand">complete</a>(
 383 <span class="pre">Ext.data.Batch batch, Object operation</span>)
 384 </div><div class="description"><div class="short"><p>Fired when all operations of this batch have been completed</p>
 385 </div><div class="long"><p>Fired when all operations of this batch have been completed</p>
 386 <h3 class="pa">Parameters</h3><ul><li><span class="pre">batch</span> : Ext.data.Batch<div class="sub-desc"><p>The batch object</p>
 387 </div></li><li><span class="pre">operation</span> : Object<div class="sub-desc"><p>The last operation that was executed</p>
 388 </div></li></ul></div></div></div><div id="event-exception" class="member ni"><a href="Ext.data.Batch.html#event-exception" rel="event-exception" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-event-exception" class="viewSource">view source</a></div><a name="exception"></a><a name="event-exception"></a><a href="Ext.data.Batch.html#" rel="event-exception" class="cls expand">exception</a>(
 389 <span class="pre">Ext.data.Batch batch, Object operation</span>)
 390 </div><div class="description"><div class="short"><p>Fired when a operation encountered an exception</p>
 391 </div><div class="long"><p>Fired when a operation encountered an exception</p>
 392 <h3 class="pa">Parameters</h3><ul><li><span class="pre">batch</span> : Ext.data.Batch<div class="sub-desc"><p>The batch object</p>
 393 </div></li><li><span class="pre">operation</span> : Object<div class="sub-desc"><p>The operation that encountered the exception</p>
 394 </div></li></ul></div></div></div><div id="event-operationcomplete" class="member ni"><a href="Ext.data.Batch.html#event-operationcomplete" rel="event-operationcomplete" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Batch.html" class="definedIn docClass">Ext.data.Batch</a><br/><a href="../source/Batch.html#Ext-data.Batch-event-operationcomplete" class="viewSource">view source</a></div><a name="operationcomplete"></a><a name="event-operationcomplete"></a><a href="Ext.data.Batch.html#" rel="event-operationcomplete" class="cls expand">operationcomplete</a>(
 395 <span class="pre">Ext.data.Batch batch, Object operation</span>)
 396 </div><div class="description"><div class="short"><p>Fired when each operation of the batch completes</p>
 397 </div><div class="long"><p>Fired when each operation of the batch completes</p>
 398 <h3 class="pa">Parameters</h3><ul><li><span class="pre">batch</span> : Ext.data.Batch<div class="sub-desc"><p>The batch object</p>
 399 </div></li><li><span class="pre">operation</span> : Object<div class="sub-desc"><p>The operation that just completed</p>
 400 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>