docs/output/Ext.Updater.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.Updater-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.Updater-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.Updater-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.Updater-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
   7                         <a class="bookmark" href="../docs/?class=Ext.Updater"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   8         </div>
   9                 <div class="inheritance res-block">
  10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
  11   <img src="resources/elbow-end.gif"/>Updater</pre></div>
  12                 <h1>Class Ext.Updater</h1>
  13         <table cellspacing="0">
  14             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
  15             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/UpdateManager.js" target="_blank">UpdateManager.js</a></td></tr>
  16             <tr><td class="label">Class:</td><td class="hd-info">Updater</td></tr>
  17                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
  18                     </table>
  19         <div class="description">
  20             *
  21 Provides AJAX-style update capabilities for Element objects.  Updater can be used to <a ext:cls="Ext.Updater" ext:member="update" href="output/Ext.Updater.html#update">update</a> an Element once,
  22 or you can use <a ext:cls="Ext.Updater" ext:member="startAutoRefresh" href="output/Ext.Updater.html#startAutoRefresh">startAutoRefresh</a> to set up an auto-updating Element on a specific interval.<br><br>
  23 Usage:<br>
  24 <pre><code><i>// Get it from a Ext.Element object</i>
  25 <b>var</b> el = Ext.get(<em>"foo"</em>);
  26 <b>var</b> mgr = el.getUpdater();
  27 mgr.update({
  28         url: <em>"http:<i>//myserver.com/index.php"</em>,</i>
  29         params: {
  30             param1: <em>"foo"</em>,
  31             param2: <em>"bar"</em>
  32         }
  33 });
  34 ...
  35 mgr.formUpdate(<em>"myFormId"</em>, <em>"http:<i>//myserver.com/index.php"</em>);</i>
  36 <br>
  37 <i>// or directly (returns the same Updater instance)</i>
  38 <b>var</b> mgr = <b>new</b> Ext.Updater(<em>"myElementId"</em>);
  39 mgr.startAutoRefresh(60, <em>"http:<i>//myserver.com/index.php"</em>);</i>
  40 mgr.on(<em>"update"</em>, myFcnNeedsToKnow);
  41 <br>
  42 <i>// short handed call directly from the element object</i>
  43 Ext.get(<em>"foo"</em>).load({
  44         url: <em>"bar.php"</em>,
  45         scripts: true,
  46         params: <em>"param1=foo&amp;param2=bar"</em>,
  47         text: <em>"Loading Foo..."</em>
  48 });</code></pre>        </div>
  49
  50         <div class="hr"></div>
  51                 <a id="Ext.Updater-configs"></a>
  52         <h2>Config Options</h2>
  53         <table cellspacing="0" class="member-table">
  54             <tr>
  55                 <th class="sig-header" colspan="2">Config Options</th>
  56                 <th class="msource-header">Defined By</th>
  57             </tr>
  58                 <tr class="config-row inherited expandable">\r
  59         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  60         <td class="sig">\r
  61         <a id="Ext.Updater-listeners"></a>\r
  62             <b>listeners</b> : Object            <div class="mdesc">\r
  63                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
  64             <div class="long">\r
  65                 (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>\r
  66                         </div>\r
  67         </td>\r
  68         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
  69     </tr>\r
  70             </table>
  71                 <a id="Ext.Updater-props"></a>
  72         <h2>Public Properties</h2>
  73                 <table cellspacing="0" class="member-table">
  74             <tr>
  75                 <th class="sig-header" colspan="2">Property</th>
  76                 <th class="msource-header">Defined By</th>
  77             </tr>
  78                 <tr class="property-row">\r
  79         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  80         <td class="sig">\r
  81         <a id="Ext.Updater-defaultUrl"></a>\r
  82             <b>defaultUrl</b> : String            <div class="mdesc">\r
  83                             Cached url to use for refreshes. Overwritten every time update() is called unless "discardUrl" param is set to true.                        </div>\r
  84         </td>\r
  85         <td class="msource">Updater</td>\r
  86     </tr>\r
  87         <tr class="property-row alt">\r
  88         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  89         <td class="sig">\r
  90         <a id="Ext.Updater-disableCaching"></a>\r
  91             <b>disableCaching</b> : Boolean            <div class="mdesc">\r
  92                             Whether to append unique parameter on get request to disable caching (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="disableCaching" href="output/Ext.Updater.defaults.html#disableCaching">Ext.Updater.defaults.disableCaching</a>).                        </div>\r
  93         </td>\r
  94         <td class="msource">Updater</td>\r
  95     </tr>\r
  96         <tr class="property-row">\r
  97         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  98         <td class="sig">\r
  99         <a id="Ext.Updater-el"></a>\r
 100             <b>el</b> : Ext.Element            <div class="mdesc">\r
 101                             The Element object                        </div>\r
 102         </td>\r
 103         <td class="msource">Updater</td>\r
 104     </tr>\r
 105         <tr class="property-row alt expandable">\r
 106         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 107         <td class="sig">\r
 108         <a id="Ext.Updater-formUpdateDelegate"></a>\r
 109             <b>formUpdateDelegate</b> : Function            <div class="mdesc">\r
 110                         <div class="short">Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arg...</div>\r
 111             <div class="long">\r
 112                 Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments            </div>\r
 113                         </div>\r
 114         </td>\r
 115         <td class="msource">Updater</td>\r
 116     </tr>\r
 117         <tr class="property-row">\r
 118         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 119         <td class="sig">\r
 120         <a id="Ext.Updater-indicatorText"></a>\r
 121             <b>indicatorText</b> : String            <div class="mdesc">\r
 122                             Text for loading indicator (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="indicatorText" href="output/Ext.Updater.defaults.html#indicatorText">Ext.Updater.defaults.indicatorText</a>).                        </div>\r
 123         </td>\r
 124         <td class="msource">Updater</td>\r
 125     </tr>\r
 126         <tr class="property-row alt">\r
 127         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 128         <td class="sig">\r
 129         <a id="Ext.Updater-loadScripts"></a>\r
 130             <b>loadScripts</b> : Boolean            <div class="mdesc">\r
 131                             True to process scripts in the output (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="loadScripts" href="output/Ext.Updater.defaults.html#loadScripts">Ext.Updater.defaults.loadScripts</a>).                        </div>\r
 132         </td>\r
 133         <td class="msource">Updater</td>\r
 134     </tr>\r
 135         <tr class="property-row">\r
 136         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 137         <td class="sig">\r
 138         <a id="Ext.Updater-refreshDelegate"></a>\r
 139             <b>refreshDelegate</b> : Function            <div class="mdesc">\r
 140                             Delegate for refresh() prebound to "this", use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments                        </div>\r
 141         </td>\r
 142         <td class="msource">Updater</td>\r
 143     </tr>\r
 144         <tr class="property-row alt">\r
 145         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 146         <td class="sig">\r
 147         <a id="Ext.Updater-renderer"></a>\r
 148             <b>renderer</b> : Object            <div class="mdesc">\r
 149                             The renderer for this Updater (defaults to <a ext:cls="Ext.Updater.BasicRenderer" href="output/Ext.Updater.BasicRenderer.html">Ext.Updater.BasicRenderer</a>).                        </div>\r
 150         </td>\r
 151         <td class="msource">Updater</td>\r
 152     </tr>\r
 153         <tr class="property-row">\r
 154         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 155         <td class="sig">\r
 156         <a id="Ext.Updater-showLoadIndicator"></a>\r
 157             <b>showLoadIndicator</b> : String            <div class="mdesc">\r
 158                             Whether to show indicatorText when loading (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="showLoadIndicator" href="output/Ext.Updater.defaults.html#showLoadIndicator">Ext.Updater.defaults.showLoadIndicator</a>).                        </div>\r
 159         </td>\r
 160         <td class="msource">Updater</td>\r
 161     </tr>\r
 162         <tr class="property-row alt">\r
 163         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 164         <td class="sig">\r
 165         <a id="Ext.Updater-sslBlankUrl"></a>\r
 166             <b>sslBlankUrl</b> : String            <div class="mdesc">\r
 167                             Blank page URL to use with SSL file uploads (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="sslBlankUrl" href="output/Ext.Updater.defaults.html#sslBlankUrl">Ext.Updater.defaults.sslBlankUrl</a>).                        </div>\r
 168         </td>\r
 169         <td class="msource">Updater</td>\r
 170     </tr>\r
 171         <tr class="property-row">\r
 172         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 173         <td class="sig">\r
 174         <a id="Ext.Updater-timeout"></a>\r
 175             <b>timeout</b> : Number            <div class="mdesc">\r
 176                             Timeout for requests or form posts in seconds (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="timeout" href="output/Ext.Updater.defaults.html#timeout">Ext.Updater.defaults.timeout</a>).                        </div>\r
 177         </td>\r
 178         <td class="msource">Updater</td>\r
 179     </tr>\r
 180         <tr class="property-row alt">\r
 181         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 182         <td class="sig">\r
 183         <a id="Ext.Updater-transaction"></a>\r
 184             <b>transaction</b> : Object            <div class="mdesc">\r
 185                             Transaction object of the current executing transaction, or null if there is no active transaction.                        </div>\r
 186         </td>\r
 187         <td class="msource">Updater</td>\r
 188     </tr>\r
 189         <tr class="property-row">\r
 190         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 191         <td class="sig">\r
 192         <a id="Ext.Updater-updateDelegate"></a>\r
 193             <b>updateDelegate</b> : Function            <div class="mdesc">\r
 194                             Delegate for update() prebound to "this", use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments                        </div>\r
 195         </td>\r
 196         <td class="msource">Updater</td>\r
 197     </tr>\r
 198             </table>
 199                 <a id="Ext.Updater-methods"></a>
 200         <h2>Public Methods</h2>
 201                 <table cellspacing="0" class="member-table">
 202             <tr>
 203                 <th class="sig-header" colspan="2">Method</th>
 204                 <th class="msource-header">Defined By</th>
 205             </tr>
 206                 <tr class="method-row expandable">\r
 207         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 208         <td class="sig">\r
 209         <a id="Ext.Updater-Updater"></a>\r
 210             <b>Updater</b>(&nbsp;<code>Mixed el</code>, <span class="optional" title="Optional">[<code>Boolean forceNew</code>]</span>&nbsp;)            <div class="mdesc">\r
 211                         <div class="short">Create new Updater directly.</div>\r
 212             <div class="long">\r
 213                 Create new Updater directly.    <div class="mdetail-params">\r
 214         <strong>Parameters:</strong>\r
 215         <ul><li><code>el</code> : Mixed<div class="sub-desc">The element to update</div></li><li><code>forceNew</code> : Boolean<div class="sub-desc">(optional) By default the constructor checks to see if the passed element already
 216 has an Updater and if it does it returns the same instance. This will skip that check (useful for extending this class).</div></li>        </ul>\r
 217         <strong>Returns:</strong>\r
 218         <ul>\r
 219             <li><code></code></li>\r
 220         </ul>\r
 221     </div>\r
 222                 </div>\r
 223                         </div>\r
 224         </td>\r
 225         <td class="msource">Updater</td>\r
 226     </tr>\r
 227         <tr class="method-row alt expandable">\r
 228         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 229         <td class="sig">\r
 230         <a id="Ext.Updater-Updater.updateElement"></a>\r
 231             <b>Updater.updateElement</b>(&nbsp;<code>Mixed el</code>, <code>String url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 232                         <div class="short">Deprecated. &lt;static&gt; Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ....</div>\r
 233             <div class="long">\r
 234                 <b>Deprecated.</b> &lt;static&gt; Static convenience method. <b>This method is deprecated in favor of el.load({url:'foo.php', ...})</b>.
 235 Usage:
 236 <pre><code>Ext.Updater.updateElement(<em>"my-div"</em>, <em>"stuff.php"</em>);</code></pre>    <div class="mdetail-params">\r
 237         <strong>Parameters:</strong>\r
 238         <ul><li><code>el</code> : Mixed<div class="sub-desc">The element to update</div></li><li><code>url</code> : String<div class="sub-desc">The url</div></li><li><code>params</code> : String/Object<div class="sub-desc">(optional) Url encoded param string or an object of name/value pairs</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) A config object with any of the Updater properties you want to set - for
 239 example: {disableCaching:true, indicatorText: "Loading data..."}</div></li>        </ul>\r
 240         <strong>Returns:</strong>\r
 241         <ul>\r
 242             <li><code>void</code></li>\r
 243         </ul>\r
 244     </div>\r
 245                 </div>\r
 246                         </div>\r
 247         </td>\r
 248         <td class="msource">Updater</td>\r
 249     </tr>\r
 250         <tr class="method-row expandable">\r
 251         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 252         <td class="sig">\r
 253         <a id="Ext.Updater-abort"></a>\r
 254             <b>abort</b>() : void            <div class="mdesc">\r
 255                         <div class="short">Aborts the currently executing transaction, if any.</div>\r
 256             <div class="long">\r
 257                 Aborts the currently executing transaction, if any.    <div class="mdetail-params">\r
 258         <strong>Parameters:</strong>\r
 259         <ul><li>None.</li>        </ul>\r
 260         <strong>Returns:</strong>\r
 261         <ul>\r
 262             <li><code>void</code></li>\r
 263         </ul>\r
 264     </div>\r
 265                 </div>\r
 266                         </div>\r
 267         </td>\r
 268         <td class="msource">Updater</td>\r
 269     </tr>\r
 270         <tr class="method-row inherited alt expandable">\r
 271         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 272         <td class="sig">\r
 273         <a id="Ext.Updater-addEvents"></a>\r
 274             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
 275                         <div class="short">Used to define events on this Observable</div>\r
 276             <div class="long">\r
 277                 Used to define events on this Observable    <div class="mdetail-params">\r
 278         <strong>Parameters:</strong>\r
 279         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
 280         <strong>Returns:</strong>\r
 281         <ul>\r
 282             <li><code>void</code></li>\r
 283         </ul>\r
 284     </div>\r
 285                 </div>\r
 286                         </div>\r
 287         </td>\r
 288         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
 289     </tr>\r
 290         <tr class="method-row inherited expandable">\r
 291         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 292         <td class="sig">\r
 293         <a id="Ext.Updater-addListener"></a>\r
 294             <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 295                         <div class="short">Appends an event handler to this component</div>\r
 296             <div class="long">\r
 297                 Appends an event handler to this component    <div class="mdetail-params">\r
 298         <strong>Parameters:</strong>\r
 299         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
 300 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
 301 properties. This may contain any of the following properties:<ul>
 302 <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
 303 <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
 304 <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
 305 <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
 306 by the specified number of milliseconds. If the event fires again within that time, the original
 307 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
 308 </ul><br>
 309 <p>
 310 <b>Combining Options</b><br>
 311 Using the options argument, it is possible to combine different types of listeners:<br>
 312 <br>
 313 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
 314 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
 315     single: true,
 316     delay: 100,
 317     forumId: 4
 318 });</code></pre>
 319 <p>
 320 <b>Attaching multiple handlers in 1 call</b><br>
 321 The method also allows for a single argument to be passed which is a config object containing properties
 322 which specify multiple handlers.
 323 <p>
 324 <pre><code>foo.on({
 325     <em>'click'</em> : {
 326         fn: <b>this</b>.onClick,
 327         scope: <b>this</b>,
 328         delay: 100
 329     },
 330     <em>'mouseover'</em> : {
 331         fn: <b>this</b>.onMouseOver,
 332         scope: <b>this</b>
 333     },
 334     <em>'mouseout'</em> : {
 335         fn: <b>this</b>.onMouseOut,
 336         scope: <b>this</b>
 337     }
 338 });</code></pre>
 339 <p>
 340 Or a shorthand syntax:<br>
 341 <pre><code>foo.on({
 342     <em>'click'</em> : <b>this</b>.onClick,
 343     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
 344     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
 345      scope: <b>this</b>
 346 });</code></pre></div></li>        </ul>\r
 347         <strong>Returns:</strong>\r
 348         <ul>\r
 349             <li><code>void</code></li>\r
 350         </ul>\r
 351     </div>\r
 352                 </div>\r
 353                         </div>\r
 354         </td>\r
 355         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
 356     </tr>\r
 357         <tr class="method-row inherited alt expandable">\r
 358         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 359         <td class="sig">\r
 360         <a id="Ext.Updater-fireEvent"></a>\r
 361             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
 362                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
 363             <div class="long">\r
 364                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
 365         <strong>Parameters:</strong>\r
 366         <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>\r
 367         <strong>Returns:</strong>\r
 368         <ul>\r
 369             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
 370         </ul>\r
 371     </div>\r
 372                 </div>\r
 373                         </div>\r
 374         </td>\r
 375         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
 376     </tr>\r
 377         <tr class="method-row expandable">\r
 378         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 379         <td class="sig">\r
 380         <a id="Ext.Updater-formUpdate"></a>\r
 381             <b>formUpdate</b>(&nbsp;<code>String/HTMLElement form</code>, <span class="optional" title="Optional">[<code>String url</code>]</span>, <span class="optional" title="Optional">[<code>Boolean reset</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 382                         <div class="short">Performs an async form post, updating this element with the response. If the form has the attribute
 383 enctype="multipar...</div>\r
 384             <div class="long">\r
 385                 <p>Performs an async form post, updating this element with the response. If the form has the attribute
 386 enctype="<a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form-data</a>", it assumes it's a file upload.
 387 Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning.</p>
 388 <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>
 389 performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
 390 DOM <tt>&lt;form></tt> element temporarily modified to have its
 391 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
 392 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
 393 but removed after the return data has been gathered.</p>
 394 <p>Be aware that file upload packets, sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form-data</a>
 395 and some server technologies (notably JEE) may require some custom processing in order to
 396 retrieve parameter names and parameter values from the packet content.</p>    <div class="mdetail-params">\r
 397         <strong>Parameters:</strong>\r
 398         <ul><li><code>form</code> : String/HTMLElement<div class="sub-desc">The form Id or form element</div></li><li><code>url</code> : String<div class="sub-desc">(optional) The url to pass the form to. If omitted the action attribute on the form will be used.</div></li><li><code>reset</code> : Boolean<div class="sub-desc">(optional) Whether to try to reset the form after the update</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Callback when transaction is complete. The following
 399 parameters are passed:<ul>
 400 <li><b>el</b> : Ext.Element<p class="sub-desc">The Element being updated.</p></li>
 401 <li><b>success</b> : Boolean<p class="sub-desc">True for success, false for failure.</p></li>
 402 <li><b>response</b> : XMLHttpRequest<p class="sub-desc">The XMLHttpRequest which processed the update.</p></li></ul></div></li>        </ul>\r
 403         <strong>Returns:</strong>\r
 404         <ul>\r
 405             <li><code>void</code></li>\r
 406         </ul>\r
 407     </div>\r
 408                 </div>\r
 409                         </div>\r
 410         </td>\r
 411         <td class="msource">Updater</td>\r
 412     </tr>\r
 413         <tr class="method-row alt expandable">\r
 414         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 415         <td class="sig">\r
 416         <a id="Ext.Updater-getDefaultRenderer"></a>\r
 417             <b>getDefaultRenderer</b>() : void            <div class="mdesc">\r
 418                         <div class="short">This is an overrideable method which returns a reference to a default
 419 renderer class if none is specified when creati...</div>\r
 420             <div class="long">\r
 421                 This is an overrideable method which returns a reference to a default
 422 renderer class if none is specified when creating the Ext.Updater.
 423 Defaults to <a ext:cls="Ext.Updater.BasicRenderer" href="output/Ext.Updater.BasicRenderer.html">Ext.Updater.BasicRenderer</a>    <div class="mdetail-params">\r
 424         <strong>Parameters:</strong>\r
 425         <ul><li>None.</li>        </ul>\r
 426         <strong>Returns:</strong>\r
 427         <ul>\r
 428             <li><code>void</code></li>\r
 429         </ul>\r
 430     </div>\r
 431                 </div>\r
 432                         </div>\r
 433         </td>\r
 434         <td class="msource">Updater</td>\r
 435     </tr>\r
 436         <tr class="method-row expandable">\r
 437         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 438         <td class="sig">\r
 439         <a id="Ext.Updater-getEl"></a>\r
 440             <b>getEl</b>() : Ext.Element            <div class="mdesc">\r
 441                         <div class="short">Get the Element this Updater is bound to</div>\r
 442             <div class="long">\r
 443                 Get the Element this Updater is bound to    <div class="mdetail-params">\r
 444         <strong>Parameters:</strong>\r
 445         <ul><li>None.</li>        </ul>\r
 446         <strong>Returns:</strong>\r
 447         <ul>\r
 448             <li><code>Ext.Element</code><div class="sub-desc">The element</div></li>\r
 449         </ul>\r
 450     </div>\r
 451                 </div>\r
 452                         </div>\r
 453         </td>\r
 454         <td class="msource">Updater</td>\r
 455     </tr>\r
 456         <tr class="method-row alt expandable">\r
 457         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 458         <td class="sig">\r
 459         <a id="Ext.Updater-getRenderer"></a>\r
 460             <b>getRenderer</b>() : Object            <div class="mdesc">\r
 461                         <div class="short">Returns the content renderer for this Updater. See <a ext:cls="Ext.Updater.BasicRenderer" ext:member="render" href="output/Ext.Updater.BasicRenderer.html#render">Ext.Updater.BasicRenderer.render</a> for more details.</div>\r
 462             <div class="long">\r
 463                 Returns the content renderer for this Updater. See <a ext:cls="Ext.Updater.BasicRenderer" ext:member="render" href="output/Ext.Updater.BasicRenderer.html#render">Ext.Updater.BasicRenderer.render</a> for more details.    <div class="mdetail-params">\r
 464         <strong>Parameters:</strong>\r
 465         <ul><li>None.</li>        </ul>\r
 466         <strong>Returns:</strong>\r
 467         <ul>\r
 468             <li><code>Object</code></li>\r
 469         </ul>\r
 470     </div>\r
 471                 </div>\r
 472                         </div>\r
 473         </td>\r
 474         <td class="msource">Updater</td>\r
 475     </tr>\r
 476         <tr class="method-row inherited expandable">\r
 477         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 478         <td class="sig">\r
 479         <a id="Ext.Updater-hasListener"></a>\r
 480             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
 481                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
 482             <div class="long">\r
 483                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
 484         <strong>Parameters:</strong>\r
 485         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
 486         <strong>Returns:</strong>\r
 487         <ul>\r
 488             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
 489         </ul>\r
 490     </div>\r
 491                 </div>\r
 492                         </div>\r
 493         </td>\r
 494         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
 495     </tr>\r
 496         <tr class="method-row alt expandable">\r
 497         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 498         <td class="sig">\r
 499         <a id="Ext.Updater-isAutoRefreshing"></a>\r
 500             <b>isAutoRefreshing</b>() : void            <div class="mdesc">\r
 501                         <div class="short">Returns true if the Updater is currently set to auto refresh its content (see <a ext:cls="Ext.Updater" ext:member="startAutoRefresh" href="output/Ext.Updater.html#startAutoRefresh">startAutoRefresh</a>), otherwise false.</div>\r
 502             <div class="long">\r
 503                 Returns true if the Updater is currently set to auto refresh its content (see <a ext:cls="Ext.Updater" ext:member="startAutoRefresh" href="output/Ext.Updater.html#startAutoRefresh">startAutoRefresh</a>), otherwise false.    <div class="mdetail-params">\r
 504         <strong>Parameters:</strong>\r
 505         <ul><li>None.</li>        </ul>\r
 506         <strong>Returns:</strong>\r
 507         <ul>\r
 508             <li><code>void</code></li>\r
 509         </ul>\r
 510     </div>\r
 511                 </div>\r
 512                         </div>\r
 513         </td>\r
 514         <td class="msource">Updater</td>\r
 515     </tr>\r
 516         <tr class="method-row expandable">\r
 517         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 518         <td class="sig">\r
 519         <a id="Ext.Updater-isUpdating"></a>\r
 520             <b>isUpdating</b>() : Boolean            <div class="mdesc">\r
 521                         <div class="short">Returns true if an update is in progress, otherwise false.</div>\r
 522             <div class="long">\r
 523                 Returns true if an update is in progress, otherwise false.    <div class="mdetail-params">\r
 524         <strong>Parameters:</strong>\r
 525         <ul><li>None.</li>        </ul>\r
 526         <strong>Returns:</strong>\r
 527         <ul>\r
 528             <li><code>Boolean</code></li>\r
 529         </ul>\r
 530     </div>\r
 531                 </div>\r
 532                         </div>\r
 533         </td>\r
 534         <td class="msource">Updater</td>\r
 535     </tr>\r
 536         <tr class="method-row inherited alt expandable">\r
 537         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 538         <td class="sig">\r
 539         <a id="Ext.Updater-on"></a>\r
 540             <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 541                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
 542             <div class="long">\r
 543                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
 544         <strong>Parameters:</strong>\r
 545         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
 546 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
 547         <strong>Returns:</strong>\r
 548         <ul>\r
 549             <li><code>void</code></li>\r
 550         </ul>\r
 551     </div>\r
 552                 </div>\r
 553                         </div>\r
 554         </td>\r
 555         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
 556     </tr>\r
 557         <tr class="method-row inherited expandable">\r
 558         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 559         <td class="sig">\r
 560         <a id="Ext.Updater-purgeListeners"></a>\r
 561             <b>purgeListeners</b>() : void            <div class="mdesc">\r
 562                         <div class="short">Removes all listeners for this object</div>\r
 563             <div class="long">\r
 564                 Removes all listeners for this object    <div class="mdetail-params">\r
 565         <strong>Parameters:</strong>\r
 566         <ul><li>None.</li>        </ul>\r
 567         <strong>Returns:</strong>\r
 568         <ul>\r
 569             <li><code>void</code></li>\r
 570         </ul>\r
 571     </div>\r
 572                 </div>\r
 573                         </div>\r
 574         </td>\r
 575         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
 576     </tr>\r
 577         <tr class="method-row alt expandable">\r
 578         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 579         <td class="sig">\r
 580         <a id="Ext.Updater-refresh"></a>\r
 581             <b>refresh</b>(&nbsp;<span class="optional" title="Optional">[<code>Function callback</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 582                         <div class="short">Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately</div>\r
 583             <div class="long">\r
 584                 Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately    <div class="mdetail-params">\r
 585         <strong>Parameters:</strong>\r
 586         <ul><li><code>callback</code> : Function<div class="sub-desc">(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</div></li>        </ul>\r
 587         <strong>Returns:</strong>\r
 588         <ul>\r
 589             <li><code>void</code></li>\r
 590         </ul>\r
 591     </div>\r
 592                 </div>\r
 593                         </div>\r
 594         </td>\r
 595         <td class="msource">Updater</td>\r
 596     </tr>\r
 597         <tr class="method-row inherited expandable">\r
 598         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 599         <td class="sig">\r
 600         <a id="Ext.Updater-relayEvents"></a>\r
 601             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
 602                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
 603             <div class="long">\r
 604                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
 605         <strong>Parameters:</strong>\r
 606         <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>\r
 607         <strong>Returns:</strong>\r
 608         <ul>\r
 609             <li><code>void</code></li>\r
 610         </ul>\r
 611     </div>\r
 612                 </div>\r
 613                         </div>\r
 614         </td>\r
 615         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
 616     </tr>\r
 617         <tr class="method-row inherited alt expandable">\r
 618         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 619         <td class="sig">\r
 620         <a id="Ext.Updater-removeListener"></a>\r
 621             <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 622                         <div class="short">Removes a listener</div>\r
 623             <div class="long">\r
 624                 Removes a listener    <div class="mdetail-params">\r
 625         <strong>Parameters:</strong>\r
 626         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
 627         <strong>Returns:</strong>\r
 628         <ul>\r
 629             <li><code>void</code></li>\r
 630         </ul>\r
 631     </div>\r
 632                 </div>\r
 633                         </div>\r
 634         </td>\r
 635         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
 636     </tr>\r
 637         <tr class="method-row inherited expandable">\r
 638         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 639         <td class="sig">\r
 640         <a id="Ext.Updater-resumeEvents"></a>\r
 641             <b>resumeEvents</b>() : void            <div class="mdesc">\r
 642                         <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
 643             <div class="long">\r
 644                 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">\r
 645         <strong>Parameters:</strong>\r
 646         <ul><li>None.</li>        </ul>\r
 647         <strong>Returns:</strong>\r
 648         <ul>\r
 649             <li><code>void</code></li>\r
 650         </ul>\r
 651     </div>\r
 652                 </div>\r
 653                         </div>\r
 654         </td>\r
 655         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
 656     </tr>\r
 657         <tr class="method-row alt expandable">\r
 658         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 659         <td class="sig">\r
 660         <a id="Ext.Updater-setDefaultUrl"></a>\r
 661             <b>setDefaultUrl</b>(&nbsp;<code>String/Function defaultUrl</code>&nbsp;) : void            <div class="mdesc">\r
 662                         <div class="short">Sets the default URL used for updates.</div>\r
 663             <div class="long">\r
 664                 Sets the default URL used for updates.    <div class="mdetail-params">\r
 665         <strong>Parameters:</strong>\r
 666         <ul><li><code>defaultUrl</code> : String/Function<div class="sub-desc">The url or a function to call to get the url</div></li>        </ul>\r
 667         <strong>Returns:</strong>\r
 668         <ul>\r
 669             <li><code>void</code></li>\r
 670         </ul>\r
 671     </div>\r
 672                 </div>\r
 673                         </div>\r
 674         </td>\r
 675         <td class="msource">Updater</td>\r
 676     </tr>\r
 677         <tr class="method-row expandable">\r
 678         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 679         <td class="sig">\r
 680         <a id="Ext.Updater-setRenderer"></a>\r
 681             <b>setRenderer</b>(&nbsp;<code>Object renderer</code>&nbsp;) : void            <div class="mdesc">\r
 682                         <div class="short">Sets the content renderer for this Updater. See <a ext:cls="Ext.Updater.BasicRenderer" ext:member="render" href="output/Ext.Updater.BasicRenderer.html#render">Ext.Updater.BasicRenderer.render</a> for more details.</div>\r
 683             <div class="long">\r
 684                 Sets the content renderer for this Updater. See <a ext:cls="Ext.Updater.BasicRenderer" ext:member="render" href="output/Ext.Updater.BasicRenderer.html#render">Ext.Updater.BasicRenderer.render</a> for more details.    <div class="mdetail-params">\r
 685         <strong>Parameters:</strong>\r
 686         <ul><li><code>renderer</code> : Object<div class="sub-desc">The object implementing the render() method</div></li>        </ul>\r
 687         <strong>Returns:</strong>\r
 688         <ul>\r
 689             <li><code>void</code></li>\r
 690         </ul>\r
 691     </div>\r
 692                 </div>\r
 693                         </div>\r
 694         </td>\r
 695         <td class="msource">Updater</td>\r
 696     </tr>\r
 697         <tr class="method-row alt expandable">\r
 698         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 699         <td class="sig">\r
 700         <a id="Ext.Updater-showLoading"></a>\r
 701             <b>showLoading</b>() : void            <div class="mdesc">\r
 702                         <div class="short">Display the element's "loading" state. By default, the element is updated with indicatorText. This
 703 method may be over...</div>\r
 704             <div class="long">\r
 705                 Display the element's "loading" state. By default, the element is updated with <a ext:cls="Ext.Updater" ext:member="indicatorText" href="output/Ext.Updater.html#indicatorText">indicatorText</a>. This
 706 method may be overridden to perform a custom action while this Updater is actively updating its contents.    <div class="mdetail-params">\r
 707         <strong>Parameters:</strong>\r
 708         <ul><li>None.</li>        </ul>\r
 709         <strong>Returns:</strong>\r
 710         <ul>\r
 711             <li><code>void</code></li>\r
 712         </ul>\r
 713     </div>\r
 714                 </div>\r
 715                         </div>\r
 716         </td>\r
 717         <td class="msource">Updater</td>\r
 718     </tr>\r
 719         <tr class="method-row expandable">\r
 720         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 721         <td class="sig">\r
 722         <a id="Ext.Updater-startAutoRefresh"></a>\r
 723             <b>startAutoRefresh</b>(&nbsp;<code>Number interval</code>, <span class="optional" title="Optional">[<code>String/Object/Function url</code>]</span>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>, <span class="optional" title="Optional">[<code>Boolean refreshNow</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 724                         <div class="short">Set this element to auto refresh.  Can be canceled by calling <a ext:cls="Ext.Updater" ext:member="stopAutoRefresh" href="output/Ext.Updater.html#stopAutoRefresh">stopAutoRefresh</a>.</div>\r
 725             <div class="long">\r
 726                 Set this element to auto refresh.  Can be canceled by calling <a ext:cls="Ext.Updater" ext:member="stopAutoRefresh" href="output/Ext.Updater.html#stopAutoRefresh">stopAutoRefresh</a>.    <div class="mdetail-params">\r
 727         <strong>Parameters:</strong>\r
 728         <ul><li><code>interval</code> : Number<div class="sub-desc">How often to update (in seconds).</div></li><li><code>url</code> : String/Object/Function<div class="sub-desc">(optional) The url for this request, a config object in the same format
 729 supported by <a ext:cls="Ext.Updater" ext:member="load" href="output/Ext.Updater.html#load">load</a>, or a function to call to get the url (defaults to the last used url). Note that while
 730 the url used in a load call can be reused by this method, other load config options will not be reused and must be
 731 sepcified as part of a config object passed as this paramter if needed.</div></li><li><code>params</code> : String/Object<div class="sub-desc">(optional) The parameters to pass as either a url encoded string
 732 "&param1=1&param2=2" or as an object {param1: 1, param2: 2}</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</div></li><li><code>refreshNow</code> : Boolean<div class="sub-desc">(optional) Whether to execute the refresh now, or wait the interval</div></li>        </ul>\r
 733         <strong>Returns:</strong>\r
 734         <ul>\r
 735             <li><code>void</code></li>\r
 736         </ul>\r
 737     </div>\r
 738                 </div>\r
 739                         </div>\r
 740         </td>\r
 741         <td class="msource">Updater</td>\r
 742     </tr>\r
 743         <tr class="method-row alt expandable">\r
 744         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 745         <td class="sig">\r
 746         <a id="Ext.Updater-stopAutoRefresh"></a>\r
 747             <b>stopAutoRefresh</b>() : void            <div class="mdesc">\r
 748                         <div class="short">Stop auto refresh on this element.</div>\r
 749             <div class="long">\r
 750                 Stop auto refresh on this element.    <div class="mdetail-params">\r
 751         <strong>Parameters:</strong>\r
 752         <ul><li>None.</li>        </ul>\r
 753         <strong>Returns:</strong>\r
 754         <ul>\r
 755             <li><code>void</code></li>\r
 756         </ul>\r
 757     </div>\r
 758                 </div>\r
 759                         </div>\r
 760         </td>\r
 761         <td class="msource">Updater</td>\r
 762     </tr>\r
 763         <tr class="method-row inherited expandable">\r
 764         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 765         <td class="sig">\r
 766         <a id="Ext.Updater-suspendEvents"></a>\r
 767             <b>suspendEvents</b>() : void            <div class="mdesc">\r
 768                         <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
 769             <div class="long">\r
 770                 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">\r
 771         <strong>Parameters:</strong>\r
 772         <ul><li>None.</li>        </ul>\r
 773         <strong>Returns:</strong>\r
 774         <ul>\r
 775             <li><code>void</code></li>\r
 776         </ul>\r
 777     </div>\r
 778                 </div>\r
 779                         </div>\r
 780         </td>\r
 781         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
 782     </tr>\r
 783         <tr class="method-row inherited alt expandable">\r
 784         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 785         <td class="sig">\r
 786         <a id="Ext.Updater-un"></a>\r
 787             <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 788                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
 789             <div class="long">\r
 790                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
 791         <strong>Parameters:</strong>\r
 792         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
 793         <strong>Returns:</strong>\r
 794         <ul>\r
 795             <li><code>void</code></li>\r
 796         </ul>\r
 797     </div>\r
 798                 </div>\r
 799                         </div>\r
 800         </td>\r
 801         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
 802     </tr>\r
 803         <tr class="method-row expandable">\r
 804         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 805         <td class="sig">\r
 806         <a id="Ext.Updater-update"></a>\r
 807             <b>update</b>(&nbsp;<code>Object options</code>&nbsp;) : void            <div class="mdesc">\r
 808                         <div class="short">Performs an asynchronous request, updating this element with the response.
 809 If params are specified it uses POST, othe...</div>\r
 810             <div class="long">\r
 811                 Performs an <b>asynchronous</b> request, updating this element with the response.
 812 If params are specified it uses POST, otherwise it uses GET.<br><br>
 813 <b>Note:</b> Due to the asynchronous nature of remote server requests, the Element
 814 will not have been fully updated when the function returns. To post-process the returned
 815 data, use the callback option, or an <b><tt>update</tt></b> event handler.    <div class="mdetail-params">\r
 816         <strong>Parameters:</strong>\r
 817         <ul><li><code>options</code> : Object<div class="sub-desc">A config object containing any of the following options:<ul>
 818 <li>url : <b>String/Function</b><p class="sub-desc">The URL to request or a function which
 819 <i>returns</i> the URL (defaults to the value of <a ext:cls="Ext.Ajax" ext:member="url" href="output/Ext.Ajax.html#url">Ext.Ajax.url</a> if not specified).</p></li>
 820 <li>method : <b>String</b><p class="sub-desc">The HTTP method to
 821 use. Defaults to POST if the <tt>params</tt> argument is present, otherwise GET.</p></li>
 822 <li>params : <b>String/Object/Function</b><p class="sub-desc">The
 823 parameters to pass to the server (defaults to none). These may be specified as a url-encoded
 824 string, or as an object containing properties which represent parameters,
 825 or as a function, which returns such an object.</p></li>
 826 <li>scripts : <b>Boolean</b><p class="sub-desc">If <tt>true</tt>
 827 any &lt;script&gt; tags embedded in the response text will be extracted
 828 and executed (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="loadScripts" href="output/Ext.Updater.defaults.html#loadScripts">Ext.Updater.defaults.loadScripts</a>). If this option is specified,
 829 the callback will be called <i>after</i> the execution of the scripts.</p></li>
 830 <li>callback : <b>Function</b><p class="sub-desc">A function to
 831 be called when the response from the server arrives. The following
 832 parameters are passed:<ul>
 833 <li><b>el</b> : Ext.Element<p class="sub-desc">The Element being updated.</p></li>
 834 <li><b>success</b> : Boolean<p class="sub-desc">True for success, false for failure.</p></li>
 835 <li><b>response</b> : XMLHttpRequest<p class="sub-desc">The XMLHttpRequest which processed the update.</p></li>
 836 <li><b>options</b> : Object<p class="sub-desc">The config object passed to the update call.</p></li></ul>
 837 </p></li>
 838 <li>scope : <b>Object</b><p class="sub-desc">The scope in which
 839 to execute the callback (The callback's <tt>this</tt> reference.) If the
 840 <tt>params</tt> argument is a function, this scope is used for that function also.</p></li>
 841 <li>discardUrl : <b>Boolean</b><p class="sub-desc">By default, the URL of this request becomes
 842 the default URL for this Updater object, and will be subsequently used in <a ext:cls="Ext.Updater" ext:member="refresh" href="output/Ext.Updater.html#refresh">refresh</a>
 843 calls. To bypass this behavior, pass <tt>discardUrl:true</tt> (defaults to false).</p></li>
 844 <li>timeout : <b>Number</b><p class="sub-desc">The number of seconds to wait for a response before
 845 timing out (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="timeout" href="output/Ext.Updater.defaults.html#timeout">Ext.Updater.defaults.timeout</a>).</p></li>
 846 <li>text : <b>String</b><p class="sub-desc">The text to use as the innerHTML of the
 847 <a ext:cls="Ext.Updater.defaults" ext:member="indicatorText" href="output/Ext.Updater.defaults.html#indicatorText">Ext.Updater.defaults.indicatorText</a> div (defaults to 'Loading...'). To replace the entire div, not
 848 just the text, override <a ext:cls="Ext.Updater.defaults" ext:member="indicatorText" href="output/Ext.Updater.defaults.html#indicatorText">Ext.Updater.defaults.indicatorText</a> directly.</p></li>
 849 <li>nocache : <b>Boolean</b><p class="sub-desc">Only needed for GET
 850 requests, this option causes an extra, auto-generated parameter to be appended to the request
 851 to defeat caching (defaults to <a ext:cls="Ext.Updater.defaults" ext:member="disableCaching" href="output/Ext.Updater.defaults.html#disableCaching">Ext.Updater.defaults.disableCaching</a>).</p></li></ul>
 852 <p>
 853 For example:\r
 854 <pre><code>um.update({
 855     url: <em>"your-url.php"</em>,
 856     params: {param1: <em>"foo"</em>, param2: <em>"bar"</em>}, <i>// or a URL encoded string</i>
 857     callback: yourFunction,
 858     scope: yourObject, <i>//(optional scope)</i>
 859     discardUrl: true,
 860     nocache: true,
 861     text: <em>"Loading..."</em>,
 862     timeout: 60,
 863     scripts: false <i>// Save time by avoiding RegExp execution.</i>
 864 });</code></pre></div></li>        </ul>\r
 865         <strong>Returns:</strong>\r
 866         <ul>\r
 867             <li><code>void</code></li>\r
 868         </ul>\r
 869     </div>\r
 870                 </div>\r
 871                         </div>\r
 872         </td>\r
 873         <td class="msource">Updater</td>\r
 874     </tr>\r
 875             </table>
 876                 <a id="Ext.Updater-events"></a>
 877         <h2>Public Events</h2>
 878                 <table cellspacing="0" class="member-table">
 879             <tr>
 880                 <th class="sig-header" colspan="2">Event</th>
 881                 <th class="msource-header">Defined By</th>
 882             </tr>
 883                 <tr class="event-row expandable">\r
 884         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 885         <td class="sig">\r
 886         <a id="Ext.Updater-beforeupdate"></a>\r
 887             <b>beforeupdate</b> : (&nbsp;<code>Ext.Element el</code>, <code>String/Object/Function url</code>, <code>String/Object params</code>&nbsp;)            <div class="mdesc">\r
 888                         <div class="short">Fired before an update is made, return false from your handler and the update is cancelled.</div>\r
 889             <div class="long">\r
 890                 Fired before an update is made, return false from your handler and the update is cancelled.    <div class="mdetail-params">\r
 891         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 892         <ul><li><code>el</code> : Ext.Element<div class="sub-desc"></div></li><li><code>url</code> : String/Object/Function<div class="sub-desc"></div></li><li><code>params</code> : String/Object<div class="sub-desc"></div></li>        </ul>\r
 893     </div>\r
 894                 </div>\r
 895                         </div>\r
 896         </td>\r
 897         <td class="msource">Updater</td>\r
 898     </tr>\r
 899         <tr class="event-row alt expandable">\r
 900         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 901         <td class="sig">\r
 902         <a id="Ext.Updater-failure"></a>\r
 903             <b>failure</b> : (&nbsp;<code>Ext.Element el</code>, <code>Object oResponseObject</code>&nbsp;)            <div class="mdesc">\r
 904                         <div class="short">Fired on update failure.</div>\r
 905             <div class="long">\r
 906                 Fired on update failure.    <div class="mdetail-params">\r
 907         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 908         <ul><li><code>el</code> : Ext.Element<div class="sub-desc"></div></li><li><code>oResponseObject</code> : Object<div class="sub-desc">The response Object</div></li>        </ul>\r
 909     </div>\r
 910                 </div>\r
 911                         </div>\r
 912         </td>\r
 913         <td class="msource">Updater</td>\r
 914     </tr>\r
 915         <tr class="event-row expandable">\r
 916         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 917         <td class="sig">\r
 918         <a id="Ext.Updater-update"></a>\r
 919             <b>update</b> : (&nbsp;<code>Ext.Element el</code>, <code>Object oResponseObject</code>&nbsp;)            <div class="mdesc">\r
 920                         <div class="short">Fired after successful update is made.</div>\r
 921             <div class="long">\r
 922                 Fired after successful update is made.    <div class="mdetail-params">\r
 923         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 924         <ul><li><code>el</code> : Ext.Element<div class="sub-desc"></div></li><li><code>oResponseObject</code> : Object<div class="sub-desc">The response Object</div></li>        </ul>\r
 925     </div>\r
 926                 </div>\r
 927                         </div>\r
 928         </td>\r
 929         <td class="msource">Updater</td>\r
 930     </tr>\r
 931             </table>
 932
 933         </div>