Methods

Events

Observable
  Updater

Class CQ.Ext.Updater

Package:	CQ.Ext
Class:	Updater
Extends:	CQ.Ext.util.Observable
Clientlib:	cq.widgets

Provides AJAX-style update capabilities for Element objects. Updater can be used to update an CQ.Ext.Element once, or you can use startAutoRefresh to set up an auto-updating Element on a specific interval.

Usage:

var el = CQ.Ext.get("foo"); // Get CQ.Ext.Element object
var mgr = el.getUpdater();
mgr.update({
        url: "http://myserver.com/index.php",
        params: {
            param1: "foo",
            param2: "bar"
        }
});
...
mgr.formUpdate("myFormId", "http://myserver.com/index.php");


// or directly (returns the same Updater instance)
var mgr = new CQ.Ext.Updater("myElementId");
mgr.startAutoRefresh(60, "http://myserver.com/index.php");
mgr.on("update", myFcnNeedsToKnow);


// short handed call directly from the element object
CQ.Ext.get("foo").load({
        url: "bar.php",
        scripts: true,
        params: "param1=foo&param2=bar",
        text: "Loading Foo..."
});

Public Properties

Property		Defined By
	disableCaching : Boolean Whether to append unique parameter on get request to disable caching (defaults to CQ.Ext.Updater.defaults.disableCac... Whether to append unique parameter on get request to disable caching (defaults to CQ.Ext.Updater.defaults.disableCaching).	Updater
	indicatorText : String Text for loading indicator (defaults to CQ.Ext.Updater.defaults.indicatorText).	Updater
	loadScripts : Boolean True to process scripts in the output (defaults to CQ.Ext.Updater.defaults.loadScripts).	Updater
	showLoadIndicator : String Whether to show indicatorText when loading (defaults to CQ.Ext.Updater.defaults.showLoadIndicator).	Updater
	sslBlankUrl : String Blank page URL to use with SSL file uploads (defaults to CQ.Ext.Updater.defaults.sslBlankUrl).	Updater
	timeout : Number Timeout for requests or form posts in seconds (defaults to CQ.Ext.Updater.defaults.timeout).	Updater

Public Methods

Method		Defined By
	Updater( `Mixed el`, [`Boolean forceNew`] ) Create new Updater directly. Create new Updater directly. Parameters: `el` : Mixed The element to update `forceNew` : Boolean (optional) By default the constructor checks to see if the passed element already has an Updater and if it does it returns the same instance. This will skip that check (useful for extending this class). Returns:	Updater
	Updater.updateElement( `Mixed el`, `String url`, [`String/Object params`], [`Object options`] ) : void Deprecated. <static> Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}). Usage:... <static> Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}). Usage: `CQ.Ext.Updater.updateElement("my-div", "stuff.php");` Parameters: `el` : Mixed 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 Updater properties you want to set - for example: {disableCaching:true, indicatorText: "Loading data..."} Returns: `void`	Updater
	abort() : void Aborts the currently executing transaction, if any. Aborts the currently executing transaction, if any. Parameters: None. Returns: `void`	Updater
	enableBubble( `String/Array events` ) : void Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class. This is commonly used by CQ.Ext.Components to bubble events to owner Containers. See CQ.Ext.Component.getBubbleTarget. The default implementation in CQ.Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example: CQ.Ext.override(CQ.Ext.form.Field, { // Add functionality to Field's initComponent to enable the change event to bubble initComponent : CQ.Ext.form.Field.prototype.initComponent.createSequence(function() { this.enableBubble('change'); }), // We know that we want Field's events to bubble directly to the FormPanel. getBubbleTarget : function() { if (!this.formPanel) { this.formPanel = this.findParentByType('form'); } return this.formPanel; } }); var myForm = new CQ.Ext.formPanel({ title: 'User Details', items: [{ ... }], listeners: { change: function() { // Title goes red if form has been modified. myForm.header.setStyle('color', 'red'); } } }); Parameters: `events` : String/Array The event name to bubble, or an Array of event names. Returns: `void`	Observable
	formUpdate( `String/HTMLElement form`, [`String url`], [`Boolean reset`], [`Function callback`] ) : void Performs an asynchronous form post, updating this element with the response. If the form has the attribute enctype='m... Performs an asynchronous 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. File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM `<form>` element temporarily modified to have its target set to refer to a dynamically generated, hidden `<iframe>` which is inserted into the document but removed after the return data has been gathered. Be aware that file upload packets, sent with the content type multipart/form-data and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content. 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. The following parameters are passed: el : CQ.Ext.Element The Element being updated. success : Boolean True for success, false for failure. response : XMLHttpRequest The XMLHttpRequest which processed the update. Returns: `void`	Updater
	getDefaultRenderer() : void This is an overrideable method which returns a reference to a default renderer class if none is specified when creati... This is an overrideable method which returns a reference to a default renderer class if none is specified when creating the CQ.Ext.Updater. Defaults to CQ.Ext.Updater.BasicRenderer Parameters: None. Returns: `void`	Updater
	getEl() : CQ.Ext.Element Get the Element this Updater is bound to Get the Element this Updater is bound to Parameters: None. Returns: `CQ.Ext.Element` The element	Updater
	getRenderer() : Object Returns the current content renderer for this Updater. See CQ.Ext.Updater.BasicRenderer.render for more details. Returns the current content renderer for this Updater. See CQ.Ext.Updater.BasicRenderer.render for more details. Parameters: None. Returns: `Object`	Updater
	isAutoRefreshing() : void Returns true if the Updater is currently set to auto refresh its content (see startAutoRefresh), otherwise false. Returns true if the Updater is currently set to auto refresh its content (see startAutoRefresh), otherwise false. Parameters: None. Returns: `void`	Updater
	isUpdating() : Boolean Returns true if an update is in progress, otherwise false. Returns true if an update is in progress, otherwise false. Parameters: None. Returns: `Boolean`	Updater
	refresh( [`Function callback`] ) : void Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately 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`	Updater
	relayEvents( `Object o`, `Array events` ) : void Relays selected events from the specified Observable as if the events were fired by `this`. Relays selected events from the specified Observable as if the events were fired by `this`. Parameters: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: `void`	Observable
	setDefaultUrl( `String/Function defaultUrl` ) : void Sets the default URL used for updates. Sets the default URL used for updates. Parameters: `defaultUrl` : String/Function The url or a function to call to get the url Returns: `void`	Updater
	setRenderer( `Object renderer` ) : void Sets the content renderer for this Updater. See CQ.Ext.Updater.BasicRenderer.render for more details. Sets the content renderer for this Updater. See CQ.Ext.Updater.BasicRenderer.render for more details. Parameters: `renderer` : Object The object implementing the render() method Returns: `void`	Updater
	showLoading() : void Display the element's "loading" state. By default, the element is updated with indicatorText. This method may be over... Display the element's "loading" state. By default, the element is updated with indicatorText. This method may be overridden to perform a custom action while this Updater is actively updating its contents. Parameters: None. Returns: `void`	Updater
	startAutoRefresh( `Number interval`, [`String/Object/Function url`], [`String/Object params`], [`Function callback`], [`Boolean refreshNow`] ) : void Set this element to auto refresh. Can be canceled by calling stopAutoRefresh. Set this element to auto refresh. Can be canceled by calling stopAutoRefresh. Parameters: `interval` : Number How often to update (in seconds). `url` : String/Object/Function (optional) The url for this request, a config object in the same format supported by load, or a function to call to get the url (defaults to the last used url). Note that while the url used in a load call can be reused by this method, other load config options will not be reused and must be sepcified as part of a config object passed as this paramter if needed. `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`	Updater
	stopAutoRefresh() : void Stop auto refresh on this element. Stop auto refresh on this element. Parameters: None. Returns: `void`	Updater
	update( `Object options` ) : void Performs an asynchronous request, updating this element with the response. If params are specified it uses POST, othe... Performs an asynchronous request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET. Note: Due to the asynchronous nature of remote server requests, the Element will not have been fully updated when the function returns. To post-process the returned data, use the callback option, or an `update` event handler. Parameters: `options` : Object A config object containing any of the following options: url : String/Function The URL to request or a function which returns the URL (defaults to the value of CQ.Ext.Ajax.url if not specified). method : String The HTTP method to use. Defaults to POST if the `params` argument is present, otherwise GET. params : String/Object/Function The parameters to pass to the server (defaults to none). These may be specified as a url-encoded string, or as an object containing properties which represent parameters, or as a function, which returns such an object. scripts : Boolean If `true` any <script> tags embedded in the response text will be extracted and executed (defaults to CQ.Ext.Updater.defaults.loadScripts). If this option is specified, the callback will be called after the execution of the scripts. callback : Function A function to be called when the response from the server arrives. The following parameters are passed: el : CQ.Ext.Element The Element being updated. success : Boolean True for success, false for failure. response : XMLHttpRequest The XMLHttpRequest which processed the update. options : Object The config object passed to the update call. scope : Object The scope in which to execute the callback (The callback's `this` reference.) If the `params` argument is a function, this scope is used for that function also. discardUrl : Boolean By default, the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls. To bypass this behavior, pass `discardUrl:true` (defaults to false). timeout : Number The number of seconds to wait for a response before timing out (defaults to CQ.Ext.Updater.defaults.timeout). text : String The text to use as the innerHTML of the CQ.Ext.Updater.defaults.indicatorText div (defaults to 'Loading...'). To replace the entire div, not just the text, override CQ.Ext.Updater.defaults.indicatorText directly. nocache : Boolean Only needed for GET requests, this option causes an extra, auto-generated parameter to be appended to the request to defeat caching (defaults to CQ.Ext.Updater.defaults.disableCaching). For example: `um.update({ url: "your-url.php", params: {param1: "foo", param2: "bar"}, // or a URL encoded string callback: yourFunction, scope: yourObject, //(optional scope) discardUrl: true, nocache: true, text: "Loading...", timeout: 60, scripts: false // Save time by avoiding RegExp execution. });` Returns: `void`	Updater

Public Events

Event		Defined By
	beforeupdate : ( `CQ.Ext.Element el`, `String/Object/Function url`, `String/Object params` ) Fired before an update is made, return false from your handler and the update is cancelled. Fired before an update is made, return false from your handler and the update is cancelled. Listeners will be called with the following arguments: `el` : CQ.Ext.Element `url` : String/Object/Function `params` : String/Object	Updater
	failure : ( `CQ.Ext.Element el`, `Object oResponseObject` ) Fired on update failure. Fired on update failure. Listeners will be called with the following arguments: `el` : CQ.Ext.Element `oResponseObject` : Object The response Object	Updater
	update : ( `CQ.Ext.Element el`, `Object oResponseObject` ) Fired after successful update is made. Fired after successful update is made. Listeners will be called with the following arguments: `el` : CQ.Ext.Element `oResponseObject` : Object The response Object	Updater