X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.data.Connection.js diff --git a/docs/output/Ext.data.Connection.js b/docs/output/Ext.data.Connection.js new file mode 100644 index 00000000..c5875831 --- /dev/null +++ b/docs/output/Ext.data.Connection.js @@ -0,0 +1,953 @@ +Ext.data.JsonP.Ext_data_Connection({ + "tagname": "class", + "name": "Ext.data.Connection", + "doc": "

The Connection class encapsulates a connection to the page's originating domain, allowing requests to be made either\nto a configured URL, or to a URL specified at request time.

\n\n

Requests made by this class are asynchronous, and will return immediately. No data from the server will be available\nto the statement immediately following the request call. To process returned data, use a success callback\nin the request options object, or an event listener.

\n\n

File Uploads

\n\n\n

File uploads are not performed using normal \"Ajax\" techniques, that is they are not performed using XMLHttpRequests.\nInstead the form is submitted in the standard manner with the DOM <form> element temporarily modified to have its\ntarget set to refer to a dynamically generated, hidden <iframe> which is inserted into the document but removed\nafter the return data has been gathered.

\n\n

The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to\nsend the return object, then the Content-Type header must be set to \"text/html\" in order to tell the browser to\ninsert the text unchanged into the document body.

\n\n

Characters which are significant to an HTML parser must be sent as HTML entities, so encode \"<\" as \"&lt;\", \"&\" as\n\"&amp;\" etc.

\n\n

The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a\nresponseText property in order to conform to the requirements of event handlers and callbacks.

\n\n

Be aware that file upload packets are sent with the content type multipart/form and some server technologies\n(notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the\npacket content.

\n\n

Also note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire.

\n", + "extends": null, + "mixins": [ + "Ext.util.Observable" + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "disableCaching", + "member": "Ext.data.Connection", + "type": "Boolean", + "doc": "

(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 48, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-cfg-disableCaching" + }, + { + "tagname": "cfg", + "name": "disableCachingParam", + "member": "Ext.data.Connection", + "type": "String", + "doc": "

(Optional) Change the parameter which is sent went disabling caching\nthrough a cache buster. Defaults to '_dc'

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 53, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-cfg-disableCachingParam" + }, + { + "tagname": "cfg", + "name": "extraParams", + "member": "Ext.data.Connection", + "type": "Object", + "doc": "

(Optional) Any parameters to be appended to the request.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 64, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-cfg-extraParams" + }, + { + "tagname": "cfg", + "name": "listeners", + "member": "Ext.util.Observable", + "type": "Object", + "doc": "

(optional)

A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element option to\nidentify the Component property to add a DOM listener to:

\n\n
new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n
\n\n\n

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 103, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-cfg-listeners", + "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..." + }, + { + "tagname": "cfg", + "name": "timeout", + "member": "Ext.data.Connection", + "type": "Number", + "doc": "

(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 59, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-cfg-timeout" + } + ], + "method": [ + { + "tagname": "method", + "name": "abort", + "member": "Ext.data.Connection", + "doc": "

Aborts any outstanding request.

\n", + "params": [ + { + "type": "Object", + "name": "request", + "doc": "

(Optional) defaults to the last request

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 636, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-method-abort", + "shortDoc": "

Aborts any outstanding request.

\n" + }, + { + "tagname": "method", + "name": "addEvents", + "member": "Ext.util.Observable", + "doc": "

Adds the specified events to the list of events which this Observable may fire.

\n", + "params": [ + { + "type": "Object/String", + "name": "o", + "doc": "

Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.

\n", + "optional": false + }, + { + "type": "String", + "name": "", + "doc": "

[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 452, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "

Adds the specified events to the list of events which this Observable may fire.

\n" + }, + { + "tagname": "method", + "name": "addListener", + "member": "Ext.util.Observable", + "doc": "

Appends an event handler to this object.

\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The name of the event to listen for. May also be an object who's property names are event names. See

\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "

The method the event invokes.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

\n", + "optional": true + }, + { + "type": "Object", + "name": "options", + "doc": "

(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:


\n\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n

myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
.\n

\n\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 271, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "

Appends an event handler to this object.

\n" + }, + { + "tagname": "method", + "name": "addManagedListener", + "member": "Ext.util.Observable", + "doc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", + "params": [ + { + "type": "Observable/Element", + "name": "item", + "doc": "

The item to which to add a listener/listeners.

\n", + "optional": false + }, + { + "type": "Object/String", + "name": "ename", + "doc": "

The event name, or an object containing event name properties.

\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "

Optional. If the ename parameter was an event name, this\nis the handler function.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", + "optional": false + }, + { + "type": "Object", + "name": "opt", + "doc": "

Optional. If the ename parameter was an event name, this\nis the addListener options.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 155, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addManagedListener", + "shortDoc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" + }, + { + "tagname": "method", + "name": "capture", + "member": "Ext.util.Observable", + "doc": "

Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.

\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "

The Observable to capture events from.

\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "

The function to call when an event is fired.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 55, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..." + }, + { + "tagname": "method", + "name": "clearListeners", + "member": "Ext.util.Observable", + "doc": "

Removes all listeners for this object including the managed listeners

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 383, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "

Removes all listeners for this object including the managed listeners

\n" + }, + { + "tagname": "method", + "name": "clearManagedListeners", + "member": "Ext.util.Observable", + "doc": "

Removes all managed listeners for this object.

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 412, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "

Removes all managed listeners for this object.

\n" + }, + { + "tagname": "method", + "name": "enableBubble", + "member": "Ext.util.Observable", + "doc": "

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n
Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n
\n\n", + "params": [ + { + "type": "String/Array", + "name": "events", + "doc": "

The event name to bubble, or an Array of event names.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 554, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." + }, + { + "tagname": "method", + "name": "fireEvent", + "member": "Ext.util.Observable", + "doc": "

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The name of the event to fire.

\n", + "optional": false + }, + { + "type": "Object...", + "name": "args", + "doc": "

Variable number of parameters are passed to handlers.

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

returns false if any of the handlers return false otherwise it returns true.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 232, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-fireEvent", + "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." + }, + { + "tagname": "method", + "name": "hasListener", + "member": "Ext.util.Observable", + "doc": "

Checks to see if this object has any listeners for a specified event

\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The name of the event to check for

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

True if the event is being listened for, else false

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 480, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "

Checks to see if this object has any listeners for a specified event

\n" + }, + { + "tagname": "method", + "name": "isLoading", + "member": "Ext.data.Connection", + "doc": "

Determine whether this object has a request outstanding.

\n", + "params": [ + { + "type": "Object", + "name": "request", + "doc": "

(Optional) defaults to the last transaction

\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "

True if there is an outstanding request.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 622, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-method-isLoading", + "shortDoc": "

Determine whether this object has a request outstanding.

\n" + }, + { + "tagname": "method", + "name": "observe", + "member": "Ext.util.Observable", + "doc": "

Sets observability on the passed class constructor.

\n\n

This makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.

\n\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", + "params": [ + { + "type": "Function", + "name": "c", + "doc": "

The class constructor to make observable.

\n", + "optional": false + }, + { + "type": "Object", + "name": "listeners", + "doc": "

An object containing a series of listeners to add. See addListener.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 69, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." + }, + { + "tagname": "method", + "name": "on", + "member": "Ext.util.Observable", + "doc": "

Appends an event handler to this object (shorthand for addListener.)

\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The type of event to listen for

\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "

The method the event invokes

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

\n", + "optional": true + }, + { + "type": "Object", + "name": "options", + "doc": "

(optional) An object containing handler configuration.

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 616, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "

Appends an event handler to this object (shorthand for addListener.)

\n" + }, + { + "tagname": "method", + "name": "parseStatus", + "member": "Ext.data.Connection", + "doc": "

Check if the response status was successful

\n", + "params": [ + { + "type": "Number", + "name": "status", + "doc": "

The status code

\n", + "optional": false + } + ], + "return": { + "type": "Object", + "doc": "

An object containing success/status state

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 732, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-method-parseStatus", + "shortDoc": "

Check if the response status was successful

\n" + }, + { + "tagname": "method", + "name": "relayEvents", + "member": "Ext.util.Observable", + "doc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n", + "params": [ + { + "type": "Object", + "name": "origin", + "doc": "

The Observable whose events this object is to relay.

\n", + "optional": false + }, + { + "type": "Array", + "name": "events", + "doc": "

Array of event names to relay.

\n", + "optional": false + }, + { + "type": "Object", + "name": "prefix", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 520, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n" + }, + { + "tagname": "method", + "name": "releaseCapture", + "member": "Ext.util.Observable", + "doc": "

Removes all added captures from the Observable.

\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "

The Observable to release

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 46, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "

Removes all added captures from the Observable.

\n" + }, + { + "tagname": "method", + "name": "removeListener", + "member": "Ext.util.Observable", + "doc": "

Removes an event handler.

\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The type of event the handler was associated with.

\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "

The handler to remove. This must be a reference to the function passed into the addListener call.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

(optional) The scope originally specified for the handler.

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 352, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "

Removes an event handler.

\n" + }, + { + "tagname": "method", + "name": "removeManagedListener", + "member": "Ext.util.Observable", + "doc": "

Removes listeners that were added by the mon method.

\n", + "params": [ + { + "type": "Observable|Element", + "name": "item", + "doc": "

The item from which to remove a listener/listeners.

\n", + "optional": false + }, + { + "type": "Object|String", + "name": "ename", + "doc": "

The event name, or an object containing event name properties.

\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "

Optional. If the ename parameter was an event name, this\nis the handler function.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 196, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "

Removes listeners that were added by the mon method.

\n" + }, + { + "tagname": "method", + "name": "request", + "member": "Ext.data.Connection", + "doc": "

Sends an HTTP request to a remote server.

\n\n\n

Important: Ajax server requests are asynchronous, and this call will\nreturn before the response has been received. Process any returned data\nin a callback function.

\n\n\n
Ext.Ajax.request({\nurl: 'ajax_demo/sample.json',\nsuccess: function(response, opts) {\n  var obj = Ext.decode(response.responseText);\n  console.dir(obj);\n},\nfailure: function(response, opts) {\n  console.log('server-side failure with status code ' + response.status);\n}\n});\n
\n\n\n

To execute a callback function in the correct scope, use the scope option.

\n\n", + "params": [ + { + "type": "Object", + "name": "options", + "doc": "

An object which may contain the following properties:

\n\n

The options object may also contain any other property which might be needed to perform\npostprocessing in a callback because it is passed to callback functions.

\n\n", + "optional": false + } + ], + "return": { + "type": "Object", + "doc": "

request The request object. This may be used\nto cancel the request.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 112, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-method-request", + "shortDoc": "Sends an HTTP request to a remote server.\n\n\nImportant: Ajax server requests are asynchronous, and this call will\nretu..." + }, + { + "tagname": "method", + "name": "resumeEvents", + "member": "Ext.util.Observable", + "doc": "

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 502, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-resumeEvents", + "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..." + }, + { + "tagname": "method", + "name": "setOptions", + "member": "Ext.data.Connection", + "doc": "

Set various options such as the url, params for the request

\n", + "params": [ + { + "type": "Object", + "name": "options", + "doc": "

The initial options

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

The scope to execute in

\n", + "optional": false + } + ], + "return": { + "type": "Object", + "doc": "

The params for the request

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 409, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-method-setOptions", + "shortDoc": "

Set various options such as the url, params for the request

\n" + }, + { + "tagname": "method", + "name": "suspendEvents", + "member": "Ext.util.Observable", + "doc": "

Suspend the firing of all events. (see resumeEvents)

\n", + "params": [ + { + "type": "Boolean", + "name": "queueSuspended", + "doc": "

Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 490, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "

Suspend the firing of all events. (see resumeEvents)

\n" + }, + { + "tagname": "method", + "name": "un", + "member": "Ext.util.Observable", + "doc": "

Removes an event handler (shorthand for removeListener.)

\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The type of event the handler was associated with.

\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "

The handler to remove. This must be a reference to the function passed into the addListener call.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

(optional) The scope originally specified for the handler.

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 608, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "

Removes an event handler (shorthand for removeListener.)

\n" + }, + { + "tagname": "method", + "name": "upload", + "member": "Ext.data.Connection", + "doc": "

Upload a form using a hidden iframe.

\n", + "params": [ + { + "type": "Mixed", + "name": "form", + "doc": "

The form to upload

\n", + "optional": false + }, + { + "type": "String", + "name": "url", + "doc": "

The url to post to

\n", + "optional": false + }, + { + "type": "String", + "name": "params", + "doc": "

Any extra parameters to pass

\n", + "optional": false + }, + { + "type": "Object", + "name": "options", + "doc": "

The initial options

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 280, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-method-upload", + "shortDoc": "

Upload a form using a hidden iframe.

\n" + } + ], + "property": [ + + ], + "event": [ + { + "tagname": "event", + "name": "beforerequest", + "member": "Ext.data.Connection", + "doc": "

Fires before a network request is made to retrieve a data object.

\n", + "params": [ + { + "type": "Connection", + "name": "conn", + "doc": "

This Connection object.

\n", + "optional": false + }, + { + "type": "Object", + "name": "options", + "doc": "

The options config object passed to the request method.

\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 78, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-event-beforerequest", + "shortDoc": "

Fires before a network request is made to retrieve a data object.

\n" + }, + { + "tagname": "event", + "name": "requestcomplete", + "member": "Ext.data.Connection", + "doc": "

Fires if the request was successfully completed.

\n", + "params": [ + { + "type": "Connection", + "name": "conn", + "doc": "

This Connection object.

\n", + "optional": false + }, + { + "type": "Object", + "name": "response", + "doc": "

The XHR object containing the response data.\nSee The XMLHttpRequest Object\nfor details.

\n", + "optional": false + }, + { + "type": "Object", + "name": "options", + "doc": "

The options config object passed to the request method.

\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 85, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-event-requestcomplete", + "shortDoc": "

Fires if the request was successfully completed.

\n" + }, + { + "tagname": "event", + "name": "requestexception", + "member": "Ext.data.Connection", + "doc": "

Fires if an error HTTP status was returned from the server.\nSee HTTP Status Code Definitions\nfor details of HTTP status codes.

\n", + "params": [ + { + "type": "Connection", + "name": "conn", + "doc": "

This Connection object.

\n", + "optional": false + }, + { + "type": "Object", + "name": "response", + "doc": "

The XHR object containing the response data.\nSee The XMLHttpRequest Object\nfor details.

\n", + "optional": false + }, + { + "type": "Object", + "name": "options", + "doc": "

The options config object passed to the request method.

\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 95, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection-event-requestexception", + "shortDoc": "Fires if an error HTTP status was returned from the server.\nSee HTTP Status Code Definitions\nfor details of HTTP stat..." + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Connection.js", + "linenr": 1, + "html_filename": "Connection.html", + "href": "Connection.html#Ext-data-Connection", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + "Ext.Ajax" + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.util.Observable" + ] +}); \ No newline at end of file