The LocalStorageProxy uses the new HTML5 localStorage API to save Model data locally on\nthe client browser. HTML5 localStorage is a key-value store (e.g. cannot save complex objects like JSON), so\nLocalStorageProxy automatically serializes and deserializes data when saving and retrieving it.
\n\n\n\n\nlocalStorage is extremely useful for saving user-specific information without needing to build server-side \ninfrastructure to support it. Let's imagine we're writing a Twitter search application and want to save the user's\nsearches locally so they can easily perform a saved search again later. We'd start by creating a Search model:
\n\n\n\n\nExt.define('Search', {\n fields: ['id', 'query'],\n extend: 'Ext.data.Model',\n proxy: {\n type: 'localstorage',\n id : 'twitter-Searches'\n }\n});\nOur Search model contains just two fields - id and query - plus a Proxy definition. The only configuration we\nneed to pass to the LocalStorage proxy is an id. This is important as it separates the Model data in this\nProxy from all others. The localStorage API puts all data into a single shared namespace, so by setting an id we\nenable LocalStorageProxy to manage the saved Search data.
\n\n\n\n\nSaving our data into localStorage is easy and would usually be done with a Store:
\n\n\n\n\n//our Store automatically picks up the LocalStorageProxy defined on the Search model\nvar store = new Ext.data.Store({\n model: \"Search\"\n});\n\n//loads any existing Search data from localStorage\nstore.load();\n\n//now add some Searches\nstore.add({query: 'Sencha Touch'});\nstore.add({query: 'Ext JS'});\n\n//finally, save our Search data to localStorage\nstore.sync();\nThe LocalStorageProxy automatically gives our new Searches an id when we call store.sync(). It encodes the Model\ndata and places it into localStorage. We can also save directly to localStorage, bypassing the Store altogether:
\n\n\n\n\nvar search = Ext.ModelManager.create({query: 'Sencha Animator'}, 'Search');\n\n//uses the configured LocalStorageProxy to save the new Search to localStorage\nsearch.save();\nLimitations
\n\n\n\n\nIf this proxy is used in a browser where local storage is not supported, the constructor will throw an error.\nA local storage proxy requires a unique ID which is used as a key in which all record data are stored in the\nlocal storage object.
\n\n\n\n\nIt's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided\nbut the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will\nthrow an error.
\n\n", - "extends": "Ext.data.proxy.WebStorage", - "mixins": [ - - ], - "alternateClassNames": [ - "Ext.data.LocalStorageProxy" + "allMixins": [ + "Ext.util.Observable" ], - "xtype": null, - "author": "Ed Spencer", + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "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": "id", - "member": "Ext.data.proxy.WebStorage", - "type": "String", - "doc": "The unique ID used as the key in which all record data are stored in the local storage object
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js", - "linenr": 18, - "html_filename": "WebStorage.html", - "href": "WebStorage.html#Ext-data-proxy-WebStorage-cfg-id" - }, - { - "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..." - } - ], - "method": [ - { - "tagname": "method", - "name": "LocalStorage", - "member": "Ext.data.proxy.WebStorage", - "doc": "Creates the proxy, throws an error if local storage is not supported in the current browser
\n", - "params": [ - { - "type": "Object", - "name": "config", - "doc": "Optional config object
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "members": { + "cfg": [ + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js", - "linenr": 1, - "html_filename": "WebStorage.html", - "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-constructor", - "shortDoc": "Creates the proxy, throws an error if local storage is not supported in the current browser
\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');\nComma-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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 452, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addEvents", - "shortDoc": "Adds the specified events to the list of events which this Observable may fire.
\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false - }, - { + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "WebStorage.html#Ext-data-proxy-WebStorage-cfg-id", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js", + "private": false, + "name": "id", + "owner": "Ext.data.proxy.WebStorage", + "doc": "The unique ID used as the key in which all record data are stored in the local storage object
\n", + "linenr": 14, + "html_filename": "WebStorage.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" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates the proxy, throws an error if local storage is not supported in the current browser ...", + "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/WebStorage.js", + "doc": "Creates the proxy, throws an error if local storage is not supported in the current browser
\n", + "owner": "Ext.data.proxy.WebStorage", + "name": "LocalStorage", + "html_filename": "WebStorage.html", + "return": { "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(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" + "linenr": 19 }, - "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 + { + "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/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": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "Appends an event handler to this object. ...", + "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});\nAppends an event handler to this object.
\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) If the ename parameter was an event name, this is the handler function.
(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
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": "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": "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 + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Proxy2.html#Ext-data-proxy-Proxy-method-batch", + "shortDoc": "Performs a batch of Operations, in the order specified by batchOrder. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "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": "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" + "html_filename": "Proxy2.html" }, - "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": "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 + { + "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" }, - { - "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": 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": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
The Observable to capture events from.
\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "The function to call when an event is fired.
\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 55, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-capture", - "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..." - }, - { - "tagname": "method", - "name": "clear", - "member": "Ext.data.proxy.WebStorage", - "doc": "Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage object
\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-clear", + "shortDoc": "Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage o...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" + ], + "name": "clear", + "owner": "Ext.data.proxy.WebStorage", + "doc": "Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage object
\n", + "linenr": 372, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "WebStorage.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js", - "linenr": 375, - "html_filename": "WebStorage.html", - "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-clear", - "shortDoc": "Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage o..." - }, - { - "tagname": "method", - "name": "clearListeners", - "member": "Ext.util.Observable", - "doc": "Removes all listeners for this object including the managed listeners
\n", - "params": [ + { + "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" + ], + "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" }, - "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": [ + { + "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" + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "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 + { + "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": "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": "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()\nScope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "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 + { + "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": "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": "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});\nScope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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": "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" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 554, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." - }, - { - "tagname": "method", - "name": "fireEvent", - "member": "Ext.util.Observable", - "doc": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\n", - "optional": false + { + "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": [ + + ], + "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" }, - { - "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" + "html_filename": "Proxy2.html" }, - "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": [ + { + "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.Model", - "doc": "The model
\n" + ], + "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'\nclassName
\n" + }, + "html_filename": "Base3.html" }, - "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": [ + { + "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": [ - ], - "return": { - "type": "Ext.data.reader.Reader", - "doc": "The Reader instance
\n" + ], + "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" + }, + "html_filename": "Proxy2.html" }, - "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": [ + { + "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": [ - ], - "return": { - "type": "Ext.data.writer.Writer", - "doc": "The Writer instance
\n" + ], + "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" + }, + "html_filename": "Proxy2.html" }, - "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": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to check for
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to check for
\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "Checks to see if this object has any listeners for a specified event
\n", + "linenr": 530, + "return": { + "type": "Boolean", + "doc": "True if the event is being listened for, else false
\n" + }, + "html_filename": "Observable.html" }, - "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 + { + "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();\nAn object containing a series of listeners to add. See addListener.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "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 + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-initConfig", + "shortDoc": "Initialize configuration for this class. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "config" + } + ], + "name": "initConfig", + "owner": "Ext.Base", + "doc": "Initialize 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": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" }, - { - "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 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": "options", - "doc": "(optional) An object containing handler configuration.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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": "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 + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" }, - { - "type": "Function", - "name": "callback", - "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\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": "Object", - "name": "scope", - "doc": "Scope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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 + { + "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});\nArray 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" + "html_filename": "Observable.html" }, - "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" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\nthis
\n" + }, + "html_filename": "Base3.html" }, - "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 + { + "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": "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": "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) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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 + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "Removes all added captures from the Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "The Observable to release
\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "Removes all added captures from the Observable.
\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" }, - { - "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": "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": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
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" }, - { - "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 + ], + "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.
Sets the new model on the associated Store, if one is present
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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" + { + "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" + }, + "html_filename": "Proxy2.html" }, - "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": "setRecord", - "member": "Ext.data.proxy.WebStorage", - "doc": "Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data
\n", - "params": [ - { - "type": "Ext.data.Model", - "name": "record", - "doc": "The model instance
\n", - "optional": false + { + "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": "String", - "name": "id", - "doc": "The id to save the record under (defaults to the value of the record's getId() function)
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Proxy2.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js", - "linenr": 214, - "html_filename": "WebStorage.html", - "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-setRecord", - "shortDoc": "Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data
\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" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-setRecord", + "shortDoc": "Saves the given record in the Proxy. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js", + "private": false, + "params": [ + { + "type": "Ext.data.Model", + "optional": false, + "doc": "The model instance
\n", + "name": "record" + }, + { + "type": "String", + "optional": false, + "doc": "The id to save the record under (defaults to the value of the record's getId() function)
\n", + "name": "id" + } + ], + "name": "setRecord", + "owner": "Ext.data.proxy.WebStorage", + "doc": "Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data
\n", + "linenr": 211, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "WebStorage.html" }, - "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" + { + "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" + }, + "html_filename": "Proxy2.html" }, - "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 + { + "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": [ + + ], + "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 handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-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": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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 + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" }, - { - "type": "Function", - "name": "callback", - "doc": "Callback function to be called when the Operation has completed (whether successful or not)
\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "scope", - "doc": "Scope to execute the callback function in
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "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": [ - { - "tagname": "property", - "name": "cache", - "member": "Ext.data.proxy.WebStorage", - "type": "Object", - "doc": "Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js", - "linenr": 29, - "html_filename": "WebStorage.html", - "href": "WebStorage.html#Ext-data-proxy-WebStorage-property-cache" - } - ], - "event": [ + { + "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": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "WebStorage.html#Ext-data-proxy-WebStorage-property-cache", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js", + "private": false, + "name": "cache", + "owner": "Ext.data.proxy.WebStorage", + "doc": "Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved
\n", + "linenr": 26, + "html_filename": "WebStorage.html" + }, + { + "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 LocalStorageProxy uses the new HTML5 localStorage API to save Model data locally on\nthe client browser. HTML5 localStorage is a key-value store (e.g. cannot save complex objects like JSON), so\nLocalStorageProxy automatically serializes and deserializes data when saving and retrieving it.
\n\n\n\n\nlocalStorage is extremely useful for saving user-specific information without needing to build server-side \ninfrastructure to support it. Let's imagine we're writing a Twitter search application and want to save the user's\nsearches locally so they can easily perform a saved search again later. We'd start by creating a Search model:
\n\n\n\n\nExt.define('Search', {\n fields: ['id', 'query'],\n extend: 'Ext.data.Model',\n proxy: {\n type: 'localstorage',\n id : 'twitter-Searches'\n }\n});\nOur Search model contains just two fields - id and query - plus a Proxy definition. The only configuration we\nneed to pass to the LocalStorage proxy is an id. This is important as it separates the Model data in this\nProxy from all others. The localStorage API puts all data into a single shared namespace, so by setting an id we\nenable LocalStorageProxy to manage the saved Search data.
\n\n\n\n\nSaving our data into localStorage is easy and would usually be done with a Store:
\n\n\n\n\n//our Store automatically picks up the LocalStorageProxy defined on the Search model\nvar store = new Ext.data.Store({\n model: \"Search\"\n});\n\n//loads any existing Search data from localStorage\nstore.load();\n\n//now add some Searches\nstore.add({query: 'Sencha Touch'});\nstore.add({query: 'Ext JS'});\n\n//finally, save our Search data to localStorage\nstore.sync();\nThe LocalStorageProxy automatically gives our new Searches an id when we call store.sync(). It encodes the Model\ndata and places it into localStorage. We can also save directly to localStorage, bypassing the Store altogether:
\n\n\n\n\nvar search = Ext.ModelManager.create({query: 'Sencha Animator'}, 'Search');\n\n//uses the configured LocalStorageProxy to save the new Search to localStorage\nsearch.save();\nLimitations
\n\n\n\n\nIf this proxy is used in a browser where local storage is not supported, the constructor will throw an error.\nA local storage proxy requires a unique ID which is used as a key in which all record data are stored in the\nlocal storage object.
\n\n\n\n\nIt's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided\nbut the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will\nthrow an error.
\n\n", "mixedInto": [ ], - "allMixins": [ - "Ext.util.Observable" - ] + "linenr": 1, + "xtypes": [ + + ], + "html_filename": "LocalStorage.html", + "extends": "Ext.data.proxy.WebStorage" }); \ No newline at end of file