Print Friendly

# Class YAHOO.ext.UpdateManager

Package: | YAHOO.ext
Class: | UpdateManager
Extends: | Observable
Defined In: | UpdateManager.js

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 el = getEl('foo');
    var mgr = el.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(60, 'http://myserver.com/index.php');
    mgr.on('update', myFcnNeedsToKnow);

## Public Properties

Property | Defined By
--- | ---
| defaultUrl : String | UpdateManager
Cached url to use for refreshes. Overwritten every time update() is called unless 'discardUrl' param is set to true.
| disableCaching : Boolean | UpdateManager
Whether to append unique parameter on get request to disable caching (Defaults to false).
| el : YAHOO.ext.Element | UpdateManager
The Element object
| formUpdateDelegate : Function | UpdateManager
Delegate for formUpdate() prebound to 'this', use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arg...
| indicatorText : String | UpdateManager
Text for loading indicator (Defaults to '<div class="loading-indicator">Loading...</div>').
| loadScripts : Number | UpdateManager
True to process scripts by default (Defaults to false).
| refreshDelegate : Function | UpdateManager
Delegate for refresh() prebound to 'this', use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments
| renderer : Object | UpdateManager
The renderer for this UpdateManager. Defaults to YAHOO.ext.UpdateManager.BasicRenderer.
| showLoadIndicator : String | UpdateManager
Whether to show indicatorText when loading (Defaults to true).
| sslBlankUrl : String | UpdateManager
Blank page URL to use with SSL file uploads (Defaults to 'about:blank').
| timeout : Number | UpdateManager
Timeout for requests or form posts in seconds (Defaults 30 seconds).
| transaction : Object | UpdateManager
YAHOO.util.Connect transaction object of current executing transaction
| updateDelegate : Function | UpdateManager
Delegate for update() prebound to 'this', use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments

## Public Methods

Method | Defined By
--- | ---
| UpdateManager(`String/HTMLElement/YAHOO.ext.Element el`, [`Boolean forceNew`]) | UpdateManager
Create new UpdateManager directly.
| abort() : void | UpdateManager
Aborts the executing transaction
| addListener(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`]) : void | Observable
Appends an event handler to this component
| bufferedListener(`String eventName`, `Function handler`, [`Object scope`], [`Number millis`]) : Function | Observable
Appends an event handler to this component that is buffered. If the event is triggered more than once in the specifie...
| delayedListener(`String eventName`, `Function handler`, [`Object scope`], [`Number delay`]) : Function | Observable
Appends an event handler to this component that is delayed the specified number of milliseconds. This is useful for e...
| fireEvent(`String eventName`, `Object... args`) : Boolean | Observable
Fires the specified event with the passed parameters (minus the event name).
| formUpdate(`String/HTMLElement form`, [`String url`], [`Boolean reset`], [`Function callback`]) : void | UpdateManager
Performs an async form post, updating this element with the response. If the form has the attribute enctype="multipar...
| getEl() : YAHOO.ext.Element | UpdateManager
Get the Element this UpdateManager is bound to
| isUpdating() : Boolean | UpdateManager
Returns true if an update is in progress
| on(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`]) : void | Observable
Appends an event handler to this element (shorthand for addListener)
| purgeListeners() : void | Observable
Removes all listeners for this object
| refresh([`Function callback`]) : void | UpdateManager
Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
| removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void | Observable
Removes a listener
| setDefaultUrl(`String/Function defaultUrl`) : void | UpdateManager
Set the defaultUrl used for updates
| setRenderer(`Object renderer`) : void | UpdateManager
Set the content renderer for this UpdateManager. See YAHOO.ext.UpdateManager.BasicRenderer.render for more details.
| showLoading() : void | UpdateManager
Called to update the element to "Loading" state. Override to perform custom action.
| startAutoRefresh(`Number interval`, [`String/Function url`], [`String/Object params`], [`Function callback`], [`Boolean refreshNow`]) : void | UpdateManager
Set this element to auto refresh.
| stopAutoRefresh() : void | UpdateManager
Stop auto refresh on this element.
| update(`Object/String/Function url`, [`String/Object params`], [`Function callback`], [`Boolean discardUrl`]) : void | UpdateManager
Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise i...
| updateElement<static>(`String/HTMLElement/YAHOO.ext.Element el`, `String url`, [`String/Object params`], [`Object options`]) : void | UpdateManager
<static> Static convenience method, Usage:
    YAHOO.ext.UpdateManager.update('my-div', 'stuff.php');

## Public Events

