Mixins
The Connection class encapsulates a connection to the page's originating domain, allowing requests to be made either -to a configured URL, or to a URL specified at request time.
- -Requests made by this class are asynchronous, and will return immediately. No data from the server will be available -to the statement immediately following the request call. To process returned data, use a success callback -in the request options object, or an event listener.
- -File Uploads
- - -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.
- -Characters which are significant to an HTML parser must be sent as HTML entities, so encode "<" as "<", "&" as -"&" etc.
- -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.
- -Also note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire.
-(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.
- -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 child element of a Component, we need to specify the element option to
-identify the Component property to add a DOM listener to:
new Ext.panel.Panel({
- width: 400,
- height: 200,
- dockedItems: [{
- xtype: 'toolbar'
- }],
- listeners: {
- click: {
- element: 'el', //bind to the underlying el property on the panel
- fn: function(){ console.log('click el'); }
- },
- dblclick: {
- element: 'body', //bind to the underlying body property on the panel
- fn: function(){ console.log('dblclick body'); }
- }
- }
-});
-(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)
-(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)
-(Optional) Change the parameter which is sent went disabling caching -through a cache buster. Defaults to '_dc'
-(Optional) Change the parameter which is sent went disabling caching -through a cache buster. Defaults to '_dc'
-Aborts any outstanding request.
-Aborts any outstanding request.
-(Optional) defaults to the last request
-Adds the specified events to the list of events which this Observable may fire.
-Adds the specified events to the list of events which this Observable may fire.
-Either an object with event names as properties with a value of true
-or the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters. -Usage:
- -this.addEvents('storeloaded', 'storecleared');
-Appends an event handler to this object.
-Appends an event handler to this object.
-The name of the event to listen for. May also be an object who's property names are event names. See
-The method the event invokes.
-(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration. -properties. This may contain any of the following properties:
this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which -will exist only after the Component is rendered. For example, to add a click listener to a Panel's body: -
new Ext.panel.Panel({
- title: 'The title',
- listeners: {
- click: this.handlePanelClick,
- element: 'body'
- }
-});
-When added in this way, the options available are the options applicable to Ext.core.Element.addListener
- - -
-Combining Options
-Using the options argument, it is possible to combine different types of listeners:
-
-A delayed, one-time listener.
-
myPanel.on('hide', this.handleClick, this, {
-single: true,
-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 events. For example:
-
myGridPanel.on({
- cellClick: this.onCellClick,
- mouseover: this.onMouseOver,
- mouseout: this.onMouseOut,
- scope: this // Important. Ensure "this" is correct during handler execution
-});
-- -
Adds listeners to any Observable object (or Element) which are automatically removed when this Component -is destroyed. - -
Adds listeners to any Observable object (or Element) which are automatically removed when this Component -is destroyed. - -
The item to which to add a listener/listeners.
-The event name, or an object containing event name properties.
-Optional. If the ename parameter was an event name, this
-is the handler function.
Optional. If the ename parameter was an event name, this
-is the scope (this reference) in which the handler function is executed.
Optional. If the ename parameter was an event name, this
-is the addListener options.
Starts capture on the specified Observable. All events will be passed -to the supplied function with the event name + standard signature of the event -before the event is fired. If the supplied function returns false, -the event will not fire.
-The Observable to capture events from.
-The function to call when an event is fired.
-(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
-Removes all listeners for this object including the managed listeners
-Removes all managed listeners for this object.
-Removes all managed listeners for this object.
-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.Base, {
-// Add functionality to Field's initComponent to enable the change event to bubble
-initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, 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');
- }
-}
-});
-The event name to bubble, or an Array of event names.
-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.
- -The name of the event to fire.
-Variable number of parameters are passed to handlers.
-returns false if any of the handlers return false otherwise it returns true.
-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
-The name of the event to check for
-True if the event is being listened for, else false
-Determine whether this object has a request outstanding.
-Determine whether this object has a request outstanding.
-(Optional) defaults to the last transaction
-True if there is an outstanding request.
-Sets observability on the passed class constructor.
- -This makes any event fired on any instance of the passed class also fire a single event through -the class allowing for central handling of events on many instances at once.
- -Usage:
- -Ext.util.Observable.observe(Ext.data.Connection);
-Ext.data.Connection.on('beforerequest', function(con, options) {
- console.log('Ajax request made to ' + options.url);
-});
-The class constructor to make observable.
-An object containing a series of listeners to add. See addListener.
-Appends an event handler to this object (shorthand for addListener.)
-Appends an event handler to this object (shorthand for addListener.)
-The type of event to listen for
-The method the event invokes
-(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
-Check if the response status was successful
-Check if the response status was successful
-The status code
-An object containing success/status state
-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.
The Observable whose events this object is to relay.
-Array of event names to relay.
-Removes all added captures from the Observable.
-Removes all added captures from the Observable.
-The Observable to release
-Removes an event handler.
-Removes an event handler.
-The type of event the handler was associated with.
-The handler to remove. This must be a reference to the function passed into the addListener call.
-(optional) The scope originally specified for the handler.
-Removes listeners that were added by the mon method.
-Removes listeners that were added by the mon method.
-The item from which to remove a listener/listeners.
-The event name, or an object containing event name properties.
-Optional. If the ename parameter was an event name, this
-is the handler function.
Optional. If the ename parameter was an event name, this
-is the scope (this reference) in which the handler function is executed.
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.
- -An object which may contain the following properties:
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.
- - -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.
- -request The request object. This may be used -to cancel the request.
-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.
Set various options such as the url, params for the request
-Set various options such as the url, params for the request
-The initial options
-The scope to execute in
-The params for the request
-Suspend the firing of all events. (see resumeEvents)
-Suspend the firing of all events. (see resumeEvents)
-Pass as true to queue up suspended events to be fired -after the resumeEvents call instead of discarding all suspended events;
-Removes an event handler (shorthand for removeListener.)
-Removes an event handler (shorthand for removeListener.)
-The type of event the handler was associated with.
-The handler to remove. This must be a reference to the function passed into the addListener call.
-(optional) The scope originally specified for the handler.
-Fires before a network request is made to retrieve a data object.
-Fires before a network request is made to retrieve a data object.
-This Connection object.
-The options config object passed to the request method.
-Fires if the request was successfully completed.
-Fires if the request was successfully completed.
-This Connection object.
-The XHR object containing the response data. -See The XMLHttpRequest Object -for details.
-The options config object passed to the request method.
-Fires if an error HTTP status was returned from the server. -See HTTP Status Code Definitions -for details of HTTP status codes.
-This Connection object.
-The XHR object containing the response data. -See The XMLHttpRequest Object -for details.
-The options config object passed to the request method.
-