oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui-ext/docs/YAHOO.ext.UpdateManager.html
JT Smith 4f68a0933c added YUI and YUI-ext 
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

1026 lines
30 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
YAHOO.ext.UpdateManager
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.UpdateManager";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.UpdateManager</H2>
<PRE>Object
|
+--<b>YAHOO.ext.UpdateManager</b>
</PRE>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.UpdateManager</B>
</DL>
<P>
<BR/>Provides AJAX-style update for Element object using Yahoo
UI library YAHOO.util.Connect functionality.<br><br>
Usage:<br>
<pre><code>
// Get it from a YAHOO.ext.Element object
var mgr = myElement.getUpdateManager();
mgr.update('http://myserver.com/index.php', 'param1=1&amp;param2=2');
...
mgr.formUpdate('myFormId', 'http://myserver.com/index.php');
<br>
// or directly (returns the same UpdateManager instance)
var mgr = new YAHOO.ext.UpdateManager('myElementId');
mgr.startAutoRefresh('http://myserver.com/index.php', 60);
mgr.onUpdate.subscribe(myFcnNeedsToKnow);
<br>
</code></pre>
<BR/><I>Defined in <a href='overview-summary-UpdateManager.js.html'>UpdateManager.js</a></I><BR/><BR/><B>Requires:</B><UL>- <a href="YAHOO.ext.Element.html#">YAHOO.ext.Element</a><BR/>- YAHOO.util.Dom<BR/>- YAHOO.util.Event<BR/>- <a href="YAHOO.util.CustomEvent.html#">YAHOO.util.CustomEvent</a><BR/>- YAHOO.util.Connect</UL>
</P>
<HR>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="inner_classes"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">Nested Class Summary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&nbsp;class&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="YAHOO.ext.UpdateManager.BasicRenderer.html">YAHOO.ext.UpdateManager.BasicRenderer</A></B></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">Field Summary</TD></TR>
<!-- This is one instance field summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#beforeUpdate">beforeUpdate</A></B></CODE>
<BR>
&nbsp;&nbsp;fired before update is made, return false from your handler and the update is cancelled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#defaultUrl">defaultUrl</A></B></CODE>
<BR>
&nbsp;&nbsp;Cached url to use for refreshes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="#disableCaching">disableCaching</A></B></CODE>
<BR>
&nbsp;&nbsp;Whether to append unique parameter on get request to disable caching (Defaults to YAHOO.ext.UpdateManager.defaults.disableCaching or false).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.ext.Element.html">YAHOO.ext.Element</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#el">el</A></B></CODE>
<BR>
&nbsp;&nbsp;The Element object</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#formUpdateDelegate">formUpdateDelegate</A></B></CODE>
<BR>
&nbsp;&nbsp;Delegate for formUpdate() prebound to 'this', use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#indicatorText">indicatorText</A></B></CODE>
<BR>
&nbsp;&nbsp;Text for loading indicator (Defaults to YAHOO.ext.UpdateManager.defaults.indicatorText or '&lt;div class="loading-indicator"&gt;Loading...&lt;/div&gt;').</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Number</CODE></FONT></TD>
<TD><CODE><B><A HREF="#loadScripts">loadScripts</A></B></CODE>
<BR>
&nbsp;&nbsp;True to process scripts in the output (Defaults to YAHOO.ext.UpdateManager.defaults.loadScripts (false)).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#onFailure">onFailure</A></B></CODE>
<BR>
&nbsp;&nbsp;Fired on update failure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#onUpdate">onUpdate</A></B></CODE>
<BR>
&nbsp;&nbsp;Fired after successful update is made.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#refreshDelegate">refreshDelegate</A></B></CODE>
<BR>
&nbsp;&nbsp;Delegate for refresh() prebound to 'this', use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#renderer">renderer</A></B></CODE>
<BR>
&nbsp;&nbsp;The renderer for this UpdateManager.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#showLoadIndicator">showLoadIndicator</A></B></CODE>
<BR>
&nbsp;&nbsp;Whether to show indicatorText when loading (Defaults to YAHOO.ext.UpdateManager.defaults.showLoadIndicator or true).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#sslBlankUrl">sslBlankUrl</A></B></CODE>
<BR>
&nbsp;&nbsp;Blank page URL to use with SSL file uploads (Defaults to YAHOO.ext.UpdateManager.defaults.sslBlankUrl or 'about:blank').</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Number</CODE></FONT></TD>
<TD><CODE><B><A HREF="#timeout">timeout</A></B></CODE>
<BR>
&nbsp;&nbsp;Timeout for requests or form posts in seconds (Defaults to YAHOO.ext.UpdateManager.defaults.timeout or 30 seconds).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#transaction">transaction</A></B></CODE>
<BR>
&nbsp;&nbsp;YAHOO.util.Connect transaction object of current executing transaction</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#updateDelegate">updateDelegate</A></B></CODE>
<BR>
&nbsp;&nbsp;Delegate for update() prebound to 'this', use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&gt; &nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#!s!defaults">defaults</A></B></CODE>
<BR>
&nbsp;&nbsp;The defaults collection enables customizing the default behavior of UpdateManager</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
Constructor Summary
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD>
<CODE>
<B>
<A HREF="YAHOO.ext.UpdateManager.html#YAHOO.ext.UpdateManager()">YAHOO.ext.UpdateManager</A>
</B>
(&lt;String/HTMLElement/YAHOO.ext.Element&gt; el, &lt;<i>Boolean</i>&gt; forceNew)
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
</TABLE>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
<span style="float:left">Method Summary</span>
<span style="float:right;font-weight:normal;font-size:8pt;">
<i>* Parameter types in italic indicate optional parameters</i>
</span>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#abort">abort</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Aborts the executing transaction
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#formUpdate">formUpdate</A></B>(&lt;String/HTMLElement&gt; form, &lt;<i>String</i>&gt; url, &lt;<i>Boolean</i>&gt; reset, &lt;<i>Function</i>&gt; callback)
</CODE>
<BR>
&nbsp;&nbsp;
Performs an async form post, updating this element with the response.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.ext.Element.html">YAHOO.ext.Element</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getEl">getEl</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Get the Element this UpdateManager is bound to
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getRenderer">getRenderer</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isUpdating">isUpdating</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns true if an update is in progress
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#refresh">refresh</A></B>(&lt;<a href="Function.html">Function</a>&gt; callback)
</CODE>
<BR>
&nbsp;&nbsp;
Refresh the element with the last used url or defaultUrl.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setDefaultUrl">setDefaultUrl</A></B>(&lt;String/Function&gt; defaultUrl)
</CODE>
<BR>
&nbsp;&nbsp;
Set the defaultUrl used for updates
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setRenderer">setRenderer</A></B>(&lt;Object&gt; renderer)
</CODE>
<BR>
&nbsp;&nbsp;
Set the content renderer for this UpdateManager.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#showLoading">showLoading</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Called to update the element to "Loading" state.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#startAutoRefresh">startAutoRefresh</A></B>(&lt;Number&gt; interval, &lt;<i>String/Function</i>&gt; url, &lt;<i>String/Object</i>&gt; params, &lt;<i>Function</i>&gt; callback, &lt;<i>Boolean</i>&gt; refreshNow)
</CODE>
<BR>
&nbsp;&nbsp;
Set this element to auto refresh.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#stopAutoRefresh">stopAutoRefresh</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Stop auto refresh on this element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#update">update</A></B>(&lt;String/Function&gt; url, &lt;<i>String/Object</i>&gt; params, &lt;<i>Function</i>&gt; callback, &lt;<i>Boolean</i>&gt; discardUrl)
</CODE>
<BR>
&nbsp;&nbsp;
Performs an async request, updating this element with the response.
</TD>
</TR>
</TABLE>
<P>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">Field Detail</TD>
</TR>
</TABLE>
<A NAME="beforeUpdate"><!-- --></A>
<H3>beforeUpdate</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>beforeUpdate</B></PRE>
<UL>
fired before update is made, return false from your handler and the update is cancelled.
Uses fireDirect with signature: (oElement, url, params)
</UL>
<HR>
<A NAME="defaultUrl"><!-- --></A>
<H3>defaultUrl</H3>
<PRE>String&nbsp;<B>defaultUrl</B></PRE>
<UL>
Cached url to use for refreshes. Overwritten every time update() is called unless 'discardUrl' param is set to true.
</UL>
<HR>
<A NAME="disableCaching"><!-- --></A>
<H3>disableCaching</H3>
<PRE>Boolean&nbsp;<B>disableCaching</B></PRE>
<UL>
Whether to append unique parameter on get request to disable caching (Defaults to YAHOO.ext.UpdateManager.defaults.disableCaching or false).
</UL>
<HR>
<A NAME="el"><!-- --></A>
<H3>el</H3>
<PRE><a href="YAHOO.ext.Element.html">YAHOO.ext.Element</a>&nbsp;<B>el</B></PRE>
<UL>
The Element object
</UL>
<HR>
<A NAME="formUpdateDelegate"><!-- --></A>
<H3>formUpdateDelegate</H3>
<PRE><a href="Function.html">Function</a>&nbsp;<B>formUpdateDelegate</B></PRE>
<UL>
Delegate for formUpdate() prebound to 'this', use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments
</UL>
<HR>
<A NAME="indicatorText"><!-- --></A>
<H3>indicatorText</H3>
<PRE>String&nbsp;<B>indicatorText</B></PRE>
<UL>
Text for loading indicator (Defaults to YAHOO.ext.UpdateManager.defaults.indicatorText or '&lt;div class="loading-indicator"&gt;Loading...&lt;/div&gt;').
</UL>
<HR>
<A NAME="loadScripts"><!-- --></A>
<H3>loadScripts</H3>
<PRE>Number&nbsp;<B>loadScripts</B></PRE>
<UL>
True to process scripts in the output (Defaults to YAHOO.ext.UpdateManager.defaults.loadScripts (false)).
</UL>
<HR>
<A NAME="onFailure"><!-- --></A>
<H3>onFailure</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onFailure</B></PRE>
<UL>
Fired on update failure. Uses fireDirect with signature: (oElement, oResponseObject)
</UL>
<HR>
<A NAME="onUpdate"><!-- --></A>
<H3>onUpdate</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onUpdate</B></PRE>
<UL>
Fired after successful update is made. Uses fireDirect with signature: (oElement, oResponseObject)
</UL>
<HR>
<A NAME="refreshDelegate"><!-- --></A>
<H3>refreshDelegate</H3>
<PRE><a href="Function.html">Function</a>&nbsp;<B>refreshDelegate</B></PRE>
<UL>
Delegate for refresh() prebound to 'this', use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments
</UL>
<HR>
<A NAME="renderer"><!-- --></A>
<H3>renderer</H3>
<PRE>Object&nbsp;<B>renderer</B></PRE>
<UL>
The renderer for this UpdateManager. Defaults to <a href="YAHOO.ext.UpdateManager.BasicRenderer.html#">YAHOO.ext.UpdateManager.BasicRenderer</a>.
</UL>
<HR>
<A NAME="showLoadIndicator"><!-- --></A>
<H3>showLoadIndicator</H3>
<PRE>String&nbsp;<B>showLoadIndicator</B></PRE>
<UL>
Whether to show indicatorText when loading (Defaults to YAHOO.ext.UpdateManager.defaults.showLoadIndicator or true).
</UL>
<HR>
<A NAME="sslBlankUrl"><!-- --></A>
<H3>sslBlankUrl</H3>
<PRE>String&nbsp;<B>sslBlankUrl</B></PRE>
<UL>
Blank page URL to use with SSL file uploads (Defaults to YAHOO.ext.UpdateManager.defaults.sslBlankUrl or 'about:blank').
</UL>
<HR>
<A NAME="timeout"><!-- --></A>
<H3>timeout</H3>
<PRE>Number&nbsp;<B>timeout</B></PRE>
<UL>
Timeout for requests or form posts in seconds (Defaults to YAHOO.ext.UpdateManager.defaults.timeout or 30 seconds).
</UL>
<HR>
<A NAME="transaction"><!-- --></A>
<H3>transaction</H3>
<PRE>Object&nbsp;<B>transaction</B></PRE>
<UL>
YAHOO.util.Connect transaction object of current executing transaction
</UL>
<HR>
<A NAME="updateDelegate"><!-- --></A>
<H3>updateDelegate</H3>
<PRE><a href="Function.html">Function</a>&nbsp;<B>updateDelegate</B></PRE>
<UL>
Delegate for update() prebound to 'this', use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments
</UL>
<HR>
<A NAME="!s!defaults"><!-- --></A>
<H3>defaults</H3>
<PRE>&lt;static&gt;&nbsp;Object&nbsp;<B>defaults</B></PRE>
<UL>
The defaults collection enables customizing the default behavior of UpdateManager
</UL>
<HR>
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Constructor Detail
</TD>
</TR>
</TABLE>
<A NAME="YAHOO.ext.UpdateManager()"><!-- --></A><H3>
YAHOO.ext.UpdateManager</H3>
<PRE><B>YAHOO.ext.UpdateManager</B>(&lt;String/HTMLElement/YAHOO.ext.Element&gt; el, &lt;<i>Boolean</i>&gt; forceNew)</PRE>
<UL>
<B>Parameters:</B>
<UL><CODE>el</CODE> - The element to update
</UL>
<UL><CODE>forceNew</CODE> - (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).
</UL>
</UL>
<!-- Constructor return value(s) -->
<!-- End constructor return value(s) -->
<!-- ADDITIONAL ATTRIBUTES -->
<UL>
<B>Requires:</B><UL>- <a href="YAHOO.ext.Element.html#">YAHOO.ext.Element</a><BR/>- YAHOO.util.Dom<BR/>- YAHOO.util.Event<BR/>- <a href="YAHOO.util.CustomEvent.html#">YAHOO.util.CustomEvent</a><BR/>- YAHOO.util.Connect</UL>
</UL>
<HR/>
<!-- END ADDITIONAL ATTRIBUTES -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Method Detail
</TD>
</TR>
</TABLE>
<!-- One single method detail entry -->
<A NAME="abort"><!-- --></A>
<H3>abort</H3>
<PRE>void <B>abort</B>()</PRE>
<UL>Aborts the executing transaction</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="formUpdate"><!-- --></A>
<H3>formUpdate</H3>
<PRE>void <B>formUpdate</B>(&lt;String/HTMLElement&gt; form, &lt;<i>String</i>&gt; url, &lt;<i>Boolean</i>&gt; reset, &lt;<i>Function</i>&gt; callback)</PRE>
<UL>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.
Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning. See YUI docs for more info.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>form</CODE> - The form Id or form element
</UL>
<UL><CODE>url</CODE> - (optional) The url to pass the form to. If omitted the action attribute on the form will be used.
</UL>
<UL><CODE>reset</CODE> - (optional) Whether to try to reset the form after the update
</UL>
<UL><CODE>callback</CODE> - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getEl"><!-- --></A>
<H3>getEl</H3>
<PRE><a href="YAHOO.ext.Element.html">YAHOO.ext.Element</a> <B>getEl</B>()</PRE>
<UL>Get the Element this UpdateManager is bound to</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The element
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getRenderer"><!-- --></A>
<H3>getRenderer</H3>
<PRE>Object <B>getRenderer</B>()</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isUpdating"><!-- --></A>
<H3>isUpdating</H3>
<PRE>Object <B>isUpdating</B>()</PRE>
<UL>Returns true if an update is in progress</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="refresh"><!-- --></A>
<H3>refresh</H3>
<PRE>void <B>refresh</B>(&lt;<a href="Function.html">Function</a>&gt; callback)</PRE>
<UL>Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>callback</CODE> - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setDefaultUrl"><!-- --></A>
<H3>setDefaultUrl</H3>
<PRE>void <B>setDefaultUrl</B>(&lt;String/Function&gt; defaultUrl)</PRE>
<UL>Set the defaultUrl used for updates</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>defaultUrl</CODE> - The url or a function to call to get the url
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setRenderer"><!-- --></A>
<H3>setRenderer</H3>
<PRE>void <B>setRenderer</B>(&lt;Object&gt; renderer)</PRE>
<UL>Set the content renderer for this UpdateManager. See <a href="YAHOO.ext.UpdateManager.BasicRenderer.html#render">YAHOO.ext.UpdateManager.BasicRenderer.render()</a> for more details.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>renderer</CODE> - The object implementing the render() method
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="showLoading"><!-- --></A>
<H3>showLoading</H3>
<PRE>void <B>showLoading</B>()</PRE>
<UL>Called to update the element to "Loading" state. Override to perform custom action.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="startAutoRefresh"><!-- --></A>
<H3>startAutoRefresh</H3>
<PRE>void <B>startAutoRefresh</B>(&lt;Number&gt; interval, &lt;<i>String/Function</i>&gt; url, &lt;<i>String/Object</i>&gt; params, &lt;<i>Function</i>&gt; callback, &lt;<i>Boolean</i>&gt; refreshNow)</PRE>
<UL>Set this element to auto refresh.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>interval</CODE> - How often to update (in seconds).
</UL>
<UL><CODE>url</CODE> - (optional) The url for this request or a function to call to get the url (Defaults to the last used url)
</UL>
<UL><CODE>params</CODE> - (optional) The parameters to pass as either a url encoded string "&param1=1&param2=2" or as an object {YAHOO.ext.UpdateManager.prototype.param1 = 1; YAHOO.ext.UpdateManager.prototype.param2 = 2;}
</UL>
<UL><CODE>callback</CODE> - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
</UL>
<UL><CODE>refreshNow</CODE> - (optional) Whether to execute the refresh now, or wait the interval
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="stopAutoRefresh"><!-- --></A>
<H3>stopAutoRefresh</H3>
<PRE>void <B>stopAutoRefresh</B>()</PRE>
<UL>Stop auto refresh on this element.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="update"><!-- --></A>
<H3>update</H3>
<PRE>void <B>update</B>(&lt;String/Function&gt; url, &lt;<i>String/Object</i>&gt; params, &lt;<i>Function</i>&gt; callback, &lt;<i>Boolean</i>&gt; discardUrl)</PRE>
<UL>Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>url</CODE> - The url for this request or a function to call to get the url
</UL>
<UL><CODE>params</CODE> - (optional) The parameters to pass as either a url encoded string "param1=1&amp;param2=2" or as an object {YAHOO.ext.UpdateManager.prototype.param1 = 1; YAHOO.ext.UpdateManager.prototype.param2 = 2;}
</UL>
<UL><CODE>callback</CODE> - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
</UL>
<UL><CODE>discardUrl</CODE> - (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.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<!-- ============ METHOD DETAIL END ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<FONT SIZE="-1">
</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sat Oct 14 06:07:10 2006</div>
</BODY>
</HTML>
Reference in a new issue View git blame Copy permalink