<a id="Roo.UpdateManager-configs"></a>
+
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Config Options - Has None</caption>
- </table>
-
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
-
-
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
+ <div class="fixedFont">
+ <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ </table>
+
</tr>
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <tr class="method-row config-row-alt1 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.UpdateManager-method-formUpdate" name=".formUpdate"></a>
+ <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">formUpdate</b>
+ <span class="attributes"></span><b class="itemname">addEvents</b>
- (<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>)
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
</div>
<div class="mdesc">
- <div class="short">Performs an async form post, updating this element with the response.</div>
+ <div class="short">Used to define events on this Observable</div>
<div class="long">
- 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.
+ Used to define events on this Observable
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>form</b>
-
- </dt>
- <dd>The form Id or form element</dd>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>url</b>
-
- </dt>
- <dd>(optional) The url to pass the form to. If omitted the action attribute on the form will be used.</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) Whether to try to reset the form after the update</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
+ <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>
</dt>
- <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
+ <dd>The object with the events defined</dd>
</dl>
</td>
<td class="msource">
- Roo.UpdateManager
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.UpdateManager-method-getEl" name=".getEl"></a>
+ <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getEl</b>
+ <span class="attributes"></span><b class="itemname">addListener</b>
- ()
+ (<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>)
- :
-
-
- <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
-
-
-
-
</div>
<div class="mdesc">
- <div class="short">Get the Element this UpdateManager is bound to</div>
+ <div class="short">Appends an event handler to this component</div>
<div class="long">
- Get the Element this UpdateManager is bound to
+ Appends an event handler to this component
-
-
-
-
<dl class="detailList">
- <dt class="heading">Returns:</dt>
+ <dt class="heading">Parameters:</dt>
- <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The method the event invokes</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <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>
</dl>
+
+
+
+
</td>
<td class="msource">
- Roo.UpdateManager
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <tr class="method-row config-row-alt1 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.UpdateManager-method-isUpdating" name=".isUpdating"></a>
+ <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">isUpdating</b>
+ <span class="attributes"></span><b class="itemname">fireEvent</b>
- ()
+ (<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>)
:
</div>
<div class="mdesc">
- <div class="short">Returns true if an update is in progress</div>
+ <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
<div class="long">
- Returns true if an update is in progress
+ Fires the specified event with the passed parameters (minus the event name).
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>Variable number of parameters are passed to handlers</dd>
+
+ </dl>
+
<dl class="detailList">
<dt class="heading">Returns:</dt>
- <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
+ <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>
</dl>
</td>
<td class="msource">
- Roo.UpdateManager
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
<td class="sig">
- <a id="Roo.UpdateManager-method-refresh" name=".refresh"></a>
+ <a id="Roo.UpdateManager-method-formUpdate" name=".formUpdate"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">refresh</b>
+ <span class="attributes"></span><b class="itemname">formUpdate</b>
- (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
+ (<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>)
</div>
<div class="mdesc">
- <div class="short">Refresh the element with the last used url or defaultUrl.</div>
+ <div class="short">Performs an async form post, updating this element with the response.</div>
<div class="long">
- Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
+ 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.
<dl class="detailList">
<dt class="heading">Parameters:</dt>
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>form</b>
+
+ </dt>
+ <dd>The form Id or form element</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>url</b>
+
+ </dt>
+ <dd>(optional) The url to pass the form to. If omitted the action attribute on the form will be used.</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) Whether to try to reset the form after the update</dd>
+
<dt>
<span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
</dt>
- <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
+ <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
</dl>
<td class="sig">
- <a id="Roo.UpdateManager-method-setDefaultUrl" name=".setDefaultUrl"></a>
+ <a id="Roo.UpdateManager-method-getEl" name=".getEl"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">setDefaultUrl</b>
+ <span class="attributes"></span><b class="itemname">getEl</b>
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>defaultUrl</i></B>)
+ ()
+ :
+
+
+ <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+
+
+
+
</div>
<div class="mdesc">
- <div class="short">Set the defaultUrl used for updates</div>
+ <div class="short">Get the Element this UpdateManager is bound to</div>
<div class="long">
- Set the defaultUrl used for updates
+ Get the Element this UpdateManager is bound to
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>defaultUrl</b>
-
- </dt>
- <dd>The url or a function to call to get the url</dd>
-
- </dl>
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
+
+ </dl>
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.UpdateManager-method-setRenderer" name=".setRenderer"></a>
+ <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">setRenderer</b>
+ <span class="attributes"></span><b class="itemname">hasListener</b>
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>renderer</i></B>)
+ (<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:Boolean">Boolean</a>
+
+
+
+
</div>
<div class="mdesc">
- <div class="short">Set the content renderer for this UpdateManager.</div>
+ <div class="short">Checks to see if this object has any listeners for a specified event</div>
<div class="long">
- Set the content renderer for this UpdateManager. See {<b>link</b> Roo.UpdateManager.BasicRenderer<b>render</b>} for more details.
+ Checks to see if this object has any listeners for a specified event
<dt class="heading">Parameters:</dt>
<dt>
- <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>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
</dt>
- <dd>The object implementing the render() method</dd>
+ <dd>The name of the event to check for</dd>
</dl>
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
</td>
<td class="msource">
- Roo.UpdateManager
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
<td class="sig">
- <a id="Roo.UpdateManager-method-showLoading" name=".showLoading"></a>
+ <a id="Roo.UpdateManager-method-isUpdating" name=".isUpdating"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">showLoading</b>
+ <span class="attributes"></span><b class="itemname">isUpdating</b>
()
+ :
+
+
+ <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+
+
</div>
<div class="mdesc">
- <div class="short">Called to update the element to "Loading" state.</div>
+ <div class="short">Returns true if an update is in progress</div>
<div class="long">
- Called to update the element to "Loading" state. Override to perform custom action.
+ Returns true if an update is in progress
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
+
+ </dl>
+
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.UpdateManager-method-startAutoRefresh" name=".startAutoRefresh"></a>
+ <a id="Roo.util.Observable-method-on" name=".on"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">startAutoRefresh</b>
+ <span class="attributes"></span><b class="itemname">on</b>
- (<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>)
+ (<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>)
</div>
<div class="mdesc">
- <div class="short">Set this element to auto refresh.</div>
+ <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
<div class="long">
- Set this element to auto refresh.
+ Appends an event handler to this element (shorthand for addListener)
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>interval</b>
-
- </dt>
- <dd>How often to update (in seconds).</dd>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>url</b>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
</dt>
- <dd>(optional) The url for this request or a function to call to get the url (Defaults to the last used url)</dd>
+ <dd>The type of event to listen for</dd>
<dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
</dt>
- <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>
+ <dd>The method the event invokes</dd>
<dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
+ <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>
</dt>
- <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
+ <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
<dt>
- <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>
+ <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>
</dt>
- <dd>(optional) Whether to execute the refresh now, or wait the interval</dd>
+ <dd>(optional)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">purgeListeners</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes all listeners for this object</div>
+
+
+
+ <div class="long">
+
+ Removes all listeners for this object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.UpdateManager-method-refresh" name=".refresh"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">refresh</b>
+
+ (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Refresh the element with the last used url or defaultUrl.</div>
+
+
+
+ <div class="long">
+
+ Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
+
+ </dt>
+ <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.UpdateManager
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">removeListener</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes a listener</div>
+
+
+
+ <div class="long">
+
+ Removes a listener
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The handler to remove</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope (this object) for the handler</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.UpdateManager-method-setDefaultUrl" name=".setDefaultUrl"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setDefaultUrl</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>defaultUrl</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Set the defaultUrl used for updates</div>
+
+
+
+ <div class="long">
+
+ Set the defaultUrl used for updates
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>defaultUrl</b>
+
+ </dt>
+ <dd>The url or a function to call to get the url</dd>
</dl>
<td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+ <a id="Roo.UpdateManager-method-setRenderer" name=".setRenderer"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setRenderer</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>renderer</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Set the content renderer for this UpdateManager.</div>
+
+
+
+ <div class="long">
+
+ Set the content renderer for this UpdateManager. See {<b>link</b> Roo.UpdateManager.BasicRenderer<b>render</b>} for more details.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The object implementing the render() method</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.UpdateManager
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.UpdateManager-method-showLoading" name=".showLoading"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">showLoading</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Called to update the element to "Loading" state.</div>
+
+
+
+ <div class="long">
+
+ Called to update the element to "Loading" state. Override to perform custom action.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.UpdateManager
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.UpdateManager-method-startAutoRefresh" name=".startAutoRefresh"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">startAutoRefresh</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Set this element to auto refresh.</div>
+
+
+
+ <div class="long">
+
+ Set this element to auto refresh.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>interval</b>
+
+ </dt>
+ <dd>How often to update (in seconds).</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>url</b>
+
+ </dt>
+ <dd>(optional) The url for this request or a function to call to get the url (Defaults to the last used url)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
+
+ </dt>
+ <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>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
+
+ </dt>
+ <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) Whether to execute the refresh now, or wait the interval</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.UpdateManager
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
<td class="sig">
<a id="Roo.UpdateManager-method-stopAutoRefresh" name=".stopAutoRefresh"></a>
<div class="fixedFont">
</tr>
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-un" name=".un"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">un</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes a listener (shorthand for removeListener)</div>
+
+
+
+ <div class="long">
+
+ Removes a listener (shorthand for removeListener)
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The handler to remove</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope (this object) for the handler</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
<tr class="method-row config-row-alt0 expandable notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:05:46 GMT+0800 (HKT)
+ 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)
Based on
<a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
</div>