4d4df011b543c668726f8acdebb13b1548bb019c
[roojs1] / docs / src / Roo_UpdateManager.js.html
1 <html><head><title>/home/edward/gitlive/roojs1/Roo/UpdateManager.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * &lt;script type=&quot;text/javascript&quot;&gt;
10  */
11
12
13 /**
14  * @class Roo.UpdateManager
15  * @extends Roo.util.Observable
16  * Provides AJAX-style update for Element object.&lt;br&gt;&lt;br&gt;
17  * Usage:&lt;br&gt;
18  * &lt;pre&gt;&lt;code&gt;
19  * // Get it from a Roo.Element object
20  * var el = Roo.get(&quot;foo&quot;);
21  * var mgr = el.getUpdateManager();
22  * mgr.update(&quot;http://myserver.com/index.php&quot;, &quot;param1=1&amp;amp;param2=2&quot;);
23  * ...
24  * mgr.formUpdate(&quot;myFormId&quot;, &quot;http://myserver.com/index.php&quot;);
25  * &lt;br&gt;
26  * // or directly (returns the same UpdateManager instance)
27  * var mgr = new Roo.UpdateManager(&quot;myElementId&quot;);
28  * mgr.startAutoRefresh(60, &quot;http://myserver.com/index.php&quot;);
29  * mgr.on(&quot;update&quot;, myFcnNeedsToKnow);
30  * &lt;br&gt;
31    // short handed call directly from the element object
32    Roo.get(&quot;foo&quot;).load({
33         url: &quot;bar.php&quot;,
34         scripts:true,
35         params: &quot;for=bar&quot;,
36         text: &quot;Loading Foo...&quot;
37    });
38  * &lt;/code&gt;&lt;/pre&gt;
39  * @constructor
40  * Create new UpdateManager directly.
41  * @param {String/HTMLElement/Roo.Element} el The element to update
42  * @param {Boolean} forceNew (optional) By default the constructor checks to see if the passed element already has an UpdateManager and if it does it returns the same instance. This will skip that check (useful for extending this class).
43  */
44 </span><span class="jsdoc-var">Roo.UpdateManager </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">forceNew</span><span class="jsdoc-syntax">){
45     </span><span class="jsdoc-var">el </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.get</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">);
46     </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">forceNew </span><span class="jsdoc-syntax">&amp;&amp; </span><span class="jsdoc-var">el.updateManager</span><span class="jsdoc-syntax">){
47         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">el.updateManager</span><span class="jsdoc-syntax">;
48     }
49     </span><span class="jsdoc-comment">/**
50      * The Element object
51      * @type Roo.Element
52      */
53     </span><span class="jsdoc-var">this.el </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">;
54     </span><span class="jsdoc-comment">/**
55      * Cached url to use for refreshes. Overwritten every time update() is called unless &quot;discardUrl&quot; param is set to true.
56      * @type String
57      */
58     </span><span class="jsdoc-var">this.defaultUrl </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
59
60     </span><span class="jsdoc-var">this.addEvents</span><span class="jsdoc-syntax">({
61         </span><span class="jsdoc-comment">/**
62          * @event beforeupdate
63          * Fired before an update is made, return false from your handler and the update is cancelled.
64          * @param {Roo.Element} el
65          * @param {String/Object/Function} url
66          * @param {String/Object} params
67          */
68         </span><span class="jsdoc-string">&quot;beforeupdate&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
69         </span><span class="jsdoc-comment">/**
70          * @event update
71          * Fired after successful update is made.
72          * @param {Roo.Element} el
73          * @param {Object} oResponseObject The response Object
74          */
75         </span><span class="jsdoc-string">&quot;update&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
76         </span><span class="jsdoc-comment">/**
77          * @event failure
78          * Fired on update failure.
79          * @param {Roo.Element} el
80          * @param {Object} oResponseObject The response Object
81          */
82         </span><span class="jsdoc-string">&quot;failure&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true
83     </span><span class="jsdoc-syntax">});
84     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">d </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.UpdateManager.defaults</span><span class="jsdoc-syntax">;
85     </span><span class="jsdoc-comment">/**
86      * Blank page URL to use with SSL file uploads (Defaults to Roo.UpdateManager.defaults.sslBlankUrl or &quot;about:blank&quot;).
87      * @type String
88      */
89     </span><span class="jsdoc-var">this.sslBlankUrl </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">d.sslBlankUrl</span><span class="jsdoc-syntax">;
90     </span><span class="jsdoc-comment">/**
91      * Whether to append unique parameter on get request to disable caching (Defaults to Roo.UpdateManager.defaults.disableCaching or false).
92      * @type Boolean
93      */
94     </span><span class="jsdoc-var">this.disableCaching </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">d.disableCaching</span><span class="jsdoc-syntax">;
95     </span><span class="jsdoc-comment">/**
96      * Text for loading indicator (Defaults to Roo.UpdateManager.defaults.indicatorText or '&amp;lt;div class=&quot;loading-indicator&quot;&amp;gt;Loading...&amp;lt;/div&amp;gt;').
97      * @type String
98      */
99     </span><span class="jsdoc-var">this.indicatorText </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">d.indicatorText</span><span class="jsdoc-syntax">;
100     </span><span class="jsdoc-comment">/**
101      * Whether to show indicatorText when loading (Defaults to Roo.UpdateManager.defaults.showLoadIndicator or true).
102      * @type String
103      */
104     </span><span class="jsdoc-var">this.showLoadIndicator </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">d.showLoadIndicator</span><span class="jsdoc-syntax">;
105     </span><span class="jsdoc-comment">/**
106      * Timeout for requests or form posts in seconds (Defaults to Roo.UpdateManager.defaults.timeout or 30 seconds).
107      * @type Number
108      */
109     </span><span class="jsdoc-var">this.timeout </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">d.timeout</span><span class="jsdoc-syntax">;
110
111     </span><span class="jsdoc-comment">/**
112      * True to process scripts in the output (Defaults to Roo.UpdateManager.defaults.loadScripts (false)).
113      * @type Boolean
114      */
115     </span><span class="jsdoc-var">this.loadScripts </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">d.loadScripts</span><span class="jsdoc-syntax">;
116
117     </span><span class="jsdoc-comment">/**
118      * Transaction object of current executing transaction
119      */
120     </span><span class="jsdoc-var">this.transaction </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
121
122     </span><span class="jsdoc-comment">/**
123      * @private
124      */
125     </span><span class="jsdoc-var">this.autoRefreshProcId </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
126     </span><span class="jsdoc-comment">/**
127      * Delegate for refresh() prebound to &quot;this&quot;, use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments
128      * @type Function
129      */
130     </span><span class="jsdoc-var">this.refreshDelegate </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.refresh.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
131     </span><span class="jsdoc-comment">/**
132      * Delegate for update() prebound to &quot;this&quot;, use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments
133      * @type Function
134      */
135     </span><span class="jsdoc-var">this.updateDelegate </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.update.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
136     </span><span class="jsdoc-comment">/**
137      * Delegate for formUpdate() prebound to &quot;this&quot;, use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments
138      * @type Function
139      */
140     </span><span class="jsdoc-var">this.formUpdateDelegate </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.formUpdate.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
141     </span><span class="jsdoc-comment">/**
142      * @private
143      */
144     </span><span class="jsdoc-var">this.successDelegate </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.processSuccess.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
145     </span><span class="jsdoc-comment">/**
146      * @private
147      */
148     </span><span class="jsdoc-var">this.failureDelegate </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.processFailure.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
149
150     </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">this.renderer</span><span class="jsdoc-syntax">){
151      </span><span class="jsdoc-comment">/**
152       * The renderer for this UpdateManager. Defaults to {@link Roo.UpdateManager.BasicRenderer}.
153       */
154     </span><span class="jsdoc-var">this.renderer </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Roo.UpdateManager.BasicRenderer</span><span class="jsdoc-syntax">();
155     }
156
157     </span><span class="jsdoc-var">Roo.UpdateManager.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
158 };
159
160 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.UpdateManager</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.util.Observable</span><span class="jsdoc-syntax">, {
161     </span><span class="jsdoc-comment">/**
162      * Get the Element this UpdateManager is bound to
163      * @return {Roo.Element} The element
164      */
165     </span><span class="jsdoc-var">getEl </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
166         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">;
167     },
168     </span><span class="jsdoc-comment">/**
169      * Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.
170      * @param {Object/String/Function} url The url for this request or a function to call to get the url or a config object containing any of the following options:
171 &lt;pre&gt;&lt;code&gt;
172 um.update({&lt;br/&gt;
173     url: &quot;your-url.php&quot;,&lt;br/&gt;
174     params: {param1: &quot;foo&quot;, param2: &quot;bar&quot;}, // or a URL encoded string&lt;br/&gt;
175     callback: yourFunction,&lt;br/&gt;
176     scope: yourObject, //(optional scope)  &lt;br/&gt;
177     discardUrl: false, &lt;br/&gt;
178     nocache: false,&lt;br/&gt;
179     text: &quot;Loading...&quot;,&lt;br/&gt;
180     timeout: 30,&lt;br/&gt;
181     scripts: false&lt;br/&gt;
182 });
183 &lt;/code&gt;&lt;/pre&gt;
184      * The only required property is url. The optional properties nocache, text and scripts
185      * are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.
186      * @param {String/Object} params (optional) The parameters to pass as either a url encoded string &quot;param1=1&amp;amp;param2=2&quot; or an object {param1: 1, param2: 2}
187      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)
188      * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.
189      */
190     </span><span class="jsdoc-var">update </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">discardUrl</span><span class="jsdoc-syntax">){
191         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;beforeupdate&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">) !== </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">){
192             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">method </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.method</span><span class="jsdoc-syntax">,
193                 </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
194             </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">&quot;object&quot;</span><span class="jsdoc-syntax">){ </span><span class="jsdoc-comment">// must be config object
195                 </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">;
196                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">cfg.url</span><span class="jsdoc-syntax">;
197                 </span><span class="jsdoc-var">params </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">params </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">cfg.params</span><span class="jsdoc-syntax">;
198                 </span><span class="jsdoc-var">callback </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">callback </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">cfg.callback</span><span class="jsdoc-syntax">;
199                 </span><span class="jsdoc-var">discardUrl </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">discardUrl </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">cfg.discardUrl</span><span class="jsdoc-syntax">;
200                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">callback </span><span class="jsdoc-syntax">&amp;&amp; </span><span class="jsdoc-var">cfg.scope</span><span class="jsdoc-syntax">){
201                     </span><span class="jsdoc-var">callback </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">callback.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">cfg.scope</span><span class="jsdoc-syntax">);
202                 }
203                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">cfg.method </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;undefined&quot;</span><span class="jsdoc-syntax">){</span><span class="jsdoc-var">method </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">cfg.method</span><span class="jsdoc-syntax">;};
204                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">cfg.nocache </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;undefined&quot;</span><span class="jsdoc-syntax">){</span><span class="jsdoc-var">this.disableCaching </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">cfg.nocache</span><span class="jsdoc-syntax">;};
205                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">cfg.text </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;undefined&quot;</span><span class="jsdoc-syntax">){</span><span class="jsdoc-var">this.indicatorText </span><span class="jsdoc-syntax">= </span><span class="jsdoc-string">'&lt;div class=&quot;loading-indicator&quot;&gt;'</span><span class="jsdoc-syntax">+</span><span class="jsdoc-var">cfg.text</span><span class="jsdoc-syntax">+</span><span class="jsdoc-string">&quot;&lt;/div&gt;&quot;</span><span class="jsdoc-syntax">;};
206                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">cfg.scripts </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;undefined&quot;</span><span class="jsdoc-syntax">){</span><span class="jsdoc-var">this.loadScripts </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">cfg.scripts</span><span class="jsdoc-syntax">;};
207                 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">cfg.timeout </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;undefined&quot;</span><span class="jsdoc-syntax">){</span><span class="jsdoc-var">this.timeout </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">cfg.timeout</span><span class="jsdoc-syntax">;};
208             }
209             </span><span class="jsdoc-var">this.showLoading</span><span class="jsdoc-syntax">();
210             </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">discardUrl</span><span class="jsdoc-syntax">){
211                 </span><span class="jsdoc-var">this.defaultUrl </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">;
212             }
213             </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">&quot;function&quot;</span><span class="jsdoc-syntax">){
214                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">url.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
215             }
216
217             </span><span class="jsdoc-var">method </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">method </span><span class="jsdoc-syntax">|| (</span><span class="jsdoc-var">params </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">&quot;POST&quot; </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">&quot;GET&quot;</span><span class="jsdoc-syntax">);
218             </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">method </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">&quot;GET&quot;</span><span class="jsdoc-syntax">){
219                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.prepareUrl</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">);
220             }
221
222             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">o </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.apply</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">||{}, {
223                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">,
224                 </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">,
225                 </span><span class="jsdoc-var">success</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.successDelegate</span><span class="jsdoc-syntax">,
226                 </span><span class="jsdoc-var">failure</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.failureDelegate</span><span class="jsdoc-syntax">,
227                 </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">undefined</span><span class="jsdoc-syntax">,
228                 </span><span class="jsdoc-var">timeout</span><span class="jsdoc-syntax">: (</span><span class="jsdoc-var">this.timeout</span><span class="jsdoc-syntax">*1000),
229                 </span><span class="jsdoc-var">argument</span><span class="jsdoc-syntax">: {</span><span class="jsdoc-string">&quot;url&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-string">&quot;form&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">, </span><span class="jsdoc-string">&quot;callback&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-string">&quot;params&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">}
230             });
231             </span><span class="jsdoc-var">Roo.log</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;updated manager called with timeout of &quot; </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">o.timeout</span><span class="jsdoc-syntax">);
232             </span><span class="jsdoc-var">this.transaction </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.Ajax.request</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">);
233         }
234     },
235
236     </span><span class="jsdoc-comment">/**
237      * Performs an async form post, updating this element with the response. If the form has the attribute enctype=&quot;multipart/form-data&quot;, it assumes it's a file upload.
238      * Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning.
239      * @param {String/HTMLElement} form The form Id or form element
240      * @param {String} url (optional) The url to pass the form to. If omitted the action attribute on the form will be used.
241      * @param {Boolean} reset (optional) Whether to try to reset the form after the update
242      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)
243      */
244     </span><span class="jsdoc-var">formUpdate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">form</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">reset</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">){
245         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;beforeupdate&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">form</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">) !== </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">){
246             </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">&quot;function&quot;</span><span class="jsdoc-syntax">){
247                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">url.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
248             }
249             </span><span class="jsdoc-var">form </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.getDom</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">form</span><span class="jsdoc-syntax">);
250             </span><span class="jsdoc-var">this.transaction </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.Ajax.request</span><span class="jsdoc-syntax">({
251                 </span><span class="jsdoc-var">form</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">form</span><span class="jsdoc-syntax">,
252                 </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">:</span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">,
253                 </span><span class="jsdoc-var">success</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.successDelegate</span><span class="jsdoc-syntax">,
254                 </span><span class="jsdoc-var">failure</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.failureDelegate</span><span class="jsdoc-syntax">,
255                 </span><span class="jsdoc-var">timeout</span><span class="jsdoc-syntax">: (</span><span class="jsdoc-var">this.timeout</span><span class="jsdoc-syntax">*1000),
256                 </span><span class="jsdoc-var">argument</span><span class="jsdoc-syntax">: {</span><span class="jsdoc-string">&quot;url&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-string">&quot;form&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">form</span><span class="jsdoc-syntax">, </span><span class="jsdoc-string">&quot;callback&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-string">&quot;reset&quot;</span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">reset</span><span class="jsdoc-syntax">}
257             });
258             </span><span class="jsdoc-var">this.showLoading.defer</span><span class="jsdoc-syntax">(1, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
259         }
260     },
261
262     </span><span class="jsdoc-comment">/**
263      * Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
264      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
265      */
266     </span><span class="jsdoc-var">refresh </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">){
267         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.defaultUrl </span><span class="jsdoc-syntax">== </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">){
268             </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
269         }
270         </span><span class="jsdoc-var">this.update</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.defaultUrl</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">);
271     },
272
273     </span><span class="jsdoc-comment">/**
274      * Set this element to auto refresh.
275      * @param {Number} interval How often to update (in seconds).
276      * @param {String/Function} url (optional) The url for this request or a function to call to get the url (Defaults to the last used url)
277      * @param {String/Object} params (optional) The parameters to pass as either a url encoded string &quot;&amp;param1=1&amp;param2=2&quot; or as an object {param1: 1, param2: 2}
278      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
279      * @param {Boolean} refreshNow (optional) Whether to execute the refresh now, or wait the interval
280      */
281     </span><span class="jsdoc-var">startAutoRefresh </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">interval</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">refreshNow</span><span class="jsdoc-syntax">){
282         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">refreshNow</span><span class="jsdoc-syntax">){
283             </span><span class="jsdoc-var">this.update</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">this.defaultUrl</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">);
284         }
285         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.autoRefreshProcId</span><span class="jsdoc-syntax">){
286             </span><span class="jsdoc-var">clearInterval</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.autoRefreshProcId</span><span class="jsdoc-syntax">);
287         }
288         </span><span class="jsdoc-var">this.autoRefreshProcId </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">setInterval</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.update.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, [</span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">this.defaultUrl</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">]), </span><span class="jsdoc-var">interval</span><span class="jsdoc-syntax">*1000);
289     },
290
291     </span><span class="jsdoc-comment">/**
292      * Stop auto refresh on this element.
293      */
294      </span><span class="jsdoc-var">stopAutoRefresh </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
295         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.autoRefreshProcId</span><span class="jsdoc-syntax">){
296             </span><span class="jsdoc-var">clearInterval</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.autoRefreshProcId</span><span class="jsdoc-syntax">);
297             </span><span class="jsdoc-keyword">delete </span><span class="jsdoc-var">this.autoRefreshProcId</span><span class="jsdoc-syntax">;
298         }
299     },
300
301     </span><span class="jsdoc-var">isAutoRefreshing </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
302        </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.autoRefreshProcId </span><span class="jsdoc-syntax">? </span><span class="jsdoc-keyword">true </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
303     },
304     </span><span class="jsdoc-comment">/**
305      * Called to update the element to &quot;Loading&quot; state. Override to perform custom action.
306      */
307     </span><span class="jsdoc-var">showLoading </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
308         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.showLoadIndicator</span><span class="jsdoc-syntax">){
309             </span><span class="jsdoc-var">this.el.update</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.indicatorText</span><span class="jsdoc-syntax">);
310         }
311     },
312
313     </span><span class="jsdoc-comment">/**
314      * Adds unique parameter to query string if disableCaching = true
315      * @private
316      */
317     </span><span class="jsdoc-var">prepareUrl </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">){
318         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.disableCaching</span><span class="jsdoc-syntax">){
319             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">append </span><span class="jsdoc-syntax">= </span><span class="jsdoc-string">&quot;_dc=&quot; </span><span class="jsdoc-syntax">+ (</span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Date</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.getTime</span><span class="jsdoc-syntax">());
320             </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">url.indexOf</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;?&quot;</span><span class="jsdoc-syntax">) !== -1){
321                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">+= </span><span class="jsdoc-string">&quot;&amp;&quot; </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">append</span><span class="jsdoc-syntax">;
322             }</span><span class="jsdoc-keyword">else</span><span class="jsdoc-syntax">{
323                 </span><span class="jsdoc-var">url </span><span class="jsdoc-syntax">+= </span><span class="jsdoc-string">&quot;?&quot; </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">append</span><span class="jsdoc-syntax">;
324             }
325         }
326         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">;
327     },
328
329     </span><span class="jsdoc-comment">/**
330      * @private
331      */
332     </span><span class="jsdoc-var">processSuccess </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">){
333         </span><span class="jsdoc-var">this.transaction </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
334         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">response.argument.form </span><span class="jsdoc-syntax">&amp;&amp; </span><span class="jsdoc-var">response.argument.reset</span><span class="jsdoc-syntax">){
335             </span><span class="jsdoc-keyword">try</span><span class="jsdoc-syntax">{ </span><span class="jsdoc-comment">// put in try/catch since some older FF releases had problems with this
336                 </span><span class="jsdoc-var">response.argument.form.reset</span><span class="jsdoc-syntax">();
337             }</span><span class="jsdoc-keyword">catch</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">){}
338         }
339         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.loadScripts</span><span class="jsdoc-syntax">){
340             </span><span class="jsdoc-var">this.renderer.render</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">,
341                 </span><span class="jsdoc-var">this.updateComplete.createDelegate</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, [</span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">]));
342         }</span><span class="jsdoc-keyword">else</span><span class="jsdoc-syntax">{
343             </span><span class="jsdoc-var">this.renderer.render</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
344             </span><span class="jsdoc-var">this.updateComplete</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">);
345         }
346     },
347
348     </span><span class="jsdoc-var">updateComplete </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">){
349         </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;update&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">);
350         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">response.argument.callback </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">&quot;function&quot;</span><span class="jsdoc-syntax">){
351             </span><span class="jsdoc-var">response.argument.callback</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">);
352         }
353     },
354
355     </span><span class="jsdoc-comment">/**
356      * @private
357      */
358     </span><span class="jsdoc-var">processFailure </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">){
359         </span><span class="jsdoc-var">this.transaction </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
360         </span><span class="jsdoc-var">this.fireEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">&quot;failure&quot;</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">);
361         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">response.argument.callback </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">&quot;function&quot;</span><span class="jsdoc-syntax">){
362             </span><span class="jsdoc-var">response.argument.callback</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">);
363         }
364     },
365
366     </span><span class="jsdoc-comment">/**
367      * Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.
368      * @param {Object} renderer The object implementing the render() method
369      */
370     </span><span class="jsdoc-var">setRenderer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">renderer</span><span class="jsdoc-syntax">){
371         </span><span class="jsdoc-var">this.renderer </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">renderer</span><span class="jsdoc-syntax">;
372     },
373
374     </span><span class="jsdoc-var">getRenderer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
375        </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.renderer</span><span class="jsdoc-syntax">;
376     },
377
378     </span><span class="jsdoc-comment">/**
379      * Set the defaultUrl used for updates
380      * @param {String/Function} defaultUrl The url or a function to call to get the url
381      */
382     </span><span class="jsdoc-var">setDefaultUrl </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">defaultUrl</span><span class="jsdoc-syntax">){
383         </span><span class="jsdoc-var">this.defaultUrl </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">defaultUrl</span><span class="jsdoc-syntax">;
384     },
385
386     </span><span class="jsdoc-comment">/**
387      * Aborts the executing transaction
388      */
389     </span><span class="jsdoc-var">abort </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
390         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.transaction</span><span class="jsdoc-syntax">){
391             </span><span class="jsdoc-var">Roo.Ajax.abort</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.transaction</span><span class="jsdoc-syntax">);
392         }
393     },
394
395     </span><span class="jsdoc-comment">/**
396      * Returns true if an update is in progress
397      * @return {Boolean}
398      */
399     </span><span class="jsdoc-var">isUpdating </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
400         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.transaction</span><span class="jsdoc-syntax">){
401             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">Roo.Ajax.isLoading</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.transaction</span><span class="jsdoc-syntax">);
402         }
403         </span><span class="jsdoc-keyword">return false</span><span class="jsdoc-syntax">;
404     }
405 });
406
407 </span><span class="jsdoc-comment">/**
408  * @class Roo.UpdateManager.defaults
409  * @static (not really - but it helps the doc tool)
410  * The defaults collection enables customizing the default properties of UpdateManager
411  */
412    </span><span class="jsdoc-var">Roo.UpdateManager.defaults </span><span class="jsdoc-syntax">= {
413        </span><span class="jsdoc-comment">/**
414          * Timeout for requests or form posts in seconds (Defaults 30 seconds).
415          * @type Number
416          */
417          </span><span class="jsdoc-var">timeout </span><span class="jsdoc-syntax">: 30,
418
419          </span><span class="jsdoc-comment">/**
420          * True to process scripts by default (Defaults to false).
421          * @type Boolean
422          */
423         </span><span class="jsdoc-var">loadScripts </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
424
425         </span><span class="jsdoc-comment">/**
426         * Blank page URL to use with SSL file uploads (Defaults to &quot;javascript:false&quot;).
427         * @type String
428         */
429         </span><span class="jsdoc-var">sslBlankUrl </span><span class="jsdoc-syntax">: (</span><span class="jsdoc-var">Roo.SSL_SECURE_URL </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-string">&quot;javascript:false&quot;</span><span class="jsdoc-syntax">),
430         </span><span class="jsdoc-comment">/**
431          * Whether to append unique parameter on get request to disable caching (Defaults to false).
432          * @type Boolean
433          */
434         </span><span class="jsdoc-var">disableCaching </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
435         </span><span class="jsdoc-comment">/**
436          * Whether to show indicatorText when loading (Defaults to true).
437          * @type Boolean
438          */
439         </span><span class="jsdoc-var">showLoadIndicator </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
440         </span><span class="jsdoc-comment">/**
441          * Text for loading indicator (Defaults to '&amp;lt;div class=&quot;loading-indicator&quot;&amp;gt;Loading...&amp;lt;/div&amp;gt;').
442          * @type String
443          */
444         </span><span class="jsdoc-var">indicatorText </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'&lt;div class=&quot;loading-indicator&quot;&gt;Loading...&lt;/div&gt;'
445    </span><span class="jsdoc-syntax">};
446
447 </span><span class="jsdoc-comment">/**
448  * Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).
449  *Usage:
450  * &lt;pre&gt;&lt;code&gt;Roo.UpdateManager.updateElement(&quot;my-div&quot;, &quot;stuff.php&quot;);&lt;/code&gt;&lt;/pre&gt;
451  * @param {String/HTMLElement/Roo.Element} el The element to update
452  * @param {String} url The url
453  * @param {String/Object} params (optional) Url encoded param string or an object of name/value pairs
454  * @param {Object} options (optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: &quot;Loading data...&quot;}
455  * @static
456  * @deprecated
457  * @member Roo.UpdateManager
458  */
459 </span><span class="jsdoc-var">Roo.UpdateManager.updateElement </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">options</span><span class="jsdoc-syntax">){
460     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">um </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.get</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.getUpdateManager</span><span class="jsdoc-syntax">();
461     </span><span class="jsdoc-var">Roo.apply</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">um</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">options</span><span class="jsdoc-syntax">);
462     </span><span class="jsdoc-var">um.update</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">url</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">options </span><span class="jsdoc-syntax">? </span><span class="jsdoc-var">options.callback </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">);
463 };
464 </span><span class="jsdoc-comment">// alias for backwards compat
465 </span><span class="jsdoc-var">Roo.UpdateManager.update </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.UpdateManager.updateElement</span><span class="jsdoc-syntax">;
466 </span><span class="jsdoc-comment">/**
467  * @class Roo.UpdateManager.BasicRenderer
468  * Default Content renderer. Updates the elements innerHTML with the responseText.
469  */
470 </span><span class="jsdoc-var">Roo.UpdateManager.BasicRenderer </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){};
471
472 </span><span class="jsdoc-var">Roo.UpdateManager.BasicRenderer.prototype </span><span class="jsdoc-syntax">= {
473     </span><span class="jsdoc-comment">/**
474      * This is called when the transaction is completed and it's time to update the element - The BasicRenderer
475      * updates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),
476      * create an object with a &quot;render(el, response)&quot; method and pass it to setRenderer on the UpdateManager.
477      * @param {Roo.Element} el The element being rendered
478      * @param {Object} response The YUI Connect response object
479      * @param {UpdateManager} updateManager The calling update manager
480      * @param {Function} callback A callback that will need to be called if loadScripts is true on the UpdateManager
481      */
482      </span><span class="jsdoc-var">render </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">response</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">updateManager</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">){
483         </span><span class="jsdoc-var">el.update</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">response.responseText</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">updateManager.loadScripts</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">callback</span><span class="jsdoc-syntax">);
484     }
485 };
486 </span></code></body></html>