This class is used to send requests to the server using Ext.direct. When a request is made,\nthe transport mechanism is handed off to the appropriate Provider\nto complete the call.
\n\nThis proxy expects a Direct remoting method to be passed in order to be able to complete requests.\nThis can be done by specifying the directFn configuration. This will use the same direct\nmethod for all requests. Alternatively, you can provide an api configuration. This\nallows you to specify a different remoting method for each CRUD action.
\n\nThis proxy provides options to help configure which parameters will be sent to the server.\nBy specifying the paramsAsHash option, it will send an object literal containing each\nof the passed parameters. The paramOrder option can be used to specify the order in which\nthe remoting method parameters are passed.
\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['firstName', 'lastName'],\n proxy: {\n type: 'direct',\n directFn: MyApp.getUsers,\n paramOrder: 'id' // Tells the proxy to pass the id as the first parameter to the remoting method.\n }\n});\nUser.load(1);\nThe same as Ext.data.proxy.Server.api, however instead of providing urls, you should provide a direct\nfunction call.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Direct.js", - "linenr": 74, - "html_filename": "Direct.html", - "href": "Direct.html#Ext-data-proxy-Direct-cfg-api" - }, - { - "tagname": "cfg", - "name": "batchActions", - "member": "Ext.data.proxy.Proxy", - "type": "Boolean", - "doc": "True to batch actions of a particular type when synchronizing the store.\nDefaults to true.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 64, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchActions" - }, - { - "tagname": "cfg", - "name": "batchOrder", - "member": "Ext.data.proxy.Proxy", - "type": "String", - "doc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this\nto set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 57, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchOrder", - "shortDoc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this\nto set a different ord..." - }, - { - "tagname": "cfg", - "name": "cacheString", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the cache param added to the url when using noCache (defaults to \"_dc\")
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 87, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-cacheString" - }, - { - "tagname": "cfg", - "name": "directFn", - "member": "Ext.data.proxy.Direct", - "type": "Function", - "doc": "Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter\nfor Store's which will not implement a full CRUD api.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Direct.js", - "linenr": 67, - "html_filename": "Direct.html", - "href": "Direct.html#Ext-data-proxy-Direct-cfg-directFn", - "shortDoc": "Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parame..." - }, - { - "tagname": "cfg", - "name": "directionParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true.\nDefaults to 'dir'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 69, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-directionParam", - "shortDoc": "The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true.\nDefau..." - }, - { - "tagname": "cfg", - "name": "extraParams", - "member": "Ext.data.proxy.Direct", - "type": "Object", - "doc": "Extra parameters that will be included on every read request. Individual requests with params\nof the same name will override these params when they are in conflict.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Direct.js", - "linenr": 79, - "html_filename": "Direct.html", - "href": "Direct.html#Ext-data-proxy-Direct-cfg-extraParams", - "shortDoc": "Extra parameters that will be included on every read request. Individual requests with params\nof the same name will o..." - }, - { - "tagname": "cfg", - "name": "filterParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set\nthis to undefined if you don't want to send a filter parameter
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 63, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-filterParam", - "shortDoc": "The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set\nthis to undefined if you don't wan..." - }, - { - "tagname": "cfg", - "name": "groupParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this\nto undefined if you don't want to send a group parameter
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 51, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-groupParam", - "shortDoc": "The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this\nto undefined if you don't want ..." - }, - { - "tagname": "cfg", - "name": "limitParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this\nto undefined if you don't want to send a limit parameter
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 45, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-limitParam", - "shortDoc": "The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this\nto undefined if you don't want ..." - }, - { - "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});\nThe name of the Model to tie to this Proxy. Can be either the string name of\nthe Model, or a reference to the Model constructor. Required.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 82, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-model", - "shortDoc": "The name of the Model to tie to this Proxy. Can be either the string name of\nthe Model, or a reference to the Model c..." - }, - { - "tagname": "cfg", - "name": "noCache", - "member": "Ext.data.proxy.Server", - "type": "Boolean", - "doc": "(optional) Defaults to true. Disable caching by adding a unique parameter\nname to the request.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 81, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-noCache" - }, - { - "tagname": "cfg", - "name": "pageParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to\nundefined if you don't want to send a page parameter
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 33, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-pageParam", - "shortDoc": "The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to\nundefined if you don't want to..." - }, - { - "tagname": "cfg", - "name": "paramOrder", - "member": "Ext.data.proxy.Direct", - "type": "Array/String", - "doc": "Defaults to undefined. A list of params to be executed\nserver side. Specify the params in the order in which they must be executed on the server-side\nas either (1) an Array of String values, or (2) a String of params delimited by either whitespace,\ncomma, or pipe. For example,\nany of the following would be acceptable:
\n\nparamOrder: ['param1','param2','param3']\nparamOrder: 'param1 param2 param3'\nparamOrder: 'param1,param2,param3'\nparamOrder: 'param1|param2|param'\n Send parameters as a collection of named arguments (defaults to true). Providing a\nparamOrder nullifies this configuration.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Direct.js", - "linenr": 60, - "html_filename": "Direct.html", - "href": "Direct.html#Ext-data-proxy-Direct-cfg-paramsAsHash", - "shortDoc": "Send parameters as a collection of named arguments (defaults to true). Providing a\nparamOrder nullifies this configur..." - }, - { - "tagname": "cfg", - "name": "reader", - "member": "Ext.data.proxy.Server", - "type": "Object/String/Ext.data.reader.Reader", - "doc": "The Ext.data.reader.Reader to use to decode the server's response. This can\neither be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 23, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-reader", - "shortDoc": "The Ext.data.reader.Reader to use to decode the server's response. This can\neither be a Reader instance, a config obj..." - }, - { - "tagname": "cfg", - "name": "simpleSortMode", - "member": "Ext.data.proxy.Server", - "type": "Boolean", - "doc": "Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested.\nThe directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 75, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-simpleSortMode", - "shortDoc": "Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote..." - }, - { - "tagname": "cfg", - "name": "sortParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this\nto undefined if you don't want to send a sort parameter
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 57, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-sortParam", - "shortDoc": "The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this\nto undefined if you don't want to..." - }, - { - "tagname": "cfg", - "name": "startParam", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this\nto undefined if you don't want to send a start parameter
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 39, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-startParam", - "shortDoc": "The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this\nto undefined if you don't want ..." - }, - { - "tagname": "cfg", - "name": "timeout", - "member": "Ext.data.proxy.Server", - "type": "Number", - "doc": "(optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 92, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-timeout" - }, - { - "tagname": "cfg", - "name": "url", - "member": "Ext.data.proxy.Server", - "type": "String", - "doc": "The URL from which to request the data object.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 19, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-url" - }, - { - "tagname": "cfg", - "name": "writer", - "member": "Ext.data.proxy.Server", - "type": "Object/String/Ext.data.writer.Writer", - "doc": "The Ext.data.writer.Writer to use to encode any request sent to the server.\nThis can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 28, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-cfg-writer", - "shortDoc": "The Ext.data.writer.Writer to use to encode any request sent to the server.\nThis can either be a Writer instance, a c..." - } - ], - "method": [ - { - "tagname": "method", - "name": "Direct", - "member": "Ext.data.proxy.Proxy", - "doc": "Creates the Proxy
\n", - "params": [ - { + "members": { + "cfg": [ + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Direct.html#Ext-data-proxy-Direct-cfg-api", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Direct.js", + "private": false, + "name": "api", + "owner": "Ext.data.proxy.Direct", + "doc": "The same as Ext.data.proxy.Server.api, however instead of providing urls, you should provide a direct\nfunction call.
\n", + "linenr": 74, + "html_filename": "Direct.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchActions", + "shortDoc": "True to batch actions of a particular type when synchronizing the store. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "name": "batchActions", + "owner": "Ext.data.proxy.Proxy", + "doc": "True to batch actions of a particular type when synchronizing the store.\nDefaults to true.
\n", + "linenr": 61, + "html_filename": "Proxy2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchOrder", + "shortDoc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "name": "batchOrder", + "owner": "Ext.data.proxy.Proxy", + "doc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this\nto set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'
\n", + "linenr": 54, + "html_filename": "Proxy2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-cacheString", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "cacheString", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the cache param added to the url when using noCache (defaults to \"_dc\")
\n", + "linenr": 87, + "html_filename": "Server.html" + }, + { + "type": "Function", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Direct.html#Ext-data-proxy-Direct-cfg-directFn", + "shortDoc": "Function to call when executing a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Direct.js", + "private": false, + "name": "directFn", + "owner": "Ext.data.proxy.Direct", + "doc": "Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter\nfor Store's which will not implement a full CRUD api.
\n", + "linenr": 67, + "html_filename": "Direct.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-directionParam", + "shortDoc": "The name of the direction parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "directionParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true.\nDefaults to 'dir'.
\n", + "linenr": 69, + "html_filename": "Server.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Direct.html#Ext-data-proxy-Direct-cfg-extraParams", + "shortDoc": "Extra parameters that will be included on every read request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Direct.js", + "private": false, + "name": "extraParams", + "owner": "Ext.data.proxy.Direct", + "doc": "Extra parameters that will be included on every read request. Individual requests with params\nof the same name will override these params when they are in conflict.
\n", + "linenr": 79, + "html_filename": "Direct.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-filterParam", + "shortDoc": "The name of the 'filter' parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "filterParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set\nthis to undefined if you don't want to send a filter parameter
\n", + "linenr": 63, + "html_filename": "Server.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-groupParam", + "shortDoc": "The name of the 'group' parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "groupParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this\nto undefined if you don't want to send a group parameter
\n", + "linenr": 51, + "html_filename": "Server.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-limitParam", + "shortDoc": "The name of the 'limit' parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "limitParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this\nto undefined if you don't want to send a limit parameter
\n", + "linenr": 45, + "html_filename": "Server.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});\nThe name of the Model to tie to this Proxy. Can be either the string name of\nthe Model, or a reference to the Model constructor. Required.
\n", + "linenr": 79, + "html_filename": "Proxy2.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-noCache", + "shortDoc": "(optional) Defaults to true. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "noCache", + "owner": "Ext.data.proxy.Server", + "doc": "(optional) Defaults to true. Disable caching by adding a unique parameter\nname to the request.
\n", + "linenr": 81, + "html_filename": "Server.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-pageParam", + "shortDoc": "The name of the 'page' parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "pageParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to\nundefined if you don't want to send a page parameter
\n", + "linenr": 33, + "html_filename": "Server.html" + }, + { + "type": "Array/String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Direct.html#Ext-data-proxy-Direct-cfg-paramOrder", + "shortDoc": "Defaults to undefined. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Direct.js", + "private": false, + "name": "paramOrder", + "owner": "Ext.data.proxy.Direct", + "doc": "Defaults to undefined. A list of params to be executed\nserver side. Specify the params in the order in which they must be executed on the server-side\nas either (1) an Array of String values, or (2) a String of params delimited by either whitespace,\ncomma, or pipe. For example,\nany of the following would be acceptable:
\n\nparamOrder: ['param1','param2','param3']\nparamOrder: 'param1 param2 param3'\nparamOrder: 'param1,param2,param3'\nparamOrder: 'param1|param2|param'\n Send parameters as a collection of named arguments (defaults to true). Providing a\nparamOrder nullifies this configuration.
\n", + "linenr": 60, + "html_filename": "Direct.html" + }, + { + "type": "Object/String/Ext.data.reader.Reader", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-reader", + "shortDoc": "The Ext.data.reader.Reader to use to decode the server's response. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "reader", + "owner": "Ext.data.proxy.Server", + "doc": "The Ext.data.reader.Reader to use to decode the server's response. This can\neither be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').
\n", + "linenr": 23, + "html_filename": "Server.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-simpleSortMode", + "shortDoc": "Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "simpleSortMode", + "owner": "Ext.data.proxy.Server", + "doc": "Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested.\nThe directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'
\n", + "linenr": 75, + "html_filename": "Server.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-sortParam", + "shortDoc": "The name of the 'sort' parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "sortParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this\nto undefined if you don't want to send a sort parameter
\n", + "linenr": 57, + "html_filename": "Server.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-startParam", + "shortDoc": "The name of the 'start' parameter to send in a request. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "startParam", + "owner": "Ext.data.proxy.Server", + "doc": "The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this\nto undefined if you don't want to send a start parameter
\n", + "linenr": 39, + "html_filename": "Server.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-timeout", + "shortDoc": "(optional) The number of milliseconds to wait for a response. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "timeout", + "owner": "Ext.data.proxy.Server", + "doc": "(optional) The number of milliseconds to wait for a response.\nDefaults to 30000 milliseconds (30 seconds).
\n", + "linenr": 92, + "html_filename": "Server.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-url", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "url", + "owner": "Ext.data.proxy.Server", + "doc": "The URL from which to request the data object.
\n", + "linenr": 19, + "html_filename": "Server.html" + }, + { + "type": "Object/String/Ext.data.writer.Writer", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Server.html#Ext-data-proxy-Server-cfg-writer", + "shortDoc": "The Ext.data.writer.Writer to use to encode any request sent to the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "name": "writer", + "owner": "Ext.data.proxy.Server", + "doc": "The Ext.data.writer.Writer to use to encode any request sent to the server.\nThis can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').
\n", + "linenr": 28, + "html_filename": "Server.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates the Proxy ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "(optional) Config object.
\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "doc": "Creates the Proxy
\n", + "owner": "Ext.data.proxy.Proxy", + "name": "Direct", + "html_filename": "Proxy2.html", + "return": { "type": "Object", - "name": "config", - "doc": "Optional config object
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 1, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-constructor", - "shortDoc": "Creates the Proxy
\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 + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false + "linenr": 86 + }, + { + "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 + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addManagedListener", + "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...", + "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.
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/String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false + "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" }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
The Request object
\n", + "name": "request" + }, + { + "type": "Boolean", + "optional": false, + "doc": "True if the request was successful
\n", + "name": "success" + } + ], + "name": "afterRequest", + "owner": "Ext.data.proxy.Server", + "doc": "Optional callback function which can be used to clean up after a request has been completed.
\n", + "linenr": 451, + "return": { + "type": "void", + "doc": "\n" }, - { - "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.
Object containing the Model instances to act upon, keyed by action name
\n", + "name": "operations" + }, + { + "type": "Object", + "optional": false, + "doc": "Optional listeners object passed straight through to the Batch - see Ext.data.Batch
\n", + "name": "listeners" + } + ], + "name": "batch", + "owner": "Ext.data.proxy.Proxy", + "doc": "Performs a batch of Operations, in the order specified by batchOrder. Used internally by\nExt.data.Store's sync method. Example usage:
\n\nmyProxy.batch({\n create : [myModel1, myModel2],\n update : [myModel3],\n destroy: [myModel4, myModel5]\n});\nWhere the myModel* above are Model instances - in this case 1 and 2 are new instances and have not been\nsaved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.
\n", + "linenr": 242, + "return": { + "type": "Ext.data.Batch", + "doc": "The newly created Ext.data.Batch object
\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": "afterRequest", - "member": "Ext.data.proxy.Server", - "doc": "
Optional callback function which can be used to clean up after a request has been completed.
\n", - "params": [ - { + "html_filename": "Proxy2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Server.html#Ext-data-proxy-Server-method-buildRequest", + "shortDoc": "Creates and returns an Ext.data.Request object based on the options passed by the Store\nthat this Proxy is attached to. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "params": [ + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The Operation object to execute
\n", + "name": "operation" + } + ], + "name": "buildRequest", + "owner": "Ext.data.proxy.Server", + "doc": "Creates and returns an Ext.data.Request object based on the options passed by the Store\nthat this Proxy is attached to.
\n", + "linenr": 173, + "return": { "type": "Ext.data.Request", - "name": "request", - "doc": "The Request object
\n", - "optional": false + "doc": "The request object
\n" }, - { - "type": "Boolean", - "name": "success", - "doc": "True if the request was successful
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 450, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-afterRequest", - "shortDoc": "Optional callback function which can be used to clean up after a request has been completed.
\n" - }, - { - "tagname": "method", - "name": "batch", - "member": "Ext.data.proxy.Proxy", - "doc": "Performs a batch of Operations, in the order specified by batchOrder. Used internally by\nExt.data.Store's sync method. Example usage:
\n\nmyProxy.batch({\n create : [myModel1, myModel2],\n update : [myModel3],\n destroy: [myModel4, myModel5]\n});\nWhere the myModel* above are Model instances - in this case 1 and 2 are new instances and have not been\nsaved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.
\n", - "params": [ - { - "type": "Object", - "name": "operations", - "doc": "Object containing the Model instances to act upon, keyed by action name
\n", - "optional": false + "html_filename": "Server.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Server.html#Ext-data-proxy-Server-method-buildUrl", + "shortDoc": "Generates a url based on a given Ext.data.Request object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "params": [ + { + "type": "Ext.data.Request", + "optional": false, + "doc": "The request object
\n", + "name": "request" + } + ], + "name": "buildUrl", + "owner": "Ext.data.proxy.Server", + "doc": "Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will\nadd the cache-buster param to the end of the url. Subclasses may need to perform additional modifications\nto the url.
\n", + "linenr": 400, + "return": { + "type": "String", + "doc": "The url
\n" }, - { - "type": "Object", - "name": "listeners", - "doc": "Optional listeners object passed straight through to the Batch - see Ext.data.Batch
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.Batch", - "doc": "The newly created Ext.data.Batch object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 241, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-batch", - "shortDoc": "Performs a batch of Operations, in the order specified by batchOrder. Used internally by\nExt.data.Store's sync method..." - }, - { - "tagname": "method", - "name": "buildRequest", - "member": "Ext.data.proxy.Server", - "doc": "Creates and returns an Ext.data.Request object based on the options passed by the Store\nthat this Proxy is attached to.
\n", - "params": [ - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The Operation object to execute
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.Request", - "doc": "The request object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 172, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-buildRequest", - "shortDoc": "Creates and returns an Ext.data.Request object based on the options passed by the Store\nthat this Proxy is attached to.
\n" - }, - { - "tagname": "method", - "name": "buildUrl", - "member": "Ext.data.proxy.Server", - "doc": "Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will\nadd the cache-buster param to the end of the url. Subclasses may need to perform additional modifications\nto the url.
\n", - "params": [ - { - "type": "Ext.data.Request", - "name": "request", - "doc": "The request object
\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "The url
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 399, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-buildUrl", - "shortDoc": "Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will\nadd the cache-buste..." - }, - { - "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 + "html_filename": "Server.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" }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\n", - "optional": false + "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" }, - { - "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": [ + "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": 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": [ + ], + "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" + }, + "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": [ - ], - "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": "create", - "member": "Ext.data.proxy.Proxy", - "doc": "Performs the given create operation.
\n", - "params": [ - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The Operation to perform
\n", - "optional": false + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "callback", - "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-create", + "shortDoc": "Performs the given create operation. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The Operation to perform
\n", + "name": "operation" + }, + { + "type": "Function", + "optional": false, + "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", + "name": "callback" + }, + { + "type": "Object", + "optional": false, + "doc": "Scope to execute the callback function in
\n", + "name": "scope" + } + ], + "name": "create", + "owner": "Ext.data.proxy.Proxy", + "doc": "Performs the given create operation.
\n", + "linenr": 206, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Scope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 205, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-create", - "shortDoc": "Performs the given create operation.
\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.data.proxy.Proxy", - "doc": "Performs the given destroy operation.
\n", - "params": [ - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The Operation to perform
\n", - "optional": false + "html_filename": "Proxy2.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()\nCallback function to be called when the Operation has completed (whether successful or not)
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-destroy", + "shortDoc": "Performs the given destroy operation. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The Operation to perform
\n", + "name": "operation" + }, + { + "type": "Function", + "optional": false, + "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", + "name": "callback" + }, + { + "type": "Object", + "optional": false, + "doc": "Scope to execute the callback function in
\n", + "name": "scope" + } + ], + "name": "destroy", + "owner": "Ext.data.proxy.Proxy", + "doc": "Performs the given destroy operation.
\n", + "linenr": 233, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Scope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 232, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-destroy", - "shortDoc": "Performs the given destroy operation.
\n" - }, - { - "tagname": "method", - "name": "doRequest", - "member": "Ext.data.proxy.Server", - "doc": "In ServerProxy subclasses, the create, read, update and destroy methods all pass\nthrough to doRequest. Each ServerProxy subclass must implement the doRequest method - see Ext.data.proxy.JsonP\nand Ext.data.proxy.Ajax for examples. This method carries the same signature as each of the methods that delegate to it.
\n", - "params": [ - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The Ext.data.Operation object
\n", - "optional": false + "html_filename": "Proxy2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Server.html#Ext-data-proxy-Server-method-doRequest", + "shortDoc": "In ServerProxy subclasses, the create, read, update and destroy methods all pass\nthrough to doRequest. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "params": [ + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The Ext.data.Operation object
\n", + "name": "operation" + }, + { + "type": "Function", + "optional": false, + "doc": "The callback function to call when the Operation has completed
\n", + "name": "callback" + }, + { + "type": "Object", + "optional": false, + "doc": "The scope in which to execute the callback
\n", + "name": "scope" + } + ], + "name": "doRequest", + "owner": "Ext.data.proxy.Server", + "doc": "In ServerProxy subclasses, the create, read, update and destroy methods all pass\nthrough to doRequest. Each ServerProxy subclass must implement the doRequest method - see Ext.data.proxy.JsonP\nand Ext.data.proxy.Ajax for examples. This method carries the same signature as each of the methods that delegate to it.
\n", + "linenr": 437, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "callback", - "doc": "The callback function to call when the Operation has completed
\n", - "optional": false + "html_filename": "Server.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});\nThe scope in which to execute the callback
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 436, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-doRequest", - "shortDoc": "In ServerProxy subclasses, the create, read, update and destroy methods all pass\nthrough to doRequest. Each ServerPro..." - }, - { - "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": "encodeFilters", - "member": "Ext.data.proxy.Server", - "doc": "Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default,\nthis simply JSON-encodes the filter data
\n", - "params": [ - { - "type": "Array", - "name": "sorters", - "doc": "The array of Filter objects
\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "The encoded filters
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 319, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-encodeFilters", - "shortDoc": "Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default,\nthis simply JSO..." - }, - { - "tagname": "method", - "name": "encodeSorters", - "member": "Ext.data.proxy.Server", - "doc": "Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default,\nthis simply JSON-encodes the sorter data
\n", - "params": [ - { - "type": "Array", - "name": "sorters", - "doc": "The array of Sorter objects
\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "The encoded sorters
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 298, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-encodeSorters", - "shortDoc": "Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default,\nthis simply JSO..." - }, - { - "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": [ - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Server.html#Ext-data-proxy-Server-method-encodeFilters", + "shortDoc": "Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "params": [ + { + "type": "Array", + "optional": false, + "doc": "The array of Filter objects
\n", + "name": "sorters" + } + ], + "name": "encodeFilters", + "owner": "Ext.data.proxy.Server", + "doc": "Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default,\nthis simply JSON-encodes the filter data
\n", + "linenr": 320, + "return": { "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\n", - "optional": false + "doc": "The encoded filters
\n" }, - { - "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": "getModel", - "member": "Ext.data.proxy.Proxy", - "doc": "Returns the model attached to this Proxy
\n", - "params": [ - - ], - "return": { - "type": "Ext.data.Model", - "doc": "The model
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 123, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getModel", - "shortDoc": "Returns the model attached to this Proxy
\n" - }, - { - "tagname": "method", - "name": "getReader", - "member": "Ext.data.proxy.Proxy", - "doc": "Returns the reader currently attached to this proxy instance
\n", - "params": [ + "html_filename": "Server.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Server.html#Ext-data-proxy-Server-method-encodeSorters", + "shortDoc": "Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "params": [ + { + "type": "Array", + "optional": false, + "doc": "The array of Sorter objects
\n", + "name": "sorters" + } + ], + "name": "encodeSorters", + "owner": "Ext.data.proxy.Server", + "doc": "Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default,\nthis simply JSON-encodes the sorter data
\n", + "linenr": 299, + "return": { + "type": "String", + "doc": "The encoded sorters
\n" + }, + "html_filename": "Server.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": "Proxy2.html#Ext-data-proxy-Proxy-method-getModel", + "shortDoc": "Returns the model attached to this Proxy ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.data.reader.Reader", - "doc": "The Reader instance
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 162, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getReader", - "shortDoc": "Returns the reader currently attached to this proxy instance
\n" - }, - { - "tagname": "method", - "name": "getWriter", - "member": "Ext.data.proxy.Proxy", - "doc": "Returns the writer currently attached to this proxy instance
\n", - "params": [ + ], + "name": "getModel", + "owner": "Ext.data.proxy.Proxy", + "doc": "Returns the model attached to this Proxy
\n", + "linenr": 124, + "return": { + "type": "Ext.data.Model", + "doc": "The model
\n" + }, + "html_filename": "Proxy2.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": [ - ], - "return": { - "type": "Ext.data.writer.Writer", - "doc": "The Writer instance
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 197, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getWriter", - "shortDoc": "Returns the writer currently attached to this proxy instance
\n" - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "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 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": "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 + "doc": "className
\n" }, - { - "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 + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getReader", + "shortDoc": "Returns the reader currently attached to this proxy instance ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + + ], + "name": "getReader", + "owner": "Ext.data.proxy.Proxy", + "doc": "Returns the reader currently attached to this proxy instance
\n", + "linenr": 163, + "return": { + "type": "Ext.data.reader.Reader", + "doc": "The Reader instance
\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false + "html_filename": "Proxy2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getWriter", + "shortDoc": "Returns the writer currently attached to this proxy instance ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + + ], + "name": "getWriter", + "owner": "Ext.data.proxy.Proxy", + "doc": "Returns the writer currently attached to this proxy instance
\n", + "linenr": 198, + "return": { + "type": "Ext.data.writer.Writer", + "doc": "The Writer instance
\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 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": "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": "processResponse", - "member": "Ext.data.proxy.Server", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "success", - "doc": "\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'\nmixins The mixin prototypes as key - value pairs
\n" }, - { - "type": "Object", - "name": "request", - "doc": "\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" }, - { - "type": "Object", - "name": "response", - "doc": "\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" }, - { - "type": "Object", - "name": "callback", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" }, - { - "type": "Object", - "name": "scope", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 208, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-method-processResponse", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "read", - "member": "Ext.data.proxy.Proxy", - "doc": "Performs the given read operation.
\n", - "params": [ - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The Operation to perform
\n", - "optional": false + "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" }, - { - "type": "Function", - "name": "callback", - "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", - "optional": false + "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});\nScope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 214, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-read", - "shortDoc": "Performs the given read operation.
\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": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addListener" }, - { - "type": "Array", - "name": "events", - "doc": "Array of event names to relay.
\n", - "optional": false + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "Shorthand for addListener. ...", + "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 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" }, - { - "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.
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 + "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" }, - { - "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": "Server.html#Ext-data-proxy-Server-method-processResponse", + "shortDoc": " ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Server.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "success" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "operation" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "request" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "response" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "callback" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "scope" + } + ], + "name": "processResponse", + "owner": "Ext.data.proxy.Server", + "doc": "\n", + "linenr": 209, + "return": { + "type": "void", + "doc": "\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 + "html_filename": "Server.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-read", + "shortDoc": "Performs the given read operation. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The Operation to perform
\n", + "name": "operation" + }, + { + "type": "Function", + "optional": false, + "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", + "name": "callback" + }, + { + "type": "Object", + "optional": false, + "doc": "Scope to execute the callback function in
\n", + "name": "scope" + } + ], + "name": "read", + "owner": "Ext.data.proxy.Proxy", + "doc": "Performs the given read operation.
\n", + "linenr": 215, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object|String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false + "html_filename": "Proxy2.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.
Optional. If the ename parameter was an event name, this\nis the handler function.
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" }, - { - "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.
Removes listeners that were added by the mon method.
\n" - }, - { - "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.
Sets the model associated with this proxy. This will only usually be called by a Store
\n", - "params": [ - { - "type": "String|Ext.data.Model", - "name": "model", - "doc": "The new model. Can be either the model name string,\nor a reference to the model's constructor
\n", - "optional": false + "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" }, - { - "type": "Boolean", - "name": "setOnStore", - "doc": "Sets the new model on the associated Store, if one is present
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 103, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setModel", - "shortDoc": "Sets the model associated with this proxy. This will only usually be called by a Store
\n" - }, - { - "tagname": "method", - "name": "setReader", - "member": "Ext.data.proxy.Proxy", - "doc": "Sets the Proxy's Reader by string, config object or Reader instance
\n", - "params": [ - { - "type": "String|Object|Ext.data.reader.Reader", - "name": "reader", - "doc": "The new Reader, which can be either a type string, a configuration object\nor an Ext.data.reader.Reader instance
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.reader.Reader", - "doc": "The attached Reader object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 131, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setReader", - "shortDoc": "Sets the Proxy's Reader by string, config object or Reader instance
\n" - }, - { - "tagname": "method", - "name": "setWriter", - "member": "Ext.data.proxy.Proxy", - "doc": "Sets the Proxy's Writer by string, config object or Writer instance
\n", - "params": [ - { - "type": "String|Object|Ext.data.writer.Writer", - "name": "writer", - "doc": "The new Writer, which can be either a type string, a configuration object\nor an Ext.data.writer.Writer instance
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.writer.Writer", - "doc": "The attached Writer object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 170, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setWriter", - "shortDoc": "Sets the Proxy's Writer by string, config object or Writer instance
\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 + "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": "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": [ + + ], + "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 handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setModel", + "shortDoc": "Sets the model associated with this proxy. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "String|Ext.data.Model", + "optional": false, + "doc": "The new model. Can be either the model name string,\nor a reference to the model's constructor
\n", + "name": "model" + }, + { + "type": "Boolean", + "optional": false, + "doc": "Sets the new model on the associated Store, if one is present
\n", + "name": "setOnStore" + } + ], + "name": "setModel", + "owner": "Ext.data.proxy.Proxy", + "doc": "Sets the model associated with this proxy. This will only usually be called by a Store
\n", + "linenr": 104, + "return": { + "type": "void", + "doc": "\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": 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": "update", - "member": "Ext.data.proxy.Proxy", - "doc": "Performs the given update operation.
\n", - "params": [ - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The Operation to perform
\n", - "optional": false + "html_filename": "Proxy2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setReader", + "shortDoc": "Sets the Proxy's Reader by string, config object or Reader instance ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "String|Object|Ext.data.reader.Reader", + "optional": false, + "doc": "The new Reader, which can be either a type string, a configuration object\nor an Ext.data.reader.Reader instance
\n", + "name": "reader" + } + ], + "name": "setReader", + "owner": "Ext.data.proxy.Proxy", + "doc": "Sets the Proxy's Reader by string, config object or Reader instance
\n", + "linenr": 132, + "return": { + "type": "Ext.data.reader.Reader", + "doc": "The attached Reader object
\n" }, - { - "type": "Function", - "name": "callback", - "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", - "optional": false + "html_filename": "Proxy2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setWriter", + "shortDoc": "Sets the Proxy's Writer by string, config object or Writer instance ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "String|Object|Ext.data.writer.Writer", + "optional": false, + "doc": "The new Writer, which can be either a type string, a configuration object\nor an Ext.data.writer.Writer instance
\n", + "name": "writer" + } + ], + "name": "setWriter", + "owner": "Ext.data.proxy.Proxy", + "doc": "Sets the Proxy's Writer by string, config object or Writer instance
\n", + "linenr": 171, + "return": { + "type": "Ext.data.writer.Writer", + "doc": "The attached Writer object
\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Scope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js", - "linenr": 223, - "html_filename": "Proxy2.html", - "href": "Proxy2.html#Ext-data-proxy-Proxy-method-update", - "shortDoc": "Performs the given update operation.
\n" - } - ], - "property": [ + "html_filename": "Proxy2.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": [ - ], - "event": [ - { - "tagname": "event", - "name": "exception", - "member": "Ext.data.proxy.Server", - "doc": "Fires when the server returns an exception
\n", - "params": [ - { - "type": "Ext.data.proxy.Proxy", - "name": "this", - "doc": "\n", - "optional": false + ], + "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\nThe response from the AJAX request
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "Suspends the firing of all events. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": false, + "doc": "Pass 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" }, - { - "type": "Ext.data.Operation", - "name": "operation", - "doc": "The operation that triggered request
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js", - "linenr": 132, - "html_filename": "Server.html", - "href": "Server.html#Ext-data-proxy-Server-event-exception", - "shortDoc": "Fires when the server returns an exception
\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Direct.js", - "linenr": 1, - "html_filename": "Direct.html", - "href": "Direct.html#Ext-data-proxy-Direct", - "cssVar": [ + "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": "Proxy2.html#Ext-data-proxy-Proxy-method-update", + "shortDoc": "Performs the given update operation. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The Operation to perform
\n", + "name": "operation" + }, + { + "type": "Function", + "optional": false, + "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", + "name": "callback" + }, + { + "type": "Object", + "optional": false, + "doc": "Scope to execute the callback function in
\n", + "name": "scope" + } + ], + "name": "update", + "owner": "Ext.data.proxy.Proxy", + "doc": "Performs the given update operation.
\n", + "linenr": 224, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Proxy2.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'\nThe response from the AJAX request
\n", + "name": "response" + }, + { + "type": "Ext.data.Operation", + "optional": false, + "doc": "The operation that triggered request
\n", + "name": "operation" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "exception", + "owner": "Ext.data.proxy.Server", + "doc": "Fires when the server returns an exception
\n", + "linenr": 133, + "html_filename": "Server.html" + } + ] + }, + "singleton": false, + "alias": null, "superclasses": [ + "Ext.Base", "Ext.data.proxy.Proxy", "Ext.data.proxy.Server" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Direct.html#Ext-data-proxy-Direct", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Direct.js", + "private": false, + "alternateClassNames": [ + "Ext.data.DirectProxy" + ], + "name": "Ext.data.proxy.Direct", + "doc": "This class is used to send requests to the server using Ext.direct. When a request is made,\nthe transport mechanism is handed off to the appropriate Provider\nto complete the call.
\n\nThis proxy expects a Direct remoting method to be passed in order to be able to complete requests.\nThis can be done by specifying the directFn configuration. This will use the same direct\nmethod for all requests. Alternatively, you can provide an api configuration. This\nallows you to specify a different remoting method for each CRUD action.
\n\nThis proxy provides options to help configure which parameters will be sent to the server.\nBy specifying the paramsAsHash option, it will send an object literal containing each\nof the passed parameters. The paramOrder option can be used to specify the order in which\nthe remoting method parameters are passed.
\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['firstName', 'lastName'],\n proxy: {\n type: 'direct',\n directFn: MyApp.getUsers,\n paramOrder: 'id' // Tells the proxy to pass the id as the first parameter to the remoting method.\n }\n});\nUser.load(1);\n