X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/ee06f37b0f6f6d94cd05a6ffae556660f7c4a2bc..76cb34406ceaf9681a76e13b531d7eafa483ad88:/docs/output/Ext.Ajax.html diff --git a/docs/output/Ext.Ajax.html b/docs/output/Ext.Ajax.html index 6949a191..31acb2df 100644 --- a/docs/output/Ext.Ajax.html +++ b/docs/output/Ext.Ajax.html @@ -1,667 +1,303 @@ -
Observable - Connection - Ajax
Package: | Ext |
Defined In: | Connection.js |
Class: | Ajax |
Extends: | Connection |
// Basic request
-Ext.Ajax.request({
- url: 'foo.php',
- success: someFn,
- failure: otherFn,
- headers: {
- 'my-header': 'foo'
- },
- params: { foo: 'bar' }
-});
+Observable
Connection
Ajax
Class Ext.Ajax
Package: Ext Defined In: Connection.js Class: Ajax Extends: Connection
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:
+- method
+- extraParams
+- url
+
+// 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
Config Options Defined By disableCachingParam : StringChange 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
+addListener example for attaching multiple handlers at once.
+
DOM events from ExtJs Components
+
While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the DataView's
+click
event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the Element after the Component
+has been rendered. A plugin can simplify this step:
// Plugin is configured with a listeners config object.
+// The Component is appended to the argument list of all handler functions.
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: function(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ // Component passes itself into plugin's init method
+ init: function(c) {
+ var p, l = this.listeners;
+ for (p in l) {
+ if (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } else {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
-// Simple ajax form submission
-Ext.Ajax.request({
- form: 'some-form',
- params: 'foo=bar'
+ // Add the listeners to the Element immediately following the render call
+ c.render = c.render.createSequence(function() {
+ var e = c.getEl();
+ if (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: function(fn, c) {
+ return function(e) {
+ fn.call(this, e, c);
+ };
+ }
});
-// Default headers to pass in every request
-Ext.Ajax.defaultHeaders = {
- 'Powered-By': 'Ext'
-};
+var combo = new Ext.form.ComboBox({
-// Global Ajax events can be handled on every request!
-Ext.Ajax.on('beforerequest', this.showSpinner, this);
This class is a singleton and cannot be created directly.
-
-
-
- Config Options
-
-
- Config Options
- Defined By
-
-
-
-
-
- disableCachingParam : String
- (Optional) Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc'
-
- Connection
-
-
-
-
-
- listeners : Object
- (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
-
- (optional) 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 addListener example for attaching multiple handlers at once.
-
-
- Observable
-
-
-
- Public Properties
-
- Public Methods
-
-
- Method
- Defined By
-
-
-
-
-
- abort( [Number transactionId
] ) : void
- Aborts any outstanding request.
-
- Aborts any outstanding request.
- Parameters:
- transactionId
: Number(Optional) defaults to the last transaction
- Returns:
-
- void
-
-
-
-
-
- Connection
-
-
-
-
-
- addEvents( Object object
) : void
- Used to define events on this Observable
-
- Used to define events on this Observable
- Parameters:
- object
: ObjectThe object with the events defined
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- addListener( String eventName
, Function handler
, [Object scope
], [Object options
] ) : void
- Appends an event handler to this component
-
- Appends an event handler to this component
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope in which to execute the handler
-function. The handler function's "this" context.options
: Object(optional) An object containing handler configuration
+ // Collapse combo when its element is clicked on
+ plugins: [ new Ext.DomObserver({
+ click: function(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: 'local',
+ triggerAction: 'all'
+});
Observable
Public Properties
Property Defined By autoAbort : BooleanWhether a new request should abort any pending requests. (defaults to false) Ajax defaultHeaders : ObjectAn object containing request headers which are added to each request made by this object
+(defaults to undefined). Ajax disableCaching : BooleanTrue 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 : NumberThe 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
+entering it on every request. Ajax
Public Methods
Method Defined By abort( [Number transactionId
] )
+ :
+ voidAborts any outstanding request.Aborts any outstanding request.Parameters:transactionId
: Number(Optional) defaults to the last transaction
Returns:- void
Connection addEvents( Object object
)
+ :
+ voidUsed to define events on this ObservableUsed to define events on this ObservableParameters:object
: ObjectThe object with the events defined
Returns:- void
Observable addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
+ :
+ voidAppends an event handler to this object.Appends an event handler to this object.Parameters:eventName
: StringThe name of the event to listen for.handler
: FunctionThe method the event invokes.scope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.options
: Object(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 the 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 Ext.util.DelayedTask delayed
+
- scope : ObjectThe scope (
this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.
+- delay : NumberThe number of milliseconds to delay the invocation of the handler after the event fires.
+- single : BooleanTrue to add a handler to handle just the next firing of the event, and then remove itself.
+- buffer : NumberCauses the handler to be scheduled to run in an Ext.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.
+handler is not invoked, but the new handler is scheduled in its place.
+- target : ObservableOnly call the handler if the event was fired on the target Observable, not
+if the event was bubbled up from a child Observable.
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, {
+A delayed, one-time listener.
+myDataView.on('click', this.onClick, this, {
single: true,
- delay: 100,
- forumId: 4
+ delay: 100
});
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.
-
foo.on({
+myGridPanel.on({
'click' : {
- fn: this.onClick,
- scope: this,
+ fn: this.onClick,
+ scope: this,
delay: 100
},
'mouseover' : {
- fn: this.onMouseOver,
- scope: this
+ fn: this.onMouseOver,
+ scope: this
},
'mouseout' : {
- fn: this.onMouseOut,
- scope: this
+ fn: this.onMouseOut,
+ scope: this
}
});
Or a shorthand syntax:
-
foo.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
-});
- Returns:
-
- void
-
-
-
-
-
- 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:
- eventName
: Stringargs
: Object...Variable number of parameters are passed to handlers
- Returns:
-
- Boolean
returns false if any of the handlers return false otherwise it returns true
-
-
-
-
-
- Observable
-
-
-
-
-
- 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:
- eventName
: StringThe name of the event to check for
- Returns:
-
- Boolean
True if the event is being listened for, else false
-
-
-
-
-
- Observable
-
-
-
-
-
- isLoading( [Number transactionId
] ) : Boolean
- Determine whether this object has a request outstanding.
-
- Determine whether this object has a request outstanding.
- Parameters:
- transactionId
: Number(Optional) defaults to the last transaction
- Returns:
-
- Boolean
True if there is an outstanding request.
-
-
-
-
-
- Connection
-
-
-
-
-
- on( String eventName
, Function handler
, [Object scope
], [Object options
] ) : void
- Appends an event handler to this element (shorthand for addListener)
-
- Appends an event handler to this element (shorthand for addListener)
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope in which to execute the handler
-function. The handler function's "this" context.options
: Object(optional)
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- purgeListeners() : void
- Removes all listeners for this object
-
- Removes all listeners for this object
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- 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
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- removeListener( String eventName
, Function handler
, [Object scope
] ) : void
- Removes a listener
-
- Removes a listener
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe handler to removescope
: Object(optional) The scope (this object) for the handler
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- request( [Object options
] ) : 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.
-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 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:
-- options : ObjectThe parameter to the request call.
-- success : BooleanTrue if the request succeeded.
-- response : ObjectThe XMLHttpRequest object containing the response data.
-See http://www.w3.org/TR/XMLHttpRequest/ for details about
-accessing elements of the response.
-
-- success : Function (Optional)The function
-to be called upon success of the request. The callback is passed the following
-parameters:
-- response : ObjectThe XMLHttpRequest object containing the response data.
-- options : ObjectThe 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 : ObjectThe XMLHttpRequest object containing the response data.
-- options : ObjectThe parameter to the request call.
-
-- 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.
-- 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 to cancel the request.
-
-
-
-
-
- Connection
-
-
-
-
-
- resumeEvents() : void
- Resume firing events. (see suspendEvents)
-
- Resume firing events. (see suspendEvents)
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- serializeForm( String/HTMLElement form
) : String
- Serialize the passed form into a url encoded string
-
- Serialize the passed form into a url encoded string
- Parameters:
- form
: String/HTMLElement
- Returns:
-
- String
-
-
-
-
-
- Ajax
-
-
-
-
-
- suspendEvents() : void
- Suspend the firing of all events. (see resumeEvents)
-
- Suspend the firing of all events. (see resumeEvents)
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- un( String eventName
, Function handler
, [Object scope
] ) : void
- Removes a listener (shorthand for removeListener)
-
- Removes a listener (shorthand for removeListener)
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe handler to removescope
: Object(optional) The scope (this object) for the handler
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
- Public Events
-
-
- Event
- Defined By
-
-
-
-
-
- beforerequest : ( Connection conn
, Object options
)
- Fires before a network request is made to retrieve a data object.
-
- Fires before a network request is made to retrieve a data object.
- Listeners will be called with the following arguments:
- conn
: ConnectionThis Connection object.options
: ObjectThe options config object passed to the request method.
-
-
-
-
- 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
-for details.options
: 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 HTTP Status Code Definitions
-for details of HTTP stat...
-
- 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
-for details.options
: ObjectThe options config object passed to the request method.
-
-
-
-
- Connection
-
-
-
-
\ No newline at end of file
+myGridPanel.on({
+ 'click' : this.onClick,
+ 'mouseover' : this.onMouseOver,
+ 'mouseout' : this.onMouseOut,
+ scope: this
+});
Returns:- void
Observable enableBubble( Object events
)
+ :
+ voidUsed to enable bubbling of eventsUsed to enable bubbling of eventsParameters:events
: Object
Returns:- void
Observable fireEvent( String eventName
, Object... args
)
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Obse...Fires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)
+by calling enableBubble.
Parameters:eventName
: StringThe name of the event to fire.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.
Observable hasListener( String eventName
)
+ :
+ BooleanChecks to see if this object has any listeners for a specified eventChecks to see if this object has any listeners for a specified eventParameters:eventName
: StringThe name of the event to check for
Returns:Boolean
True if the event is being listened for, else false
Observable isLoading( [Number transactionId
] )
+ :
+ BooleanDetermine whether this object has a request outstanding.Determine whether this object has a request outstanding.Parameters:transactionId
: Number(Optional) defaults to the last transaction
Returns:Boolean
True if there is an outstanding request.
Connection on( String eventName
, Function handler
, [Object scope
], [Object options
] )
+ :
+ voidAppends an event handler to this object (shorthand for addListener.)Appends an event handler to this object (shorthand for addListener.)Parameters:eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
Returns:- void
Observable purgeListeners()
+ :
+ voidRemoves all listeners for this objectRemoves all listeners for this objectParameters:- None.
Returns:- void
Observable relayEvents( Object o
, Array events
)
+ :
+ voidRelays 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
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
Returns:- void
Observable removeListener( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler.Removes an event handler.Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
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:
+- options : ObjectThe parameter to the request call.
+- success : BooleanTrue if the request succeeded.
+- response : ObjectThe XMLHttpRequest object containing the response data.
+See http://www.w3.org/TR/XMLHttpRequest/ for details about
+accessing elements of the response.
+
+- success : Function (Optional)The function
+to be called upon success of the request. The callback is passed the following
+parameters:
+- response : ObjectThe XMLHttpRequest object containing the response data.
+- options : ObjectThe 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 : ObjectThe XMLHttpRequest object containing the response data.
+- options : ObjectThe parameter to the request call.
+
+- 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
+to cancel the request.
Connection resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+event...Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable serializeForm( String/HTMLElement form
)
+ :
+ StringSerialize the passed form into a url encoded stringSerialize the passed form into a url encoded stringParameters:form
: String/HTMLElement
Returns:String
Ajax suspendEvents( Boolean queueSuspended
)
+ :
+ voidSuspend the firing of all events. (see resumeEvents)Suspend the firing of all events. (see resumeEvents)Parameters:queueSuspended
: BooleanPass as true to queue up suspended events to be fired
+after the resumeEvents call instead of discarding all suspended events;
Returns:- void
Observable un( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable
Public Events
Event Defined By beforerequest :
+ ( Connection conn
, Object options
)
+ Fires before a network request is made to retrieve a data object.Fires before a network request is made to retrieve a data object.Listeners will be called with the following arguments:conn
: ConnectionThis Connection object.options
: ObjectThe options config object passed to the request method.
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
+for details.options
: 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
+for details.options
: ObjectThe options config object passed to the request method.
Connection
\ No newline at end of file