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\nRequests 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\nFile Uploads
\n\n\nFile 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\nThe 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\nCharacters which are significant to an HTML parser must be sent as HTML entities, so encode \"<\" as \"<\", \"&\" as\n\"&\" etc.
\n\nThe 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\nBe 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\nAlso 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": [ + "allMixins": [ "Ext.util.Observable" ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, + "deprecated": 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\nDOM events from ExtJs Components
\n\n\nWhile 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:
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(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.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds 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 + "members": { + "cfg": [ + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Connection.html#Ext-data-Connection-cfg-disableCaching", + "shortDoc": "(Optional) True to add a unique cache-buster param to GET requests. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "name": "disableCaching", + "owner": "Ext.data.Connection", + "doc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)
\n", + "linenr": 48, + "html_filename": "Connection.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Connection.html#Ext-data-Connection-cfg-disableCachingParam", + "shortDoc": "(Optional) Change the parameter which is sent went disabling caching\nthrough a cache buster. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "name": "disableCachingParam", + "owner": "Ext.data.Connection", + "doc": "(Optional) Change the parameter which is sent went disabling caching\nthrough a cache buster. Defaults to '_dc'
\n", + "linenr": 53, + "html_filename": "Connection.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Connection.html#Ext-data-Connection-cfg-extraParams", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "name": "extraParams", + "owner": "Ext.data.Connection", + "doc": "(Optional) Any parameters to be appended to the request.
\n", + "linenr": 64, + "html_filename": "Connection.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Observable.html#Ext-util-Observable-cfg-listeners", + "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "name": "listeners", + "owner": "Ext.util.Observable", + "doc": "A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from ExtJS Components
\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:
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(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)
\n", + "linenr": 59, + "html_filename": "Connection.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Connection.html#Ext-data-Connection-method-abort", + "shortDoc": "Aborts any outstanding request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "(Optional) defaults to the last request
\n", + "name": "request" + } + ], + "name": "abort", + "owner": "Ext.data.Connection", + "doc": "Aborts any outstanding request.
\n", + "linenr": 636, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object/String", + "optional": false, + "doc": "Either an object with event names as properties with a value of true or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\nOptional additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n", + "linenr": 494, + "return": { + "type": "void", + "doc": "\n" }, - { - "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.
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nAppends an event handler to this object.
\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this reference) in which the handler function is executed.\nIf 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\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\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});\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", - "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.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(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)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "opt", - "doc": "Optional. If the ename parameter was an event name, this\nis the addListener options.
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.
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": [ + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-addStatics", + "shortDoc": "Add / override static properties of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "addStatics", + "owner": "Ext.Base", + "doc": "Add / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\nthis
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callOverridden", + "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "The arguments, either an array or the arguments object
Call the original method that was previously overridden with Ext.Base.override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\nReturns the result after calling the overridden method
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callParent", + "shortDoc": "Call the parent's overridden method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
Call the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\nReturns the result from the superclass' method
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "The Observable to capture events from.
\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "The function to call when an event is fired.
\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "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.
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\nExample:
\n\n\nExt.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});\nThe 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\nAn 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\nThis 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\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\nThe 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 + ], + "name": "clearListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all listeners for this object including the managed listeners
\n", + "linenr": 425, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "Removes all managed listeners for this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" }, - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-create", + "shortDoc": "Create a new instance of this Class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "create", + "owner": "Ext.Base", + "doc": "Create a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\nAll parameters are passed to the constructor of the class.
\n", + "linenr": 329, + "return": { "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.
the created instance.
\n" }, - { - "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.
The Observable whose events this object is to relay.
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-createAlias", + "shortDoc": "Create aliases for existing prototype methods. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "String/Object", + "optional": false, + "doc": "The new method name, or an object to set multiple aliases. See\nflexSetter
\n", + "name": "alias" + }, + { + "type": "String/Object", + "optional": false, + "doc": "The original method name
\n", + "name": "origin" + } + ], + "name": "createAlias", + "owner": "Ext.Base", + "doc": "Create aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\nArray of event names to relay.
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String/[String]", + "optional": false, + "doc": "The event name to bubble, or an Array of event names.
\n", + "name": "events" + } + ], + "name": "enableBubble", + "owner": "Ext.util.Observable", + "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : 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.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\nRelays selected events from the specified Observable as if the events were fired by this.
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": [ - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-fireEvent", + "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to fire.
\n", + "name": "eventName" + }, + { + "type": "Object...", + "optional": false, + "doc": "Variable number of parameters are passed to handlers.
\n", + "name": "args" + } + ], + "name": "fireEvent", + "owner": "Ext.util.Observable", + "doc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\n", + "linenr": 233, + "return": { + "type": "Boolean", + "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-getName", + "shortDoc": "Get the current class' name in string format. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "getName", + "owner": "Ext.Base", + "doc": "Get the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\nThe type of event the handler was associated with.
\n", - "optional": false + "doc": "className
\n" }, - { - "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 + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to check for
\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "Checks to see if this object has any listeners for a specified event
\n", + "linenr": 530, + "return": { + "type": "Boolean", + "doc": "True if the event is being listened for, else false
\n" }, - { - "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.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
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\nImportant: 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\nExt.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});\nTo 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:
True if the form object is a file upload (will be set automatically if the form was\nconfigured with enctype \"multipart/form-data\").
\n\n\nFile uploads are not performed using normal \"Ajax\" techniques, that is they are not\nperformed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\nDOM <form> element temporarily modified to have its\ntarget set to refer\nto a dynamically generated, hidden <iframe> which is inserted into the document\nbut removed after the return data has been gathered.
\n\n\nThe server response is parsed by the browser to create the document for the IFRAME. If the\nserver is using JSON to send the return object, then the\nContent-Type header\nmust be set to \"text/html\" in order to tell the browser to insert the text unchanged into the document body.
\n\n\nThe response text is retrieved from the document, and a fake XMLHttpRequest object\nis created containing a responseText property in order to conform to the\nrequirements of event handlers and callbacks.
\n\n\nBe aware that file upload packets are sent with the content type multipart/form\nand some server technologies (notably JEE) may require some custom processing in order to\nretrieve parameter names and parameter values from the packet content.
\n\n\nThe 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.
Set various options such as the url, params for the request
\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "The initial options
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-implement", + "shortDoc": "Add methods / properties to the prototype of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "implement", + "owner": "Ext.Base", + "doc": "Add methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\nThe 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": [ - { + "doc": "mixins The mixin prototypes as key - value pairs
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Connection.html#Ext-data-Connection-method-isLoading", + "shortDoc": "Determine whether this object has a request outstanding. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "(Optional) defaults to the last transaction
\n", + "name": "request" + } + ], + "name": "isLoading", + "owner": "Ext.data.Connection", + "doc": "Determine whether this object has a request outstanding.
\n", + "linenr": 622, + "return": { "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 + "doc": "True if there is an outstanding request.
\n" + }, + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" }, - { - "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 + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mon", + "shortDoc": "Shorthand for addManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(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)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 681, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mun", + "shortDoc": "Shorthand for removeManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "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)\nin which the handler function is executed.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\n", + "linenr": 687, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Function", + "optional": false, + "doc": "The class constructor to make observable.
\n", + "name": "c" + }, + { + "type": "Object", + "optional": false, + "doc": "An object containing a series of listeners to add. See addListener.
\n", + "name": "listeners" + } + ], + "name": "observe", + "owner": "Ext.util.Observable", + "doc": "Sets observability on the passed class constructor.
\n\nThis 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\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nShorthand for addListener.
\n\nAppends an event handler to this object.
\n", + "linenr": 669, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\nthis
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Connection.html#Ext-data-Connection-method-parseStatus", + "shortDoc": "Check if the response status was successful ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "The status code
\n", + "name": "status" + } + ], + "name": "parseStatus", + "owner": "Ext.data.Connection", + "doc": "Check if the response status was successful
\n", + "linenr": 743, + "return": { "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 + "doc": "An object containing success/status state
\n" }, - { - "type": "String", - "name": "url", - "doc": "The url to post to
\n", - "optional": false + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The Observable whose events this object is to relay.
\n", + "name": "origin" + }, + { + "type": "[String]", + "optional": false, + "doc": "Array of event names to relay.
\n", + "name": "events" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "prefix" + } + ], + "name": "relayEvents", + "owner": "Ext.util.Observable", + "doc": "Relays selected events from the specified Observable as if the events were fired by this.
Any extra parameters to pass
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "Removes all added captures from the Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "The Observable to release
\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "Removes all added captures from the Observable.
\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "removeListener", + "owner": "Ext.util.Observable", + "doc": "Removes an event handler.
\n", + "linenr": 392, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "Removes listeners that were added by the mon method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "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)\nin which the handler function is executed.
Removes listeners that were added by the mon method.
\n", + "linenr": 197, + "return": { + "type": "void", + "doc": "\n" }, - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Connection.html#Ext-data-Connection-method-request", + "shortDoc": "Sends an HTTP request to a remote server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "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\nconfigured with enctype \"multipart/form-data\").
\n\n\nFile uploads are not performed using normal \"Ajax\" techniques, that is they are not\nperformed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\nDOM <form> element temporarily modified to have its\ntarget set to refer\nto a dynamically generated, hidden <iframe> which is inserted into the document\nbut removed after the return data has been gathered.
\n\n\nThe server response is parsed by the browser to create the document for the IFRAME. If the\nserver is using JSON to send the return object, then the\nContent-Type header\nmust be set to \"text/html\" in order to tell the browser to insert the text unchanged into the document body.
\n\n\nThe response text is retrieved from the document, and a fake XMLHttpRequest object\nis created containing a responseText property in order to conform to the\nrequirements of event handlers and callbacks.
\n\n\nBe aware that file upload packets are sent with the content type multipart/form\nand some server technologies (notably JEE) may require some custom processing in order to\nretrieve parameter names and parameter values from the packet content.
\n\n\nThe 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", + "name": "options" + } + ], + "name": "request", + "owner": "Ext.data.Connection", + "doc": "Sends an HTTP request to a remote server.
\n\n\nImportant: 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\nExt.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});\nTo execute a callback function in the correct scope, use the scope option.
\n\n", + "linenr": 112, + "return": { "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": [ + "doc": "request The request object. This may be used\nto cancel the request.
\n" + }, + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-resumeEvents", + "shortDoc": "Resumes firing events (see suspendEvents). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "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 + ], + "name": "resumeEvents", + "owner": "Ext.util.Observable", + "doc": "Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the **queueSuspended** parameter, then all events fired\nduring event suspension will be sent to any listeners now.
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 - }, - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Connection.html#Ext-data-Connection-method-setOptions", + "shortDoc": "Set various options such as the url, params for the request ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The initial options
\n", + "name": "options" + }, + { + "type": "Object", + "optional": false, + "doc": "The scope to execute in
\n", + "name": "scope" + } + ], + "name": "setOptions", + "owner": "Ext.data.Connection", + "doc": "Set various options such as the url, params for the request
\n", + "linenr": 409, + "return": { "type": "Object", - "name": "response", - "doc": "The XHR object containing the response data.\nSee The XMLHttpRequest Object\nfor details.
\n", - "optional": false + "doc": "The params for the request
\n" }, - { - "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": [ + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ - ], - "cssMixin": [ + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", + "name": "queueSuspended" + } + ], + "name": "suspendEvents", + "owner": "Ext.util.Observable", + "doc": "Suspends the firing of all events. (see resumeEvents)
\n", + "linenr": 541, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Shorthand for removeListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "un", + "owner": "Ext.util.Observable", + "doc": "Shorthand for removeListener.
\n\nRemoves an event handler.
\n", + "linenr": 675, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Connection.html#Ext-data-Connection-method-upload", + "shortDoc": "Upload a form using a hidden iframe. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "The form to upload
\n", + "name": "form" + }, + { + "type": "String", + "optional": false, + "doc": "The url to post to
\n", + "name": "url" + }, + { + "type": "String", + "optional": false, + "doc": "Any extra parameters to pass
\n", + "name": "params" + }, + { + "type": "Object", + "optional": false, + "doc": "The initial options
\n", + "name": "options" + } + ], + "name": "upload", + "owner": "Ext.data.Connection", + "doc": "Upload a form using a hidden iframe.
\n", + "linenr": 280, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Connection.html" + } + ], + "property": [ + { + "type": "Class", + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "property", + "href": "Base3.html#Ext-Base-property-self", + "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "name": "self", + "owner": "Ext.Base", + "doc": "Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nThis Connection object.
\n", + "name": "conn" + }, + { + "type": "Object", + "optional": false, + "doc": "The options config object passed to the request method.
\n", + "name": "options" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforerequest", + "owner": "Ext.data.Connection", + "doc": "Fires before a network request is made to retrieve a data object.
\n", + "linenr": 78, + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Connection.html#Ext-data-Connection-event-requestcomplete", + "shortDoc": "Fires if the request was successfully completed. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Connection", + "optional": false, + "doc": "This Connection object.
\n", + "name": "conn" + }, + { + "type": "Object", + "optional": false, + "doc": "The XHR object containing the response data.\nSee The XMLHttpRequest Object\nfor details.
\n", + "name": "response" + }, + { + "type": "Object", + "optional": false, + "doc": "The options config object passed to the request method.
\n", + "name": "options" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "requestcomplete", + "owner": "Ext.data.Connection", + "doc": "Fires if the request was successfully completed.
\n", + "linenr": 85, + "html_filename": "Connection.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Connection.html#Ext-data-Connection-event-requestexception", + "shortDoc": "Fires if an error HTTP status was returned from the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "params": [ + { + "type": "Connection", + "optional": false, + "doc": "This Connection object.
\n", + "name": "conn" + }, + { + "type": "Object", + "optional": false, + "doc": "The XHR object containing the response data.\nSee The XMLHttpRequest Object\nfor details.
\n", + "name": "response" + }, + { + "type": "Object", + "optional": false, + "doc": "The options config object passed to the request method.
\n", + "name": "options" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "requestexception", + "owner": "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", + "linenr": 95, + "html_filename": "Connection.html" + } + ] + }, + "singleton": false, + "alias": null, + "superclasses": [ + "Ext.Base" ], + "protected": false, + "tagname": "class", + "mixins": [ + "Ext.util.Observable" + ], + "href": "Connection.html#Ext-data-Connection", "subclasses": [ "Ext.Ajax" ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Connection.js", + "private": false, + "alternateClassNames": [ + + ], + "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\nRequests 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\nFile Uploads
\n\n\nFile 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\nThe 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\nCharacters which are significant to an HTML parser must be sent as HTML entities, so encode \"<\" as \"<\", \"&\" as\n\"&\" etc.
\n\nThe 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\nBe 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\nAlso note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire.
\n", "mixedInto": [ ], - "allMixins": [ - "Ext.util.Observable" - ] + "linenr": 1, + "xtypes": [ + + ], + "html_filename": "Connection.html", + "extends": "Ext.Base" }); \ No newline at end of file