Roo.util.Observable
Roo.UpdateManager

Class Roo.UpdateManager

Package:	Roo
Defined In:	Roo/UpdateManager.js.
Class:	UpdateManager
Extends:	Roo.util.Observable

Provides AJAX-style update for Element object.

Usage:


// Get it from a Roo.Element object
var el = Roo.get("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 Roo.UpdateManager("myElementId");
mgr.startAutoRefresh(60, "http://myserver.com/index.php");
mgr.on("update", myFcnNeedsToKnow);


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

Class Comments / Notes => [Add Your comment/notes about this class]

Config Options (Usually are also Properties)
Options		Defined By
	listeners : Object list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... }`	Roo.util.Observable

Public Methods
Method		Defined By
	new Roo.UpdateManager (String/HTMLElement/Roo.Element el, Boolean *forceNew) Create a new Roo.UpdateManager Create a new Roo.UpdateManager Parameters: String/HTMLElement/Roo.Element el The element to update Boolean 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).
	Roo.UpdateManager.updateElement (String/HTMLElement/Roo.Element el, String *url, String/Object params, Object options) Static convenience method. Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}). Usage: `Roo.UpdateManager.updateElement("my-div", "stuff.php");` Parameters: String/HTMLElement/Roo.Element el The element to update String url* The url String/Object params (optional) Url encoded param string or an object of name/value pairs Object options (optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: "Loading data..."}	Roo.UpdateManager
	abort () Aborts the executing transaction Aborts the executing transaction	Roo.UpdateManager
	addEvents (Object *object) Used to define events on this Observable Used to define events on this Observable Parameters: Object object* The object with the events defined	Roo.util.Observable
	addListener (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this component Appends an event handler to this component Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires. single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `el.on({ 'click': { fn: this.onClick, scope: this, delay: 100 }, 'mouseover': { fn: this.onMouseOver, scope: this }, 'mouseout': { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax which passes the same scope object to all handlers: `el.on({ 'click': this.onClick, 'mouseover': this.onMouseOver, 'mouseout': this.onMouseOut, scope: this });`	Roo.util.Observable
	fireEvent (String *eventName, Object... args) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: String eventName* Object... args Variable number of parameters are passed to handlers Returns: Boolean returns false if any of the handlers return false otherwise it returns true	Roo.util.Observable
	formUpdate (String/HTMLElement *form, String url, Boolean reset, Function callback) Performs an async form post, updating this element with the response. 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. Parameters: String/HTMLElement form* The form Id or form element String url (optional) The url to pass the form to. If omitted the action attribute on the form will be used. Boolean reset (optional) Whether to try to reset the form after the update Function callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)	Roo.UpdateManager
	getEl () : Roo.Element Get the Element this UpdateManager is bound to Get the Element this UpdateManager is bound to Returns: Roo.Element The element	Roo.UpdateManager
	hasListener (String *eventName) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: String eventName* The name of the event to check for Returns: Boolean True if the event is being listened for, else false	Roo.util.Observable
	isUpdating () : Boolean Returns true if an update is in progress Returns true if an update is in progress Returns: Boolean	Roo.UpdateManager
	on (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional)	Roo.util.Observable
	purgeListeners () Removes all listeners for this object Removes all listeners for this object	Roo.util.Observable
	refresh (Function *callback) Refresh the element with the last used url or defaultUrl. Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately Parameters: Function callback* (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)	Roo.UpdateManager
	removeListener (String *eventName, Function handler, Object scope) Removes a listener Removes a listener Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	setDefaultUrl (String/Function *defaultUrl) Set the defaultUrl used for updates Set the defaultUrl used for updates Parameters: String/Function defaultUrl* The url or a function to call to get the url	Roo.UpdateManager
	setRenderer (Object *renderer) Set the content renderer for this UpdateManager. Set the content renderer for this UpdateManager. See {link* Roo.UpdateManager.BasicRendererrender} for more details. Parameters: Object renderer The object implementing the render() method	Roo.UpdateManager
	showLoading () Called to update the element to "Loading" state. Called to update the element to "Loading" state. Override to perform custom action.	Roo.UpdateManager
	startAutoRefresh (Number *interval, String/Function url, String/Object params, Function callback, Boolean refreshNow) Set this element to auto refresh. Set this element to auto refresh. Parameters: Number interval* How often to update (in seconds). String/Function url (optional) The url for this request or a function to call to get the url (Defaults to the last used url) String/Object params (optional) The parameters to pass as either a url encoded string "¶m1=1¶m2=2" or as an object {param1: 1, param2: 2} Function callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) Boolean refreshNow (optional) Whether to execute the refresh now, or wait the interval	Roo.UpdateManager
	stopAutoRefresh () Stop auto refresh on this element. Stop auto refresh on this element.	Roo.UpdateManager
	un (String *eventName, Function handler, Object scope) Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	update (Object/String/Function *url, String/Object params, Function callback, Boolean discardUrl) Performs an async request, updating this element with the response. Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET. Parameters: Object/String/Function url* 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. String/Object params (optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2} Function callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse) Boolean 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.	Roo.UpdateManager

Events
Event		Defined By
	beforeupdate (Roo.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. Parameters: Roo.Element el String/Object/Function url* String/Object params	Roo.UpdateManager
	failure (Roo.Element el, Object *oResponseObject) Fired on update failure. Fired on update failure. Parameters: Roo.Element el Object oResponseObject* The response Object	Roo.UpdateManager
	update (Roo.Element el, Object *oResponseObject) Fired after successful update is made. Fired after successful update is made. Parameters: Roo.Element el Object oResponseObject* The response Object	Roo.UpdateManager

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT) Based on JsDoc Toolkit