source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.Updater.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 55.6 KB
Line 
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            *
21Provides 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,
22or 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>
23Usage:<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();
27mgr.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...
35mgr.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>);
39mgr.startAutoRefresh(60, <em>"http:<i>//myserver.com/index.php"</em>);</i>
40mgr.on(<em>"update"</em>, myFcnNeedsToKnow);
41<br>
42<i>// short handed call directly from the element object</i>
43Ext.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">
59        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
60        <td class="sig">
61        <a id="Ext.Updater-listeners"></a>
62            <b>listeners</b> : Object            <div class="mdesc">
63                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
64            <div class="long">
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>
66                        </div>
67        </td>
68        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
69    </tr>
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">
79        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
80        <td class="sig">
81        <a id="Ext.Updater-defaultUrl"></a>
82            <b>defaultUrl</b> : String            <div class="mdesc">
83                            Cached url to use for refreshes. Overwritten every time update() is called unless "discardUrl" param is set to true.                        </div>
84        </td>
85        <td class="msource">Updater</td>
86    </tr>
87        <tr class="property-row alt">
88        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
89        <td class="sig">
90        <a id="Ext.Updater-disableCaching"></a>
91            <b>disableCaching</b> : Boolean            <div class="mdesc">
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>
93        </td>
94        <td class="msource">Updater</td>
95    </tr>
96        <tr class="property-row">
97        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
98        <td class="sig">
99        <a id="Ext.Updater-el"></a>
100            <b>el</b> : Ext.Element            <div class="mdesc">
101                            The Element object                        </div>
102        </td>
103        <td class="msource">Updater</td>
104    </tr>
105        <tr class="property-row alt expandable">
106        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
107        <td class="sig">
108        <a id="Ext.Updater-formUpdateDelegate"></a>
109            <b>formUpdateDelegate</b> : Function            <div class="mdesc">
110                        <div class="short">Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arg...</div>
111            <div class="long">
112                Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments            </div>
113                        </div>
114        </td>
115        <td class="msource">Updater</td>
116    </tr>
117        <tr class="property-row">
118        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
119        <td class="sig">
120        <a id="Ext.Updater-indicatorText"></a>
121            <b>indicatorText</b> : String            <div class="mdesc">
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>
123        </td>
124        <td class="msource">Updater</td>
125    </tr>
126        <tr class="property-row alt">
127        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
128        <td class="sig">
129        <a id="Ext.Updater-loadScripts"></a>
130            <b>loadScripts</b> : Boolean            <div class="mdesc">
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>
132        </td>
133        <td class="msource">Updater</td>
134    </tr>
135        <tr class="property-row">
136        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
137        <td class="sig">
138        <a id="Ext.Updater-refreshDelegate"></a>
139            <b>refreshDelegate</b> : Function            <div class="mdesc">
140                            Delegate for refresh() prebound to "this", use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments                        </div>
141        </td>
142        <td class="msource">Updater</td>
143    </tr>
144        <tr class="property-row alt">
145        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
146        <td class="sig">
147        <a id="Ext.Updater-renderer"></a>
148            <b>renderer</b> : Object            <div class="mdesc">
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>
150        </td>
151        <td class="msource">Updater</td>
152    </tr>
153        <tr class="property-row">
154        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
155        <td class="sig">
156        <a id="Ext.Updater-showLoadIndicator"></a>
157            <b>showLoadIndicator</b> : String            <div class="mdesc">
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>
159        </td>
160        <td class="msource">Updater</td>
161    </tr>
162        <tr class="property-row alt">
163        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
164        <td class="sig">
165        <a id="Ext.Updater-sslBlankUrl"></a>
166            <b>sslBlankUrl</b> : String            <div class="mdesc">
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>
168        </td>
169        <td class="msource">Updater</td>
170    </tr>
171        <tr class="property-row">
172        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
173        <td class="sig">
174        <a id="Ext.Updater-timeout"></a>
175            <b>timeout</b> : Number            <div class="mdesc">
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>
177        </td>
178        <td class="msource">Updater</td>
179    </tr>
180        <tr class="property-row alt">
181        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
182        <td class="sig">
183        <a id="Ext.Updater-transaction"></a>
184            <b>transaction</b> : Object            <div class="mdesc">
185                            Transaction object of the current executing transaction, or null if there is no active transaction.                        </div>
186        </td>
187        <td class="msource">Updater</td>
188    </tr>
189        <tr class="property-row">
190        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
191        <td class="sig">
192        <a id="Ext.Updater-updateDelegate"></a>
193            <b>updateDelegate</b> : Function            <div class="mdesc">
194                            Delegate for update() prebound to "this", use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments                        </div>
195        </td>
196        <td class="msource">Updater</td>
197    </tr>
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">
207        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
208        <td class="sig">
209        <a id="Ext.Updater-Updater"></a>
210            <b>Updater</b>(&nbsp;<code>Mixed el</code>, <span class="optional" title="Optional">[<code>Boolean forceNew</code>]</span>&nbsp;)            <div class="mdesc">
211                        <div class="short">Create new Updater directly.</div>
212            <div class="long">
213                Create new Updater directly.    <div class="mdetail-params">
214        <strong>Parameters:</strong>
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
216has an Updater and if it does it returns the same instance. This will skip that check (useful for extending this class).</div></li>        </ul>
217        <strong>Returns:</strong>
218        <ul>
219            <li><code></code></li>
220        </ul>
221    </div>
222                </div>
223                        </div>
224        </td>
225        <td class="msource">Updater</td>
226    </tr>
227        <tr class="method-row alt expandable">
228        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
229        <td class="sig">
230        <a id="Ext.Updater-Updater.updateElement"></a>
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">
232                        <div class="short">Deprecated. &lt;static&gt; Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ....</div>
233            <div class="long">
234                <b>Deprecated.</b> &lt;static&gt; Static convenience method. <b>This method is deprecated in favor of el.load({url:'foo.php', ...})</b>.
235Usage:
236<pre><code>Ext.Updater.updateElement(<em>"my-div"</em>, <em>"stuff.php"</em>);</code></pre>    <div class="mdetail-params">
237        <strong>Parameters:</strong>
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
239example: {disableCaching:true, indicatorText: "Loading data..."}</div></li>        </ul>
240        <strong>Returns:</strong>
241        <ul>
242            <li><code>void</code></li>
243        </ul>
244    </div>
245                </div>
246                        </div>
247        </td>
248        <td class="msource">Updater</td>
249    </tr>
250        <tr class="method-row expandable">
251        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
252        <td class="sig">
253        <a id="Ext.Updater-abort"></a>
254            <b>abort</b>() : void            <div class="mdesc">
255                        <div class="short">Aborts the currently executing transaction, if any.</div>
256            <div class="long">
257                Aborts the currently executing transaction, if any.    <div class="mdetail-params">
258        <strong>Parameters:</strong>
259        <ul><li>None.</li>        </ul>
260        <strong>Returns:</strong>
261        <ul>
262            <li><code>void</code></li>
263        </ul>
264    </div>
265                </div>
266                        </div>
267        </td>
268        <td class="msource">Updater</td>
269    </tr>
270        <tr class="method-row inherited alt expandable">
271        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
272        <td class="sig">
273        <a id="Ext.Updater-addEvents"></a>
274            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
275                        <div class="short">Used to define events on this Observable</div>
276            <div class="long">
277                Used to define events on this Observable    <div class="mdetail-params">
278        <strong>Parameters:</strong>
279        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
280        <strong>Returns:</strong>
281        <ul>
282            <li><code>void</code></li>
283        </ul>
284    </div>
285                </div>
286                        </div>
287        </td>
288        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
289    </tr>
290        <tr class="method-row inherited expandable">
291        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
292        <td class="sig">
293        <a id="Ext.Updater-addListener"></a>
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">
295                        <div class="short">Appends an event handler to this component</div>
296            <div class="long">
297                Appends an event handler to this component    <div class="mdetail-params">
298        <strong>Parameters:</strong>
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
300function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
301properties. 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
306by the specified number of milliseconds. If the event fires again within that time, the original
307handler 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>
311Using the options argument, it is possible to combine different types of listeners:<br>
312<br>
313A 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>
321The method also allows for a single argument to be passed which is a config object containing properties
322which 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>
340Or 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>
347        <strong>Returns:</strong>
348        <ul>
349            <li><code>void</code></li>
350        </ul>
351    </div>
352                </div>
353                        </div>
354        </td>
355        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
356    </tr>
357        <tr class="method-row inherited alt expandable">
358        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
359        <td class="sig">
360        <a id="Ext.Updater-fireEvent"></a>
361            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
362                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
363            <div class="long">
364                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
365        <strong>Parameters:</strong>
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>
367        <strong>Returns:</strong>
368        <ul>
369            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
370        </ul>
371    </div>
372                </div>
373                        </div>
374        </td>
375        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
376    </tr>
377        <tr class="method-row expandable">
378        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
379        <td class="sig">
380        <a id="Ext.Updater-formUpdate"></a>
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">
382                        <div class="short">Performs an async form post, updating this element with the response. If the form has the attribute
383enctype="multipar...</div>
384            <div class="long">
385                <p>Performs an async form post, updating this element with the response. If the form has the attribute
386enctype="<a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form-data</a>", it assumes it's a file upload.
387Uses 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>
389performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
390DOM <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
392to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
393but 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>
395and some server technologies (notably JEE) may require some custom processing in order to
396retrieve parameter names and parameter values from the packet content.</p>    <div class="mdetail-params">
397        <strong>Parameters:</strong>
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
399parameters 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>
403        <strong>Returns:</strong>
404        <ul>
405            <li><code>void</code></li>
406        </ul>
407    </div>
408                </div>
409                        </div>
410        </td>
411        <td class="msource">Updater</td>
412    </tr>
413        <tr class="method-row alt expandable">
414        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
415        <td class="sig">
416        <a id="Ext.Updater-getDefaultRenderer"></a>
417            <b>getDefaultRenderer</b>() : void            <div class="mdesc">
418                        <div class="short">This is an overrideable method which returns a reference to a default
419renderer class if none is specified when creati...</div>
420            <div class="long">
421                This is an overrideable method which returns a reference to a default
422renderer class if none is specified when creating the Ext.Updater.
423Defaults to <a ext:cls="Ext.Updater.BasicRenderer" href="output/Ext.Updater.BasicRenderer.html">Ext.Updater.BasicRenderer</a>    <div class="mdetail-params">
424        <strong>Parameters:</strong>
425        <ul><li>None.</li>        </ul>
426        <strong>Returns:</strong>
427        <ul>
428            <li><code>void</code></li>
429        </ul>
430    </div>
431                </div>
432                        </div>
433        </td>
434        <td class="msource">Updater</td>
435    </tr>
436        <tr class="method-row expandable">
437        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
438        <td class="sig">
439        <a id="Ext.Updater-getEl"></a>
440            <b>getEl</b>() : Ext.Element            <div class="mdesc">
441                        <div class="short">Get the Element this Updater is bound to</div>
442            <div class="long">
443                Get the Element this Updater is bound to    <div class="mdetail-params">
444        <strong>Parameters:</strong>
445        <ul><li>None.</li>        </ul>
446        <strong>Returns:</strong>
447        <ul>
448            <li><code>Ext.Element</code><div class="sub-desc">The element</div></li>
449        </ul>
450    </div>
451                </div>
452                        </div>
453        </td>
454        <td class="msource">Updater</td>
455    </tr>
456        <tr class="method-row alt expandable">
457        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
458        <td class="sig">
459        <a id="Ext.Updater-getRenderer"></a>
460            <b>getRenderer</b>() : Object            <div class="mdesc">
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>
462            <div class="long">
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">
464        <strong>Parameters:</strong>
465        <ul><li>None.</li>        </ul>
466        <strong>Returns:</strong>
467        <ul>
468            <li><code>Object</code></li>
469        </ul>
470    </div>
471                </div>
472                        </div>
473        </td>
474        <td class="msource">Updater</td>
475    </tr>
476        <tr class="method-row inherited expandable">
477        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
478        <td class="sig">
479        <a id="Ext.Updater-hasListener"></a>
480            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
481                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
482            <div class="long">
483                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
484        <strong>Parameters:</strong>
485        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
486        <strong>Returns:</strong>
487        <ul>
488            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
489        </ul>
490    </div>
491                </div>
492                        </div>
493        </td>
494        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
495    </tr>
496        <tr class="method-row alt expandable">
497        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
498        <td class="sig">
499        <a id="Ext.Updater-isAutoRefreshing"></a>
500            <b>isAutoRefreshing</b>() : void            <div class="mdesc">
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>
502            <div class="long">
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">
504        <strong>Parameters:</strong>
505        <ul><li>None.</li>        </ul>
506        <strong>Returns:</strong>
507        <ul>
508            <li><code>void</code></li>
509        </ul>
510    </div>
511                </div>
512                        </div>
513        </td>
514        <td class="msource">Updater</td>
515    </tr>
516        <tr class="method-row expandable">
517        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
518        <td class="sig">
519        <a id="Ext.Updater-isUpdating"></a>
520            <b>isUpdating</b>() : Boolean            <div class="mdesc">
521                        <div class="short">Returns true if an update is in progress, otherwise false.</div>
522            <div class="long">
523                Returns true if an update is in progress, otherwise false.    <div class="mdetail-params">
524        <strong>Parameters:</strong>
525        <ul><li>None.</li>        </ul>
526        <strong>Returns:</strong>
527        <ul>
528            <li><code>Boolean</code></li>
529        </ul>
530    </div>
531                </div>
532                        </div>
533        </td>
534        <td class="msource">Updater</td>
535    </tr>
536        <tr class="method-row inherited alt expandable">
537        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
538        <td class="sig">
539        <a id="Ext.Updater-on"></a>
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">
541                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
542            <div class="long">
543                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
544        <strong>Parameters:</strong>
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
546function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
547        <strong>Returns:</strong>
548        <ul>
549            <li><code>void</code></li>
550        </ul>
551    </div>
552                </div>
553                        </div>
554        </td>
555        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
556    </tr>
557        <tr class="method-row inherited expandable">
558        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
559        <td class="sig">
560        <a id="Ext.Updater-purgeListeners"></a>
561            <b>purgeListeners</b>() : void            <div class="mdesc">
562                        <div class="short">Removes all listeners for this object</div>
563            <div class="long">
564                Removes all listeners for this object    <div class="mdetail-params">
565        <strong>Parameters:</strong>
566        <ul><li>None.</li>        </ul>
567        <strong>Returns:</strong>
568        <ul>
569            <li><code>void</code></li>
570        </ul>
571    </div>
572                </div>
573                        </div>
574        </td>
575        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
576    </tr>
577        <tr class="method-row alt expandable">
578        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
579        <td class="sig">
580        <a id="Ext.Updater-refresh"></a>
581            <b>refresh</b>(&nbsp;<span class="optional" title="Optional">[<code>Function callback</code>]</span>&nbsp;) : void            <div class="mdesc">
582                        <div class="short">Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately</div>
583            <div class="long">
584                Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately    <div class="mdetail-params">
585        <strong>Parameters:</strong>
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>
587        <strong>Returns:</strong>
588        <ul>
589            <li><code>void</code></li>
590        </ul>
591    </div>
592                </div>
593                        </div>
594        </td>
595        <td class="msource">Updater</td>
596    </tr>
597        <tr class="method-row inherited expandable">
598        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
599        <td class="sig">
600        <a id="Ext.Updater-relayEvents"></a>
601            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
602                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
603            <div class="long">
604                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
605        <strong>Parameters:</strong>
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>
607        <strong>Returns:</strong>
608        <ul>
609            <li><code>void</code></li>
610        </ul>
611    </div>
612                </div>
613                        </div>
614        </td>
615        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
616    </tr>
617        <tr class="method-row inherited alt expandable">
618        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
619        <td class="sig">
620        <a id="Ext.Updater-removeListener"></a>
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">
622                        <div class="short">Removes a listener</div>
623            <div class="long">
624                Removes a listener    <div class="mdetail-params">
625        <strong>Parameters:</strong>
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>
627        <strong>Returns:</strong>
628        <ul>
629            <li><code>void</code></li>
630        </ul>
631    </div>
632                </div>
633                        </div>
634        </td>
635        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
636    </tr>
637        <tr class="method-row inherited expandable">
638        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
639        <td class="sig">
640        <a id="Ext.Updater-resumeEvents"></a>
641            <b>resumeEvents</b>() : void            <div class="mdesc">
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>
643            <div class="long">
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">
645        <strong>Parameters:</strong>
646        <ul><li>None.</li>        </ul>
647        <strong>Returns:</strong>
648        <ul>
649            <li><code>void</code></li>
650        </ul>
651    </div>
652                </div>
653                        </div>
654        </td>
655        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
656    </tr>
657        <tr class="method-row alt expandable">
658        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
659        <td class="sig">
660        <a id="Ext.Updater-setDefaultUrl"></a>
661            <b>setDefaultUrl</b>(&nbsp;<code>String/Function defaultUrl</code>&nbsp;) : void            <div class="mdesc">
662                        <div class="short">Sets the default URL used for updates.</div>
663            <div class="long">
664                Sets the default URL used for updates.    <div class="mdetail-params">
665        <strong>Parameters:</strong>
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>
667        <strong>Returns:</strong>
668        <ul>
669            <li><code>void</code></li>
670        </ul>
671    </div>
672                </div>
673                        </div>
674        </td>
675        <td class="msource">Updater</td>
676    </tr>
677        <tr class="method-row expandable">
678        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
679        <td class="sig">
680        <a id="Ext.Updater-setRenderer"></a>
681            <b>setRenderer</b>(&nbsp;<code>Object renderer</code>&nbsp;) : void            <div class="mdesc">
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>
683            <div class="long">
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">
685        <strong>Parameters:</strong>
686        <ul><li><code>renderer</code> : Object<div class="sub-desc">The object implementing the render() method</div></li>        </ul>
687        <strong>Returns:</strong>
688        <ul>
689            <li><code>void</code></li>
690        </ul>
691    </div>
692                </div>
693                        </div>
694        </td>
695        <td class="msource">Updater</td>
696    </tr>
697        <tr class="method-row alt expandable">
698        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
699        <td class="sig">
700        <a id="Ext.Updater-showLoading"></a>
701            <b>showLoading</b>() : void            <div class="mdesc">
702                        <div class="short">Display the element's "loading" state. By default, the element is updated with indicatorText. This
703method may be over...</div>
704            <div class="long">
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
706method may be overridden to perform a custom action while this Updater is actively updating its contents.    <div class="mdetail-params">
707        <strong>Parameters:</strong>
708        <ul><li>None.</li>        </ul>
709        <strong>Returns:</strong>
710        <ul>
711            <li><code>void</code></li>
712        </ul>
713    </div>
714                </div>
715                        </div>
716        </td>
717        <td class="msource">Updater</td>
718    </tr>
719        <tr class="method-row expandable">
720        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
721        <td class="sig">
722        <a id="Ext.Updater-startAutoRefresh"></a>
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">
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>
725            <div class="long">
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">
727        <strong>Parameters:</strong>
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
729supported 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
730the url used in a load call can be reused by this method, other load config options will not be reused and must be
731sepcified 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>
733        <strong>Returns:</strong>
734        <ul>
735            <li><code>void</code></li>
736        </ul>
737    </div>
738                </div>
739                        </div>
740        </td>
741        <td class="msource">Updater</td>
742    </tr>
743        <tr class="method-row alt expandable">
744        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
745        <td class="sig">
746        <a id="Ext.Updater-stopAutoRefresh"></a>
747            <b>stopAutoRefresh</b>() : void            <div class="mdesc">
748                        <div class="short">Stop auto refresh on this element.</div>
749            <div class="long">
750                Stop auto refresh on this element.    <div class="mdetail-params">
751        <strong>Parameters:</strong>
752        <ul><li>None.</li>        </ul>
753        <strong>Returns:</strong>
754        <ul>
755            <li><code>void</code></li>
756        </ul>
757    </div>
758                </div>
759                        </div>
760        </td>
761        <td class="msource">Updater</td>
762    </tr>
763        <tr class="method-row inherited expandable">
764        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
765        <td class="sig">
766        <a id="Ext.Updater-suspendEvents"></a>
767            <b>suspendEvents</b>() : void            <div class="mdesc">
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>
769            <div class="long">
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">
771        <strong>Parameters:</strong>
772        <ul><li>None.</li>        </ul>
773        <strong>Returns:</strong>
774        <ul>
775            <li><code>void</code></li>
776        </ul>
777    </div>
778                </div>
779                        </div>
780        </td>
781        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
782    </tr>
783        <tr class="method-row inherited alt expandable">
784        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
785        <td class="sig">
786        <a id="Ext.Updater-un"></a>
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">
788                        <div class="short">Removes a listener (shorthand for removeListener)</div>
789            <div class="long">
790                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
791        <strong>Parameters:</strong>
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>
793        <strong>Returns:</strong>
794        <ul>
795            <li><code>void</code></li>
796        </ul>
797    </div>
798                </div>
799                        </div>
800        </td>
801        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
802    </tr>
803        <tr class="method-row expandable">
804        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
805        <td class="sig">
806        <a id="Ext.Updater-update"></a>
807            <b>update</b>(&nbsp;<code>Object options</code>&nbsp;) : void            <div class="mdesc">
808                        <div class="short">Performs an asynchronous request, updating this element with the response.
809If params are specified it uses POST, othe...</div>
810            <div class="long">
811                Performs an <b>asynchronous</b> request, updating this element with the response.
812If 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
814will not have been fully updated when the function returns. To post-process the returned
815data, use the callback option, or an <b><tt>update</tt></b> event handler.    <div class="mdetail-params">
816        <strong>Parameters:</strong>
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
821use. 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
823parameters to pass to the server (defaults to none). These may be specified as a url-encoded
824string, or as an object containing properties which represent parameters,
825or as a function, which returns such an object.</p></li>
826<li>scripts : <b>Boolean</b><p class="sub-desc">If <tt>true</tt>
827any &lt;script&gt; tags embedded in the response text will be extracted
828and 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,
829the 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
831be called when the response from the server arrives. The following
832parameters 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
839to 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
842the 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>
843calls. 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
845timing 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
848just 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
850requests, this option causes an extra, auto-generated parameter to be appended to the request
851to 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>
853For example:
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>
865        <strong>Returns:</strong>
866        <ul>
867            <li><code>void</code></li>
868        </ul>
869    </div>
870                </div>
871                        </div>
872        </td>
873        <td class="msource">Updater</td>
874    </tr>
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">
884        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
885        <td class="sig">
886        <a id="Ext.Updater-beforeupdate"></a>
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">
888                        <div class="short">Fired before an update is made, return false from your handler and the update is cancelled.</div>
889            <div class="long">
890                Fired before an update is made, return false from your handler and the update is cancelled.    <div class="mdetail-params">
891        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
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>
893    </div>
894                </div>
895                        </div>
896        </td>
897        <td class="msource">Updater</td>
898    </tr>
899        <tr class="event-row alt expandable">
900        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
901        <td class="sig">
902        <a id="Ext.Updater-failure"></a>
903            <b>failure</b> : (&nbsp;<code>Ext.Element el</code>, <code>Object oResponseObject</code>&nbsp;)            <div class="mdesc">
904                        <div class="short">Fired on update failure.</div>
905            <div class="long">
906                Fired on update failure.    <div class="mdetail-params">
907        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
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>
909    </div>
910                </div>
911                        </div>
912        </td>
913        <td class="msource">Updater</td>
914    </tr>
915        <tr class="event-row expandable">
916        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
917        <td class="sig">
918        <a id="Ext.Updater-update"></a>
919            <b>update</b> : (&nbsp;<code>Ext.Element el</code>, <code>Object oResponseObject</code>&nbsp;)            <div class="mdesc">
920                        <div class="short">Fired after successful update is made.</div>
921            <div class="long">
922                Fired after successful update is made.    <div class="mdetail-params">
923        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
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>
925    </div>
926                </div>
927                        </div>
928        </td>
929        <td class="msource">Updater</td>
930    </tr>
931            </table>
932       
933        </div>
Note: See TracBrowser for help on using the repository browser.