Class YAHOO.ext.UpdateManager

Object
   |
   +--YAHOO.ext.UpdateManager

class YAHOO.ext.UpdateManager

Provides AJAX-style update for Element object using Yahoo UI library YAHOO.util.Connect functionality.

Usage:

 // Get it from a YAHOO.ext.Element object
 var mgr = myElement.getUpdateManager();
 mgr.update('http://myserver.com/index.php', 'param1=1&param2=2');
 ...
 mgr.formUpdate('myFormId', 'http://myserver.com/index.php');
 

 // 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);
 

 

- YAHOO.ext.Element
- YAHOO.util.Dom
- YAHOO.util.Event
- YAHOO.util.CustomEvent
- YAHOO.util.Connect

Field Detail

beforeUpdate

YAHOO.util.CustomEvent beforeUpdate

fired before update is made, return false from your handler and the update is cancelled. Uses fireDirect with signature: (oElement, url, params)

defaultUrl

String defaultUrl

Cached url to use for refreshes. Overwritten every time update() is called unless 'discardUrl' param is set to true.

disableCaching

Boolean disableCaching

Whether to append unique parameter on get request to disable caching (Defaults to YAHOO.ext.UpdateManager.defaults.disableCaching or false).

el

YAHOO.ext.Element el

The Element object

formUpdateDelegate

Function formUpdateDelegate

Delegate for formUpdate() prebound to 'this', use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments

indicatorText

String indicatorText

Text for loading indicator (Defaults to YAHOO.ext.UpdateManager.defaults.indicatorText or '<div class="loading-indicator">Loading...</div>').

loadScripts

Number loadScripts

True to process scripts in the output (Defaults to YAHOO.ext.UpdateManager.defaults.loadScripts (false)).

onFailure

YAHOO.util.CustomEvent onFailure

Fired on update failure. Uses fireDirect with signature: (oElement, oResponseObject)

onUpdate

YAHOO.util.CustomEvent onUpdate

Fired after successful update is made. Uses fireDirect with signature: (oElement, oResponseObject)

refreshDelegate

Function refreshDelegate

Delegate for refresh() prebound to 'this', use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments

renderer

Object renderer

The renderer for this UpdateManager. Defaults to YAHOO.ext.UpdateManager.BasicRenderer.

showLoadIndicator

String showLoadIndicator

Whether to show indicatorText when loading (Defaults to YAHOO.ext.UpdateManager.defaults.showLoadIndicator or true).

sslBlankUrl

String sslBlankUrl

Blank page URL to use with SSL file uploads (Defaults to YAHOO.ext.UpdateManager.defaults.sslBlankUrl or 'about:blank').

timeout

Number timeout

Timeout for requests or form posts in seconds (Defaults to YAHOO.ext.UpdateManager.defaults.timeout or 30 seconds).

transaction

Object transaction

YAHOO.util.Connect transaction object of current executing transaction

updateDelegate

Function updateDelegate

Delegate for update() prebound to 'this', use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments

defaults

<static> Object defaults

The defaults collection enables customizing the default behavior of UpdateManager

YAHOO.ext.UpdateManager

YAHOO.ext.UpdateManager(<String/HTMLElement/YAHOO.ext.Element> el, <Boolean> forceNew)

Parameters:
el - The element to update
forceNew - (optional) By default the constructor checks to see if the passed element already has an UpdateManager and if it does it returns the same instance. This will skip that check (useful for extending this class).

Requires:
- YAHOO.ext.Element
- YAHOO.util.Dom
- YAHOO.util.Event
- YAHOO.util.CustomEvent
- YAHOO.util.Connect

abort

void abort()

Aborts the executing transaction

formUpdate

void formUpdate(<String/HTMLElement> form, <String> url, <Boolean> reset, <Function> callback)

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.

Parameters:
form - The form Id or form element
url - (optional) The url to pass the form to. If omitted the action attribute on the form will be used.
reset - (optional) Whether to try to reset the form after the update
callback - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)

getEl

YAHOO.ext.Element getEl()

Get the Element this UpdateManager is bound to

Returns:
The element

getRenderer

Object getRenderer()

isUpdating

Object isUpdating()

Returns true if an update is in progress

refresh

void refresh(<Function> callback)

Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately

Parameters:
callback - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)

setDefaultUrl

void setDefaultUrl(<String/Function> defaultUrl)

Set the defaultUrl used for updates

Parameters:
defaultUrl - The url or a function to call to get the url

setRenderer

void setRenderer(<Object> renderer)

Set the content renderer for this UpdateManager. See YAHOO.ext.UpdateManager.BasicRenderer.render() for more details.

Parameters:
renderer - The object implementing the render() method

showLoading

void showLoading()

Called to update the element to "Loading" state. Override to perform custom action.

startAutoRefresh

void startAutoRefresh(<Number> interval, <String/Function> url, <String/Object> params, <Function> callback, <Boolean> refreshNow)

Set this element to auto refresh.

Parameters:
interval - How often to update (in seconds).
url - (optional) The url for this request or a function to call to get the url (Defaults to the last used url)
params - (optional) The parameters to pass as either a url encoded string "¶m1=1¶m2=2" or as an object {YAHOO.ext.UpdateManager.prototype.param1 = 1; YAHOO.ext.UpdateManager.prototype.param2 = 2;}
callback - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
refreshNow - (optional) Whether to execute the refresh now, or wait the interval

stopAutoRefresh

void stopAutoRefresh()

Stop auto refresh on this element.

update

void update(<String/Function> url, <String/Object> params, <Function> callback, <Boolean> discardUrl)

Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.

Parameters:
url - The url for this request or a function to call to get the url
params - (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;}
callback - (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
discardUrl - (optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.