Namespace Roo.Ajax

• 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
		});
		

• url {String} (Optional) The URL to which to send the request. Defaults to configured URL


• params {Object/String/Function} (Optional) An object containing properties which are used as parameters to the
  request, a url encoded string or a function to call to get either.


• method {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or
  if no method was configured, "GET" if no parameters are being sent, and "POST" if parameters are being sent.


• callback {Function} (Optional) The function to be called upon receipt of the HTTP response.
  The callback is called regardless of success or failure and is passed the following parameters:
  
  
  • options {Object} The parameter to the request call.
  
  
  • success {Boolean} True if the request succeeded.
  
  
  • response {Object} The XMLHttpRequest object containing the response data.
  
  


• success {Function} (Optional) The function to be called upon success of the request.
  The callback is passed the following parameters:
  
  
  • response {Object} The XMLHttpRequest object containing the response data.
  
  
  • options {Object} The parameter to the request call.
  
  


• failure {Function} (Optional) The function to be called upon failure of the request.
  The callback is passed the following parameters:
  
  
  • response {Object} The XMLHttpRequest object containing the response data.
  
  
  • options {Object} The parameter to the request call.
  
  


• scope {Object} (Optional) The scope in which to execute the callbacks: The "this" object
  for the callback function. Defaults to the browser window.


• form {Object/String} (Optional) A form object or id to pull parameters from.


• isUpload {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).


• headers {Object} (Optional) Request headers to set for the request.


• xmlData {Object} (Optional) XML document to use for the post. Note: This will be used instead of
  params for the post data. Any params will be appended to the URL.


• disableCaching {Boolean} (Optional) True to add a unique cache-buster param to GET requests.