1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.UpdateManager</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.UpdateManager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.UpdateManager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.UpdateManager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.UpdateManager-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.UpdateManager
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.UpdateManager
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_UpdateManager.js.html">Roo/UpdateManager.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">UpdateManager</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Provides AJAX-style update for Element object.<br><br><br/>Usage:<br><br/><pre><code><br/>// Get it from a Roo.Element object<br/>var el = Roo.get("foo");<br/>var mgr = el.getUpdateManager();<br/>mgr.update("http://myserver.com/index.php", "param1=1&param2=2");<br/>...<br/>mgr.formUpdate("myFormId", "http://myserver.com/index.php");<br/><br><br/>// or directly (returns the same UpdateManager instance)<br/>var mgr = new Roo.UpdateManager("myElementId");<br/>mgr.startAutoRefresh(60, "http://myserver.com/index.php");<br/>mgr.on("update", myFcnNeedsToKnow);<br/><br><br/> // short handed call directly from the element object<br/> Roo.get("foo").load({<br/> url: "bar.php",<br/> scripts:true,<br/> params: "for=bar",<br/> text: "Loading Foo..."<br/> });<br/></code></pre>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.UpdateManager';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.UpdateManager.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.UpdateManager-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
132 <div class="fixedFont">
133 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
139 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
143 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
151 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
167 <!-- ============================== public properties ==================== -->
171 <a id="Roo.UpdateManager-props"></a>
177 <table cellspacing="0" class="member-table">
178 <caption class="Empty">Public Properties - Has None</caption>
184 <!-- ============================== methods summary / details ======================== -->
187 <a id="Roo.UpdateManager-methods"></a>
188 <!-- constructor?? -->
195 <!-- then dynamics first -->
202 <table cellspacing="0" class="member-table">
203 <caption>Public Methods</caption>
205 <th class="sig-header" colspan="2">Method</th>
206 <th class="msource-header">Defined By</th>
216 <tr class="method-row config-row-alt0 expandable notInherited">
217 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo-method-UpdateManager" name=".UpdateManager"></a>
222 <div class="fixedFont">
223 <span class="attributes">new <B>Roo.</B></span><b class="itemname">UpdateManager</b>
225 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>forceNew</i></B>)
233 <div class="short">Create a new Roo.UpdateManager</div>
240 Create a new Roo.UpdateManager
243 <dl class="detailList">
244 <dt class="heading">Parameters:</dt>
247 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
250 <dd>The element to update</dd>
253 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>forceNew</b>
256 <dd>(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).</dd>
280 <tr class="method-row config-row-alt1 expandable notInherited">
281 <td class="micon"><a class="exi" href="#expand"> </a></td>
285 <a id="Roo.UpdateManager-method-updateElement" name=".updateElement"></a>
286 <div class="fixedFont">
287 <span class="attributes">Roo.UpdateManager.</span><b class="itemname">updateElement</b>
289 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
296 <div class="short">Static convenience method.</div>
302 Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).<br/>Usage:<br/><pre><code>Roo.UpdateManager.updateElement("my-div", "stuff.php");</code></pre>
309 <dl class="detailList">
310 <dt class="heading">Parameters:</dt>
313 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
316 <dd>The element to update</dd>
319 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>url</b>
325 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
328 <dd>(optional) Url encoded param string or an object of name/value pairs</dd>
331 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
334 <dd>(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: "Loading data..."}</dd>
360 <tr class="method-row config-row-alt0 expandable notInherited">
361 <td class="micon"><a class="exi" href="#expand"> </a></td>
365 <a id="Roo.UpdateManager-method-abort" name=".abort"></a>
366 <div class="fixedFont">
367 <span class="attributes"></span><b class="itemname">abort</b>
376 <div class="short">Aborts the executing transaction</div>
382 Aborts the executing transaction
411 <tr class="method-row config-row-alt1 expandable">
412 <td class="micon"><a class="exi" href="#expand"> </a></td>
416 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
417 <div class="fixedFont">
418 <span class="attributes"></span><b class="itemname">addEvents</b>
420 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
427 <div class="short">Used to define events on this Observable</div>
433 Used to define events on this Observable
440 <dl class="detailList">
441 <dt class="heading">Parameters:</dt>
444 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
447 <dd>The object with the events defined</dd>
467 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
473 <tr class="method-row config-row-alt0 expandable">
474 <td class="micon"><a class="exi" href="#expand"> </a></td>
478 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
479 <div class="fixedFont">
480 <span class="attributes"></span><b class="itemname">addListener</b>
482 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
489 <div class="short">Appends an event handler to this component</div>
495 Appends an event handler to this component
502 <dl class="detailList">
503 <dt class="heading">Parameters:</dt>
506 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
509 <dd>The type of event to listen for</dd>
512 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
515 <dd>The method the event invokes</dd>
518 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
521 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
524 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
527 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
547 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
553 <tr class="method-row config-row-alt1 expandable">
554 <td class="micon"><a class="exi" href="#expand"> </a></td>
558 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
559 <div class="fixedFont">
560 <span class="attributes"></span><b class="itemname">fireEvent</b>
562 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
568 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
577 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
583 Fires the specified event with the passed parameters (minus the event name).
590 <dl class="detailList">
591 <dt class="heading">Parameters:</dt>
594 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
600 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
603 <dd>Variable number of parameters are passed to handlers</dd>
611 <dl class="detailList">
612 <dt class="heading">Returns:</dt>
614 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
630 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
636 <tr class="method-row config-row-alt0 expandable notInherited">
637 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.UpdateManager-method-formUpdate" name=".formUpdate"></a>
642 <div class="fixedFont">
643 <span class="attributes"></span><b class="itemname">formUpdate</b>
645 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>form</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>url</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>reset</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
652 <div class="short">Performs an async form post, updating this element with the response.</div>
658 Performs an async form post, updating this element with the response. If the form has the attribute enctype="multipart/form-data", it assumes it's a file upload.<br/>Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning.
665 <dl class="detailList">
666 <dt class="heading">Parameters:</dt>
669 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>form</b>
672 <dd>The form Id or form element</dd>
675 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>url</b>
678 <dd>(optional) The url to pass the form to. If omitted the action attribute on the form will be used.</dd>
681 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>reset</b>
684 <dd>(optional) Whether to try to reset the form after the update</dd>
687 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
690 <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
716 <tr class="method-row config-row-alt1 expandable notInherited">
717 <td class="micon"><a class="exi" href="#expand"> </a></td>
721 <a id="Roo.UpdateManager-method-getEl" name=".getEl"></a>
722 <div class="fixedFont">
723 <span class="attributes"></span><b class="itemname">getEl</b>
731 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
740 <div class="short">Get the Element this UpdateManager is bound to</div>
746 Get the Element this UpdateManager is bound to
757 <dl class="detailList">
758 <dt class="heading">Returns:</dt>
760 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
782 <tr class="method-row config-row-alt0 expandable">
783 <td class="micon"><a class="exi" href="#expand"> </a></td>
787 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
788 <div class="fixedFont">
789 <span class="attributes"></span><b class="itemname">hasListener</b>
791 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
797 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
806 <div class="short">Checks to see if this object has any listeners for a specified event</div>
812 Checks to see if this object has any listeners for a specified event
819 <dl class="detailList">
820 <dt class="heading">Parameters:</dt>
823 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
826 <dd>The name of the event to check for</dd>
834 <dl class="detailList">
835 <dt class="heading">Returns:</dt>
837 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
853 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
859 <tr class="method-row config-row-alt1 expandable notInherited">
860 <td class="micon"><a class="exi" href="#expand"> </a></td>
864 <a id="Roo.UpdateManager-method-isUpdating" name=".isUpdating"></a>
865 <div class="fixedFont">
866 <span class="attributes"></span><b class="itemname">isUpdating</b>
874 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
883 <div class="short">Returns true if an update is in progress</div>
889 Returns true if an update is in progress
900 <dl class="detailList">
901 <dt class="heading">Returns:</dt>
903 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
925 <tr class="method-row config-row-alt0 expandable">
926 <td class="micon"><a class="exi" href="#expand"> </a></td>
930 <a id="Roo.util.Observable-method-on" name=".on"></a>
931 <div class="fixedFont">
932 <span class="attributes"></span><b class="itemname">on</b>
934 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
941 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
947 Appends an event handler to this element (shorthand for addListener)
954 <dl class="detailList">
955 <dt class="heading">Parameters:</dt>
958 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
961 <dd>The type of event to listen for</dd>
964 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
967 <dd>The method the event invokes</dd>
970 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
973 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
976 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
999 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1005 <tr class="method-row config-row-alt1 expandable">
1006 <td class="micon"><a class="exi" href="#expand"> </a></td>
1010 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1011 <div class="fixedFont">
1012 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1021 <div class="short">Removes all listeners for this object</div>
1027 Removes all listeners for this object
1048 <td class="msource">
1050 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1056 <tr class="method-row config-row-alt0 expandable notInherited">
1057 <td class="micon"><a class="exi" href="#expand"> </a></td>
1061 <a id="Roo.UpdateManager-method-refresh" name=".refresh"></a>
1062 <div class="fixedFont">
1063 <span class="attributes"></span><b class="itemname">refresh</b>
1065 (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
1072 <div class="short">Refresh the element with the last used url or defaultUrl.</div>
1078 Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
1085 <dl class="detailList">
1086 <dt class="heading">Parameters:</dt>
1089 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
1092 <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
1110 <td class="msource">
1118 <tr class="method-row config-row-alt1 expandable">
1119 <td class="micon"><a class="exi" href="#expand"> </a></td>
1123 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1124 <div class="fixedFont">
1125 <span class="attributes"></span><b class="itemname">removeListener</b>
1127 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1134 <div class="short">Removes a listener</div>
1147 <dl class="detailList">
1148 <dt class="heading">Parameters:</dt>
1151 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1154 <dd>The type of event to listen for</dd>
1157 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1160 <dd>The handler to remove</dd>
1163 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1166 <dd>(optional) The scope (this object) for the handler</dd>
1184 <td class="msource">
1186 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1192 <tr class="method-row config-row-alt0 expandable notInherited">
1193 <td class="micon"><a class="exi" href="#expand"> </a></td>
1197 <a id="Roo.UpdateManager-method-setDefaultUrl" name=".setDefaultUrl"></a>
1198 <div class="fixedFont">
1199 <span class="attributes"></span><b class="itemname">setDefaultUrl</b>
1201 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>defaultUrl</i></B>)
1208 <div class="short">Set the defaultUrl used for updates</div>
1214 Set the defaultUrl used for updates
1221 <dl class="detailList">
1222 <dt class="heading">Parameters:</dt>
1225 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>defaultUrl</b>
1228 <dd>The url or a function to call to get the url</dd>
1246 <td class="msource">
1254 <tr class="method-row config-row-alt1 expandable notInherited">
1255 <td class="micon"><a class="exi" href="#expand"> </a></td>
1259 <a id="Roo.UpdateManager-method-setRenderer" name=".setRenderer"></a>
1260 <div class="fixedFont">
1261 <span class="attributes"></span><b class="itemname">setRenderer</b>
1263 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>renderer</i></B>)
1270 <div class="short">Set the content renderer for this UpdateManager.</div>
1276 Set the content renderer for this UpdateManager. See {<b>link</b> Roo.UpdateManager.BasicRenderer<b>render</b>} for more details.
1283 <dl class="detailList">
1284 <dt class="heading">Parameters:</dt>
1287 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>renderer</b>
1290 <dd>The object implementing the render() method</dd>
1308 <td class="msource">
1316 <tr class="method-row config-row-alt0 expandable notInherited">
1317 <td class="micon"><a class="exi" href="#expand"> </a></td>
1321 <a id="Roo.UpdateManager-method-showLoading" name=".showLoading"></a>
1322 <div class="fixedFont">
1323 <span class="attributes"></span><b class="itemname">showLoading</b>
1332 <div class="short">Called to update the element to "Loading" state.</div>
1338 Called to update the element to "Loading" state. Override to perform custom action.
1359 <td class="msource">
1367 <tr class="method-row config-row-alt1 expandable notInherited">
1368 <td class="micon"><a class="exi" href="#expand"> </a></td>
1372 <a id="Roo.UpdateManager-method-startAutoRefresh" name=".startAutoRefresh"></a>
1373 <div class="fixedFont">
1374 <span class="attributes"></span><b class="itemname">startAutoRefresh</b>
1376 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>interval</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>refreshNow</i></B>)
1383 <div class="short">Set this element to auto refresh.</div>
1389 Set this element to auto refresh.
1396 <dl class="detailList">
1397 <dt class="heading">Parameters:</dt>
1400 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>interval</b>
1403 <dd>How often to update (in seconds).</dd>
1406 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>url</b>
1409 <dd>(optional) The url for this request or a function to call to get the url (Defaults to the last used url)</dd>
1412 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1415 <dd>(optional) The parameters to pass as either a url encoded string "¶m1=1¶m2=2" or as an object {param1: 1, param2: 2}</dd>
1418 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
1421 <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
1424 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>refreshNow</b>
1427 <dd>(optional) Whether to execute the refresh now, or wait the interval</dd>
1445 <td class="msource">
1453 <tr class="method-row config-row-alt0 expandable notInherited">
1454 <td class="micon"><a class="exi" href="#expand"> </a></td>
1458 <a id="Roo.UpdateManager-method-stopAutoRefresh" name=".stopAutoRefresh"></a>
1459 <div class="fixedFont">
1460 <span class="attributes"></span><b class="itemname">stopAutoRefresh</b>
1469 <div class="short">Stop auto refresh on this element.</div>
1475 Stop auto refresh on this element.
1496 <td class="msource">
1504 <tr class="method-row config-row-alt1 expandable">
1505 <td class="micon"><a class="exi" href="#expand"> </a></td>
1509 <a id="Roo.util.Observable-method-un" name=".un"></a>
1510 <div class="fixedFont">
1511 <span class="attributes"></span><b class="itemname">un</b>
1513 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1520 <div class="short">Removes a listener (shorthand for removeListener)</div>
1526 Removes a listener (shorthand for removeListener)
1533 <dl class="detailList">
1534 <dt class="heading">Parameters:</dt>
1537 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1540 <dd>The type of event to listen for</dd>
1543 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1546 <dd>The handler to remove</dd>
1549 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1552 <dd>(optional) The scope (this object) for the handler</dd>
1570 <td class="msource">
1572 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1578 <tr class="method-row config-row-alt0 expandable notInherited">
1579 <td class="micon"><a class="exi" href="#expand"> </a></td>
1583 <a id="Roo.UpdateManager-method-update" name=".update"></a>
1584 <div class="fixedFont">
1585 <span class="attributes"></span><b class="itemname">update</b>
1587 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/String/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>discardUrl</i></B>)
1594 <div class="short">Performs an async request, updating this element with the response.</div>
1600 Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.
1607 <dl class="detailList">
1608 <dt class="heading">Parameters:</dt>
1611 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/String/Function</span> <b>url</b>
1614 <dd>The url for this request or a function to call to get the url or a config object containing any of the following options:<br/><pre><code><br/>um.update({<br/><br/> url: "your-url.php",<br/><br/> params: {param1: "foo", param2: "bar"}, // or a URL encoded string<br/><br/> callback: yourFunction,<br/><br/> scope: yourObject, //(optional scope) <br/><br/> discardUrl: false, <br/><br/> nocache: false,<br/><br/> text: "Loading...",<br/><br/> timeout: 30,<br/><br/> scripts: false<br/><br/>});<br/></code></pre><br/>The only required property is url. The optional properties nocache, text and scripts<br/>are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.</dd>
1617 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1620 <dd>(optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}</dd>
1623 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
1626 <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
1629 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>discardUrl</b>
1632 <dd>(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.</dd>
1650 <td class="msource">
1661 <!-- ============================== events summary / details ======================== -->
1664 <a id="Roo.UpdateManager-events"></a>
1673 <table cellspacing="0" class="member-table">
1674 <caption>Events</caption>
1677 <th class="sig-header" colspan="2">Event</th>
1678 <th class="msource-header">Defined By</th>
1687 <tr class="method-row expandable config-row-alt0 notInherited">
1688 <td class="micon"><a class="exi" href="#expand"> </a></td>
1691 <a id="Roo.UpdateManager-event-*beforeupdate"></a>
1693 <div class="fixedFont">
1694 <b class="itemname">beforeupdate</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>)
1700 <div class="short">Fired before an update is made, return false from your handler and the update is cancelled.
1706 Fired before an update is made, return false from your handler and the update is cancelled.
1712 <dl class="detailList">
1713 <dt class="heading">Parameters:</dt>
1716 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1722 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object/Function</span> <b>url</b>
1728 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1749 <td class="msource">
1754 <tr class="method-row expandable config-row-alt1 notInherited">
1755 <td class="micon"><a class="exi" href="#expand"> </a></td>
1758 <a id="Roo.UpdateManager-event-*failure"></a>
1760 <div class="fixedFont">
1761 <b class="itemname">failure</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>oResponseObject</i></B>)
1767 <div class="short">Fired on update failure.
1773 Fired on update failure.
1779 <dl class="detailList">
1780 <dt class="heading">Parameters:</dt>
1783 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1789 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>oResponseObject</b>
1792 <dd>The response Object</dd>
1810 <td class="msource">
1815 <tr class="method-row expandable config-row-alt0 notInherited">
1816 <td class="micon"><a class="exi" href="#expand"> </a></td>
1819 <a id="Roo.UpdateManager-event-*update"></a>
1821 <div class="fixedFont">
1822 <b class="itemname">update</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>oResponseObject</i></B>)
1828 <div class="short">Fired after successful update is made.
1834 Fired after successful update is made.
1840 <dl class="detailList">
1841 <dt class="heading">Parameters:</dt>
1844 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1850 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>oResponseObject</b>
1853 <dd>The response Object</dd>
1871 <td class="msource">
1883 <!-- ============================== footer ================================= -->
1884 <div class="fineprint" style="clear:both">
1886 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Nov 10 2010 15:19:20 GMT+0800 (HKT)
1888 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>