Event | Defined By
--- | ---
| beforeupdate : (`YAHOO.ext.Element el`, `String/Object/Function url`, `String/Object params`) | UpdateManager
Fired before an update is made, return false from your handler and the update is cancelled.
| failure : (`YAHOO.ext.Element el`, `Object oResponseObject`) | UpdateManager
Fired on update failure. Uses fireDirect with signature: (oElement, oResponseObject)
| update : (`YAHOO.ext.Element el`, `Object oResponseObject`) | UpdateManager
Fired after successful update is made.

## Property Details

### defaultUrl

`public String defaultUrl`
Cached url to use for refreshes. Overwritten every time update() is called unless 'discardUrl' param is set to true.
This property is defined by UpdateManager.

### disableCaching

`public Boolean disableCaching`
Whether to append unique parameter on get request to disable caching (Defaults to false).
This property is defined by UpdateManager.

### el

`public YAHOO.ext.Element el`
The Element object
This property is defined by UpdateManager.

### formUpdateDelegate

`public Function formUpdateDelegate`
Delegate for formUpdate() prebound to 'this', use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments
This property is defined by UpdateManager.

### indicatorText

`public String indicatorText`
Text for loading indicator (Defaults to '<div class="loading-indicator">Loading...</div>').
This property is defined by UpdateManager.

### loadScripts

`public Number loadScripts`
True to process scripts by default (Defaults to false).
This property is defined by UpdateManager.

### refreshDelegate

`public Function refreshDelegate`
Delegate for refresh() prebound to 'this', use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments
This property is defined by UpdateManager.

### renderer

`public Object renderer`
The renderer for this UpdateManager. Defaults to YAHOO.ext.UpdateManager.BasicRenderer.
This property is defined by UpdateManager.

### showLoadIndicator

`public String showLoadIndicator`
Whether to show indicatorText when loading (Defaults to true).
This property is defined by UpdateManager.

### sslBlankUrl

`public String sslBlankUrl`
Blank page URL to use with SSL file uploads (Defaults to 'about:blank').
This property is defined by UpdateManager.

### timeout

`public Number timeout`
Timeout for requests or form posts in seconds (Defaults 30 seconds).
This property is defined by UpdateManager.

### transaction

`public Object transaction`
YAHOO.util.Connect transaction object of current executing transaction
This property is defined by UpdateManager.

### updateDelegate

`public Function updateDelegate`
Delegate for update() prebound to 'this', use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments
This property is defined by UpdateManager.

## Constructor Details

### UpdateManager

`public function UpdateManager(`String/HTMLElement/YAHOO.ext.Element el`, [`Boolean forceNew`])`
Create new UpdateManager directly.
Parameters:

- `el` : String/HTMLElement/YAHOO.ext.Element
  The element to update
- `forceNew` : Boolean
  (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).

## Method Details

### abort

`public function abort()`
Aborts the executing transaction
Parameters:

- None.

Returns:

- `void`

This method is defined by UpdateManager.

### addListener

`public function addListener(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`])`
Appends an event handler to this component
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) The scope (this object) for the handler
- `override` : boolean
  (optional) If true, scope becomes the scope

Returns:

- `void`

This method is defined by Observable.

### bufferedListener

`public function bufferedListener(`String eventName`, `Function handler`, [`Object scope`], [`Number millis`])`
Appends an event handler to this component that is buffered. If the event is triggered more than once in the specified time-frame, only the last one actually fires.
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) The scope (this object) for the handler
- `millis` : Number
  (optional) The number of milliseconds to buffer (defaults to 250)

Returns:

- `Function`
  The wrapped function that was created (can be used to remove the listener)

This method is defined by Observable.

### delayedListener

`public function delayedListener(`String eventName`, `Function handler`, [`Object scope`], [`Number delay`])`
Appends an event handler to this component that is delayed the specified number of milliseconds. This is useful for events that modify the DOM and need to wait for the browser to catch up.
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) The scope (this object) for the handler
- `delay` : Number
  (optional) The number of milliseconds to delay (defaults to 1 millisecond)

Returns:

- `Function`
  The wrapped function that was created (can be used to remove the listener)

This method is defined by Observable.

### fireEvent

`public function fireEvent(`String eventName`, `Object... args`)`
Fires the specified event with the passed parameters (minus the event name).
Parameters:

- `eventName` : String
- `args` : Object...
  Variable number of parameters are passed to handlers

Returns:

- `Boolean`
  returns false if any of the handlers return false otherwise it returns true

This method is defined by Observable.

### formUpdate

`public function 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` : String/HTMLElement
  The form Id or form element
- `url` : String
  (optional) The url to pass the form to. If omitted the action attribute on the form will be used.
- `reset` : Boolean
  (optional) Whether to try to reset the form after the update
- `callback` : Function
  (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)

Returns:

- `void`

This method is defined by UpdateManager.

### getEl

`public function getEl()`
Get the Element this UpdateManager is bound to
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  The element

This method is defined by UpdateManager.

### isUpdating

`public function isUpdating()`
Returns true if an update is in progress
Parameters:

- None.

Returns:

- `Boolean`

This method is defined by UpdateManager.

### on

`public function on(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`])`
Appends an event handler to this element (shorthand for addListener)
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) The scope (this object) for the handler
- `override` : boolean
  (optional) If true, scope becomes the scope

