| disableCachingParam : StringChange the parameter which is sent went disabling caching
+ The global Ajax request class that provides a simple way to make Ajax requests
+with maximum flexibility.
+ Since Ext.Ajax is a singleton, you can set common properties/events for it once
+and override them at the request function level only if necessary.
+ Common Properties you may want to set are:
+ // Default headers to pass in every request
+Ext.Ajax.defaultHeaders = {
+ 'Powered-By': 'Ext'
+};
+
+ Common Events you may want to set are:
+ // Example: show a spinner during all Ajax requests
+Ext.Ajax.on('beforerequest', this.showSpinner, this);
+Ext.Ajax.on('requestcomplete', this.hideSpinner, this);
+Ext.Ajax.on('requestexception', this.hideSpinner, this);
+
+ An example request:
+ // Basic request
+Ext.Ajax.request({
+ url: 'foo.php',
+ success: someFn,
+ failure: otherFn,
+ headers: {
+ 'my-header': 'foo'
+ },
+ params: { foo: 'bar' }
+});
+
+// Simple ajax form submission
+Ext.Ajax.request({
+ form: 'some-form',
+ params: 'foo=bar'
+});
+ This class is a singleton and cannot be created directly.Config Options|
| disableCachingParam : String Change the parameter which is sent went disabling caching
through a cache buster. Defaults to '_dc' | Connection | | listeners : ObjectA config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
@@ -95,16 +95,16 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable |
Public Properties|
| autoAbort : Boolean Whether a new request should abort any pending requests. (defaults to false) | Ajax | | defaultHeaders : Object An object containing request headers which are added to each request made by this object
-(defaults to undefined). | Ajax | | disableCaching : Boolean True to add a unique cache-buster param to GET requests. (defaults to true) | Ajax | | extraParams : ObjectAn object containing properties which are used as extra parameters to each request made
-by this object (defaults to ... An object containing properties which are used as extra parameters to each request made
-by this object (defaults to undefined). Session information and other data that you need
-to pass with each request are commonly put here. | Ajax | | method : StringThe default HTTP method to be used for requests. Note that this is case-sensitive and
-should be all caps (defaults t... The default HTTP method to be used for requests. Note that this is case-sensitive and
-should be all caps (defaults to undefined; if not set but params are present will use
-"POST", otherwise will use "GET".) | Ajax | | timeout : Number The timeout in milliseconds to be used for requests. (defaults to 30000) | Ajax | | url : StringThe default URL to be used for requests to the server. (defaults to undefined)
-If the server receives all requests t... The default URL to be used for requests to the server. (defaults to undefined)
-If the server receives all requests through one URL, setting this once is easier than
+}); | Observable |
Public Properties|
| autoAbort : Boolean Whether a new request should abort any pending requests. (defaults to false) | Ajax | | defaultHeaders : Object An object containing request headers which are added to each request made by this object
+(defaults to undefined). | Ajax | | disableCaching : Boolean True to add a unique cache-buster param to GET requests. (defaults to true) | Ajax | | extraParams : ObjectAn object containing properties which are used as extra parameters to each request made
+by this object (defaults to u... An object containing properties which are used as extra parameters to each request made
+by this object (defaults to undefined). Session information and other data that you need
+to pass with each request are commonly put here. | Ajax | | method : StringThe default HTTP method to be used for requests. Note that this is case-sensitive and
+should be all caps (defaults to... The default HTTP method to be used for requests. Note that this is case-sensitive and
+should be all caps (defaults to undefined; if not set but params are present will use
+"POST", otherwise will use "GET".) | Ajax | | timeout : Number The timeout in milliseconds to be used for requests. (defaults to 30000) | Ajax | | url : StringThe default URL to be used for requests to the server. (defaults to undefined)
+If the server receives all requests th... The default URL to be used for requests to the server. (defaults to undefined)
+If the server receives all requests through one URL, setting this once is easier than
entering it on every request. | Ajax |
Public Methods|
| abort( [Number transactionId ] )
:
voidAborts any outstanding request. Aborts any outstanding request. | Connection | | addEvents( Object|String o , string Optional. )
@@ -164,38 +164,38 @@ Or a shorthand syntax:
scope: this
});Returns: | Observable | | enableBubble( String/Array events )
:
- voidEnables 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 Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
-implementation in 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: Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : 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 Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
+ voidEnables 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 Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in 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: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : 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 Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
});
| Observable | | fireEvent( String eventName , Object... args )
:
Boolean | Observable | | request( Object options )
:
- NumberSends an HTTP request to a remote server.
-Important: Ajax server requests are asynchronous, and this call will
-retu... Sends an HTTP request to a remote server.
- Important: Ajax server requests are asynchronous, and this call will
-return before the response has been received. Process any returned data
-in a callback function.
- Ext.Ajax.request({
- url: 'ajax_demo/sample.json',
- success: function(response, opts) {
- var obj = Ext.decode(response.responseText);
- console.dir(obj);
- },
- failure: function(response, opts) {
- console.log('server-side failure with status code ' + response.status);
- }
-});
- To execute a callback function in the correct scope, use the scope option. Parameters:options : ObjectAn object which may contain the following properties:
-- url : String/Function (Optional)
The URL to
-which to send the request, or a function to call which returns a URL string. The scope of the
-function is specified by the scope option. Defaults to the 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. The scope of the function
-is specified by the scope option.
-- 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. Note that
-the method name is case-sensitive and should be all caps.
-- 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:
-- success : Function (Optional)
The function
-to be called upon success of the request. The callback is passed the following
-parameters:
-- failure : Function (Optional)
The function
-to be called upon failure of the request. The callback is passed the
-following parameters:
-- scope : Object (Optional)
The scope in
-which to execute the callbacks: The "this" object for the callback function. If the url, or params options were
-specified as functions from which to draw values, then this also serves as the scope for those function calls.
-Defaults to the browser window.
-- timeout : Number (Optional)
The timeout in milliseconds to be used for this request. Defaults to 30 seconds.
-- form : Element/HTMLElement/String (Optional)
The <form>
-Element or the id of the <form> to pull parameters from.
-- isUpload : Boolean (Optional)
Only meaningful when used
-with the form option.
- True if the form object is a file upload (will be set automatically if the form was
-configured with enctype "multipart/form-data").
- 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.
- The server response is parsed by the browser to create the document for the IFRAME. If the
-server is using JSON to send the return object, then the
-Content-Type header
-must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
- The response text is retrieved from the document, and a fake XMLHttpRequest object
-is created containing a responseText property in order to conform to the
-requirements of event handlers and callbacks.
- Be aware that file upload packets are sent with the content type multipart/form
-and some server technologies (notably JEE) may require some custom processing in order to
-retrieve parameter names and parameter values from the packet content.
-
-- 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.
-- jsonData : Object/String (Optional)
JSON
-data to use as 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.
-
- The options object may also contain any other property which might be needed to perform
-postprocessing in a callback because it is passed to callback functions. Returns:Number transactionId The id of the server transaction. This may be used
+ Number Sends an HTTP request to a remote server.
+Important: Ajax server requests are asynchronous, and this call will
+return... Sends an HTTP request to a remote server.
+ Important: Ajax server requests are asynchronous, and this call will
+return before the response has been received. Process any returned data
+in a callback function.
+ Ext.Ajax.request({
+ url: 'ajax_demo/sample.json',
+ success: function(response, opts) {
+ var obj = Ext.decode(response.responseText);
+ console.dir(obj);
+ },
+ failure: function(response, opts) {
+ console.log('server-side failure with status code ' + response.status);
+ }
+});
+ To execute a callback function in the correct scope, use the scope option. Parameters:options : ObjectAn object which may contain the following properties:
+- url : String/Function (Optional)
The URL to
+which to send the request, or a function to call which returns a URL string. The scope of the
+function is specified by the scope option. Defaults to the 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. The scope of the function
+is specified by the scope option.
+- 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. Note that
+the method name is case-sensitive and should be all caps.
+- 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:
+- success : Function (Optional)
The function
+to be called upon success of the request. The callback is passed the following
+parameters:
+- failure : Function (Optional)
The function
+to be called upon failure of the request. The callback is passed the
+following parameters:
+- scope : Object (Optional)
The scope in
+which to execute the callbacks: The "this" object for the callback function. If the url, or params options were
+specified as functions from which to draw values, then this also serves as the scope for those function calls.
+Defaults to the browser window.
+- timeout : Number (Optional)
The timeout in milliseconds to be used for this request. Defaults to 30 seconds.
+- form : Element/HTMLElement/String (Optional)
The <form>
+Element or the id of the <form> to pull parameters from.
+- isUpload : Boolean (Optional)
Only meaningful when used
+with the form option.
+ True if the form object is a file upload (will be set automatically if the form was
+configured with enctype "multipart/form-data").
+ 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.
+ The server response is parsed by the browser to create the document for the IFRAME. If the
+server is using JSON to send the return object, then the
+Content-Type header
+must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
+ The response text is retrieved from the document, and a fake XMLHttpRequest object
+is created containing a responseText property in order to conform to the
+requirements of event handlers and callbacks.
+ Be aware that file upload packets are sent with the content type multipart/form
+and some server technologies (notably JEE) may require some custom processing in order to
+retrieve parameter names and parameter values from the packet content.
+
+- 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.
+- jsonData : Object/String (Optional)
JSON
+data to use as 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.
+
+ The options object may also contain any other property which might be needed to perform
+postprocessing in a callback because it is passed to callback functions. Returns:
| Connection | | resumeEvents()
:
void | Connection | | requestcomplete :
( Connection conn , Object response , Object options )
- Fires if the request was successfully completed. Fires if the request was successfully completed. Listeners will be called with the following arguments:conn : ConnectionThis Connection object. response : ObjectThe XHR object containing the response data.
-See The XMLHttpRequest Object
+ Fires if the request was successfully completed. Fires if the request was successfully completed. Listeners will be called with the following arguments:conn : ConnectionThis Connection object. response : Objectoptions : ObjectThe options config object passed to the request method.
| Connection | | requestexception :
( Connection conn , Object response , Object options )
- Fires if an error HTTP status was returned from the server.
-See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616... Fires if an error HTTP status was returned from the server.
-See HTTP Status Code Definitions
-for details of HTTP status codes. Listeners will be called with the following arguments:conn : ConnectionThis Connection object. response : ObjectThe XHR object containing the response data.
-See The XMLHttpRequest Object
+ Fires if an error HTTP status was returned from the server.
+See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-... Fires if an error HTTP status was returned from the server.
+See HTTP Status Code Definitions
+for details of HTTP status codes. Listeners will be called with the following arguments:conn : ConnectionThis Connection object. response : Objectoptions : ObjectThe options config object passed to the request method.
| Connection |
\ No newline at end of file
|