Returns:

- `void`

This method is defined by Observable.

### purgeListeners

`public function purgeListeners()`
Removes all listeners for this object
Parameters:

- None.

Returns:

- `void`

This method is defined by Observable.

### refresh

`public function refresh([`Function callback`])`
Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
Parameters:

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

Returns:

- `void`

This method is defined by UpdateManager.

### removeListener

`public function removeListener(`String eventName`, `Function handler`, [`Object scope`])`
Removes a listener
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The handler to remove
- `scope` : Object
  (optional) The scope (this object) for the handler

Returns:

- `void`

This method is defined by Observable.

### setDefaultUrl

`public function setDefaultUrl(`String/Function defaultUrl`)`
Set the defaultUrl used for updates
Parameters:

- `defaultUrl` : String/Function
  The url or a function to call to get the url

Returns:

- `void`

This method is defined by UpdateManager.

### setRenderer

`public function setRenderer(`Object renderer`)`
Set the content renderer for this UpdateManager. See YAHOO.ext.UpdateManager.BasicRenderer.render for more details.
Parameters:

- `renderer` : Object
  The object implementing the render() method

Returns:

- `void`

This method is defined by UpdateManager.

### showLoading

`public function showLoading()`
Called to update the element to "Loading" state. Override to perform custom action.
Parameters:

- None.

Returns:

- `void`

This method is defined by UpdateManager.

### startAutoRefresh

`public function startAutoRefresh(`Number interval`, [`String/Function url`], [`String/Object params`], [`Function callback`], [`Boolean refreshNow`])`
Set this element to auto refresh.
Parameters:

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

Returns:

- `void`

This method is defined by UpdateManager.

### stopAutoRefresh

`public function stopAutoRefresh()`
Stop auto refresh on this element.
Parameters:

- None.

Returns:

- `void`

This method is defined by UpdateManager.

### update

`public function update(`Object/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` : Object/String/Function
  The url for this request or a function to call to get the url or a config object containing any of the following options:

       um.update({
       url: 'your-url.php',
       params: {param1: 'foo', param2: 'bar'}, // or a URL encoded string
       callback: yourFunction,
       scope: yourObject, //(optional scope)
       discardUrl: false,
       nocache: false,
       text: 'Loading...',
       timeout: 30,
       scripts: false
       });

  The only required property is url. The optional properties nocache, text and scripts are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.
- `params` : String/Object
  (optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}
- `callback` : Function
  (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
- `discardUrl` : Boolean
  (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.

Returns:

- `void`

This method is defined by UpdateManager.

### updateElement<static>

`public function updateElement<static>(`String/HTMLElement/YAHOO.ext.Element el`, `String url`, [`String/Object params`], [`Object options`])`
<static> Static convenience method, Usage:

    YAHOO.ext.UpdateManager.update('my-div', 'stuff.php');

Parameters:

- `el` : String/HTMLElement/YAHOO.ext.Element
  The element to update
- `url` : String
  The url
- `params` : String/Object
  (optional) Url encoded param string or an object of name/value pairs
- `options` : Object
  (optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: 'Loading data...'}

Returns:

- `void`

This method is defined by UpdateManager.

## Event Details

### beforeupdate

`public event beforeupdate`
Fired before an update is made, return false from your handler and the update is cancelled.
Subscribers will be called with the following parameters:

- `el` : YAHOO.ext.Element
- `url` : String/Object/Function
- `params` : String/Object

This event is defined by UpdateManager.

### failure

`public event failure`
Fired on update failure. Uses fireDirect with signature: (oElement, oResponseObject)
Subscribers will be called with the following parameters:

- `el` : YAHOO.ext.Element
- `oResponseObject` : Object
  The YAHOO.util.Connect response Object

This event is defined by UpdateManager.

### update

`public event update`
Fired after successful update is made.
Subscribers will be called with the following parameters:

- `el` : YAHOO.ext.Element
- `oResponseObject` : Object
  The YAHOO.util.Connect response Object

This event is defined by UpdateManager.

yui-ext - Copyright © 2006 Jack Slocum. | Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.