Ext.data.JsonP.Ext_grid_property_Store({
- "tagname": "class",
- "name": "Ext.grid.property.Store",
- "doc": "<p>A custom <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> for the <a href=\"#/api/Ext.grid.property.Grid\" rel=\"Ext.grid.property.Grid\" class=\"docClass\">Ext.grid.property.Grid</a>. This class handles the mapping\nbetween the custom data source objects supported by the grid and the <a href=\"#/api/Ext.grid.property.Property\" rel=\"Ext.grid.property.Property\" class=\"docClass\">Ext.grid.property.Property</a> format\nused by the <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> base class.</p>\n",
- "extends": "Ext.data.Store",
- "mixins": [
-
- ],
- "alternateClassNames": [
- "Ext.grid.PropertyStore"
+ "allMixins": [
+ "Ext.util.Observable",
+ "Ext.util.Sortable"
],
- "xtype": null,
- "author": null,
+ "deprecated": null,
"docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "autoLoad",
- "member": "Ext.data.AbstractStore",
- "type": "Boolean/Object",
- "doc": "<p>If data is not specified, and if autoLoad is true or an Object, this store's load method\nis automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's\nload method. Defaults to false.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 56,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoLoad",
- "shortDoc": "If data is not specified, and if autoLoad is true or an Object, this store's load method\nis automatically called afte..."
- },
- {
- "tagname": "cfg",
- "name": "autoSync",
- "member": "Ext.data.AbstractStore",
- "type": "Boolean",
- "doc": "<p>True to automatically sync the Store with its Proxy after every edit to one of its Records.\nDefaults to false.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 63,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoSync"
- },
- {
- "tagname": "cfg",
- "name": "buffered",
- "member": "Ext.data.Store",
- "type": "Boolean",
- "doc": "<p>Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will\ntell the store to pre-fetch records ahead of a time.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 305,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-buffered",
- "shortDoc": "Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will\ntell the..."
- },
- {
- "tagname": "cfg",
- "name": "clearOnPageLoad",
- "member": "Ext.data.Store",
- "type": "Boolean",
- "doc": "<p>True to empty the store when loading another page via <a href=\"#/api/Ext.grid.property.Store-method-loadPage\" rel=\"Ext.grid.property.Store-method-loadPage\" class=\"docClass\">loadPage</a>,\n<a href=\"#/api/Ext.grid.property.Store-method-nextPage\" rel=\"Ext.grid.property.Store-method-nextPage\" class=\"docClass\">nextPage</a> or <a href=\"#/api/Ext.grid.property.Store-method-previousPage\" rel=\"Ext.grid.property.Store-method-previousPage\" class=\"docClass\">previousPage</a> (defaults to true). Setting to false keeps existing records, allowing\nlarge data sets to be loaded one page at a time but rendered all together.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 284,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-clearOnPageLoad",
- "shortDoc": "True to empty the store when loading another page via loadPage,\nnextPage or previousPage (defaults to true). Setting ..."
- },
- {
- "tagname": "cfg",
- "name": "data",
- "member": "Ext.data.Store",
- "type": "Array",
- "doc": "<p>Optional array of Model instances or data objects to load locally. See \"Inline data\" above for details.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 246,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-data"
- },
- {
- "tagname": "cfg",
- "name": "fields",
- "member": "Ext.data.AbstractStore",
- "type": "Array",
- "doc": "<p>This may be used in place of specifying a <a href=\"#/api/Ext.grid.property.Store-cfg-model\" rel=\"Ext.grid.property.Store-cfg-model\" class=\"docClass\">model</a> configuration. The fields should be a\nset of <a href=\"#/api/Ext.data.Field\" rel=\"Ext.data.Field\" class=\"docClass\">Ext.data.Field</a> configuration objects. The store will automatically create a <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a>\nwith these fields. In general this configuration option should be avoided, it exists for the purposes of\nbackwards compatibility. For anything more complicated, such as specifying a particular id property or\nassocations, a <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> should be defined and specified for the <a href=\"#/api/Ext.grid.property.Store-cfg-model\" rel=\"Ext.grid.property.Store-cfg-model\" class=\"docClass\">model</a> config.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 126,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-fields",
- "shortDoc": "This may be used in place of specifying a model configuration. The fields should be a\nset of Ext.data.Field configura..."
- },
- {
- "tagname": "cfg",
- "name": "listeners",
- "member": "Ext.util.Observable",
- "type": "Object",
- "doc": "<p>(optional) <p>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\n<a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n</code></pre>\n\n\n<p></p></p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 103,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-cfg-listeners",
- "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..."
- },
- {
- "tagname": "cfg",
- "name": "model",
- "member": "Ext.data.Store",
- "type": "String",
- "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> associated with this store</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 250,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-model"
- },
- {
- "tagname": "cfg",
- "name": "pageSize",
- "member": "Ext.data.Store",
- "type": "Number",
- "doc": "<p>The number of records considered to form a 'page'. This is used to power the built-in\npaging using the nextPage and previousPage functions. Defaults to 25.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 270,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-pageSize",
- "shortDoc": "The number of records considered to form a 'page'. This is used to power the built-in\npaging using the nextPage and p..."
- },
- {
- "tagname": "cfg",
- "name": "proxy",
- "member": "Ext.data.Store",
- "type": "String/Ext.data.proxy.Proxy/Object",
- "doc": "<p>The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see <a href=\"#/api/Ext.grid.property.Store-method-setProxy\" rel=\"Ext.grid.property.Store-method-setProxy\" class=\"docClass\">setProxy</a> for details.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 241,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-proxy",
- "shortDoc": "The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see setProxy for ..."
- },
- {
- "tagname": "cfg",
- "name": "purgePageCount",
- "member": "Ext.data.Store",
- "type": "Number",
- "doc": "<p>The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the prefetched data.\nThis option is only relevant when the <a href=\"#/api/Ext.grid.property.Store-cfg-buffered\" rel=\"Ext.grid.property.Store-cfg-buffered\" class=\"docClass\">buffered</a> option is set to true.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 312,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-purgePageCount",
- "shortDoc": "The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the..."
- },
- {
- "tagname": "cfg",
- "name": "remoteFilter",
- "member": "Ext.data.Store",
- "type": "Boolean",
- "doc": "<p>True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to <tt>false</tt>.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 227,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-remoteFilter",
- "shortDoc": "True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to f..."
- },
- {
- "tagname": "cfg",
- "name": "remoteGroup",
- "member": "Ext.data.Store",
- "type": "Boolean",
- "doc": "<p>True if the grouping should apply on the server side, false if it is local only (defaults to false). If the\ngrouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a\nhelper, automatically sending the grouping information to the server.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 233,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-remoteGroup",
- "shortDoc": "True if the grouping should apply on the server side, false if it is local only (defaults to false). If the\ngrouping..."
- },
- {
- "tagname": "cfg",
- "name": "remoteSort",
- "member": "Ext.data.Store",
- "type": "Boolean",
- "doc": "<p>True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to <tt>false</tt>.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 221,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-remoteSort"
- },
- {
- "tagname": "cfg",
- "name": "sortOnFilter",
- "member": "Ext.data.Store",
- "type": "Boolean",
- "doc": "<p>For local filtering only, causes <a href=\"#/api/Ext.grid.property.Store-method-sort\" rel=\"Ext.grid.property.Store-method-sort\" class=\"docClass\">sort</a> to be called whenever <a href=\"#/api/Ext.grid.property.Store-method-filter\" rel=\"Ext.grid.property.Store-method-filter\" class=\"docClass\">filter</a> is called,\ncausing the sorters to be reapplied after filtering. Defaults to true</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 299,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-cfg-sortOnFilter",
- "shortDoc": "For local filtering only, causes sort to be called whenever filter is called,\ncausing the sorters to be reapplied aft..."
- },
- {
- "tagname": "cfg",
- "name": "storeId",
- "member": "Ext.data.AbstractStore",
- "type": "String",
- "doc": "<p>Optional unique identifier for this store. If present, this Store will be registered with\nthe <a href=\"#/api/Ext.data.StoreManager\" rel=\"Ext.data.StoreManager\" class=\"docClass\">Ext.data.StoreManager</a>, making it easy to reuse elsewhere. Defaults to undefined.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 121,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-storeId",
- "shortDoc": "Optional unique identifier for this store. If present, this Store will be registered with\nthe Ext.data.StoreManager, ..."
- }
- ],
- "method": [
- {
- "tagname": "method",
- "name": "Store",
- "member": "Ext.grid.property.Store",
- "doc": "\n",
- "params": [
- {
- "type": "Ext.grid.Grid",
- "name": "grid",
- "doc": "<p>The grid this store will be bound to</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "source",
- "doc": "<p>The source data config object</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/property/Store.js",
- "linenr": 1,
- "html_filename": "Store.html",
- "href": "Store.html#Ext-grid-property-Store-method-constructor",
- "shortDoc": "\n"
- },
- {
- "tagname": "method",
- "name": "add",
- "member": "Ext.data.Store",
- "doc": "<p>Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already-\ninstantiated Models, use <a href=\"#/api/Ext.grid.property.Store-method-insert\" rel=\"Ext.grid.property.Store-method-insert\" class=\"docClass\">insert</a> instead. The instances will be added at the end of the existing collection.\nThis method accepts either a single argument array of Model instances or any number of model instance arguments.\nSample usage:</p>\n\n<pre><code>myStore.add({some: 'data'}, {some: 'other data'});\n</code></pre>\n\n",
- "params": [
- {
- "type": "Object",
- "name": "data",
- "doc": "<p>The data for each model</p>\n",
- "optional": false
- }
- ],
- "return": {
+ "members": {
+ "cfg": [
+ {
+ "type": "Boolean/Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoLoad",
+ "shortDoc": "If data is not specified, and if autoLoad is true or an Object, this store's load method\nis automatically called afte...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "autoLoad",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>If data is not specified, and if autoLoad is true or an Object, this store's load method\nis automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's\nload method. Defaults to false.</p>\n",
+ "linenr": 54,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoSync",
+ "shortDoc": "True to automatically sync the Store with its Proxy after every edit to one of its Records. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "autoSync",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>True to automatically sync the Store with its Proxy after every edit to one of its Records.\nDefaults to false.</p>\n",
+ "linenr": 61,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-buffered",
+ "shortDoc": "Allow the store to buffer and pre-fetch pages of records. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "buffered",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will\ntell the store to pre-fetch records ahead of a time.</p>\n",
+ "linenr": 303,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-clearOnPageLoad",
+ "shortDoc": "True to empty the store when loading another page via loadPage,\nnextPage or previousPage (defaults to true). ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "clearOnPageLoad",
+ "owner": "Ext.data.Store",
+ "doc": "<p>True to empty the store when loading another page via <a href=\"#/api/Ext.grid.property.Store-method-loadPage\" rel=\"Ext.grid.property.Store-method-loadPage\" class=\"docClass\">loadPage</a>,\n<a href=\"#/api/Ext.grid.property.Store-method-nextPage\" rel=\"Ext.grid.property.Store-method-nextPage\" class=\"docClass\">nextPage</a> or <a href=\"#/api/Ext.grid.property.Store-method-previousPage\" rel=\"Ext.grid.property.Store-method-previousPage\" class=\"docClass\">previousPage</a> (defaults to true). Setting to false keeps existing records, allowing\nlarge data sets to be loaded one page at a time but rendered all together.</p>\n",
+ "linenr": 282,
+ "html_filename": "Store2.html"
+ },
+ {
"type": "Array",
- "doc": "<p>The array of newly created model instances</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 797,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-add",
- "shortDoc": "Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already-\ninstantiat..."
- },
- {
- "tagname": "method",
- "name": "addEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
- "params": [
- {
- "type": "Object/String",
- "name": "o",
- "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
- "optional": false
- },
- {
- "type": "String",
- "name": "",
- "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 452,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addEvents",
- "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
- },
- {
- "tagname": "method",
- "name": "addListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Appends an event handler to this object.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The method the event invokes.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
- "optional": true
- },
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\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<pre><code>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</code></pre>.\n<p>\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": "<p>Appends an event handler to this object.</p>\n"
- },
- {
- "tagname": "method",
- "name": "addManagedListener",
- "member": "Ext.util.Observable",
- "doc": "<p>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": "<p>The item to which to add a listener/listeners.</p>\n",
- "optional": false
- },
- {
- "type": "Object/String",
- "name": "ename",
- "doc": "<p>The event name, or an object containing event name properties.</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "opt",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 155,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
- "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
- },
- {
- "tagname": "method",
- "name": "aggregate",
- "member": "Ext.data.Store",
- "doc": "<p>Runs the aggregate function for all the records in the store.</p>\n",
- "params": [
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to execute. The function is called with a single parameter,\nan array of records for that group.</p>\n",
- "optional": false
- },
- {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-data",
+ "shortDoc": "Optional array of Model instances or data objects to load locally. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "data",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Optional array of Model instances or data objects to load locally. See \"Inline data\" above for details.</p>\n",
+ "linenr": 244,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Array",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-fields",
+ "shortDoc": "This may be used in place of specifying a model configuration. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "fields",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>This may be used in place of specifying a <a href=\"#/api/Ext.grid.property.Store-cfg-model\" rel=\"Ext.grid.property.Store-cfg-model\" class=\"docClass\">model</a> configuration. The fields should be a\nset of <a href=\"#/api/Ext.data.Field\" rel=\"Ext.data.Field\" class=\"docClass\">Ext.data.Field</a> configuration objects. The store will automatically create a <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a>\nwith these fields. In general this configuration option should be avoided, it exists for the purposes of\nbackwards compatibility. For anything more complicated, such as specifying a particular id property or\nassocations, a <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> should be defined and specified for the <a href=\"#/api/Ext.grid.property.Store-cfg-model\" rel=\"Ext.grid.property.Store-cfg-model\" class=\"docClass\">model</a> config.</p>\n",
+ "linenr": 124,
+ "html_filename": "AbstractStore.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": "<p>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 <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple\nhandlers at once.</p>\n\n<p><strong>DOM events from ExtJS <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></strong></p>\n\n<p>While <em>some</em> 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 <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s <strong><code><a href=\"#/api/Ext.view.View-event-itemclick\" rel=\"Ext.view.View-event-itemclick\" class=\"docClass\">itemclick</a></code></strong> event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the <code>element</code> option to identify the Component property to add a\nDOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n</code></pre>\n",
+ "linenr": 102,
+ "html_filename": "Observable.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-model",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "model",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> associated with this store</p>\n",
+ "linenr": 248,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Number",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-pageSize",
+ "shortDoc": "The number of records considered to form a 'page'. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "pageSize",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The number of records considered to form a 'page'. This is used to power the built-in\npaging using the nextPage and previousPage functions. Defaults to 25.</p>\n",
+ "linenr": 268,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "String/Ext.data.proxy.Proxy/Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-proxy",
+ "shortDoc": "The Proxy to use for this Store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "proxy",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see <a href=\"#/api/Ext.grid.property.Store-method-setProxy\" rel=\"Ext.grid.property.Store-method-setProxy\" class=\"docClass\">setProxy</a> for details.</p>\n",
+ "linenr": 239,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Number",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-purgePageCount",
+ "shortDoc": "The number of pages to keep in the cache before purging additional records. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "purgePageCount",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the prefetched data.\nThis option is only relevant when the <a href=\"#/api/Ext.grid.property.Store-cfg-buffered\" rel=\"Ext.grid.property.Store-cfg-buffered\" class=\"docClass\">buffered</a> option is set to true.</p>\n",
+ "linenr": 310,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-remoteFilter",
+ "shortDoc": "True to defer any filtering operation to the server. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "remoteFilter",
+ "owner": "Ext.data.Store",
+ "doc": "<p>True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to <tt>false</tt>.</p>\n",
+ "linenr": 225,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-remoteGroup",
+ "shortDoc": "True if the grouping should apply on the server side, false if it is local only (defaults to false). ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "remoteGroup",
+ "owner": "Ext.data.Store",
+ "doc": "<p>True if the grouping should apply on the server side, false if it is local only (defaults to false). If the\ngrouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a\nhelper, automatically sending the grouping information to the server.</p>\n",
+ "linenr": 231,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-remoteSort",
+ "shortDoc": "True to defer any sorting operation to the server. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "remoteSort",
+ "owner": "Ext.data.Store",
+ "doc": "<p>True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to <tt>false</tt>.</p>\n",
+ "linenr": 219,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Store2.html#Ext-data-Store-cfg-sortOnFilter",
+ "shortDoc": "For local filtering only, causes sort to be called whenever filter is called,\ncausing the sorters to be reapplied aft...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "sortOnFilter",
+ "owner": "Ext.data.Store",
+ "doc": "<p>For local filtering only, causes <a href=\"#/api/Ext.grid.property.Store-method-sort\" rel=\"Ext.grid.property.Store-method-sort\" class=\"docClass\">sort</a> to be called whenever <a href=\"#/api/Ext.grid.property.Store-method-filter\" rel=\"Ext.grid.property.Store-method-filter\" class=\"docClass\">filter</a> is called,\ncausing the sorters to be reapplied after filtering. Defaults to true</p>\n",
+ "linenr": 297,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-storeId",
+ "shortDoc": "Optional unique identifier for this store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "storeId",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Optional unique identifier for this store. If present, this Store will be registered with\nthe <a href=\"#/api/Ext.data.StoreManager\" rel=\"Ext.data.StoreManager\" class=\"docClass\">Ext.data.StoreManager</a>, making it easy to reuse elsewhere. Defaults to undefined.</p>\n",
+ "linenr": 119,
+ "html_filename": "AbstractStore.html"
+ }
+ ],
+ "method": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "href": "Store.html#Ext-grid-property-Store-method-constructor",
+ "tagname": "method",
+ "protected": false,
+ "shortDoc": "Creates new property store. ...",
+ "static": false,
+ "params": [
+ {
+ "type": "Ext.grid.Grid",
+ "optional": false,
+ "doc": "<p>The grid this store will be bound to</p>\n",
+ "name": "grid"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The source data config object</p>\n",
+ "name": "source"
+ }
+ ],
+ "private": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/property/Store.js",
+ "doc": "<p>Creates new property store.</p>\n",
+ "owner": "Ext.grid.property.Store",
+ "name": "Store",
+ "html_filename": "Store.html",
+ "return": {
"type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope to execute the function in. Defaults to the store.</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the group average being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- },
- {
+ "doc": "\n"
+ },
+ "linenr": 16
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-add",
+ "shortDoc": "Adds Model instances to the Store by instantiating them based on a JavaScript object. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The data for each model</p>\n",
+ "name": "data"
+ }
+ ],
+ "name": "add",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already-\ninstantiated Models, use <a href=\"#/api/Ext.grid.property.Store-method-insert\" rel=\"Ext.grid.property.Store-method-insert\" class=\"docClass\">insert</a> instead. The instances will be added at the end of the existing collection.\nThis method accepts either a single argument array of Model instances or any number of model instance arguments.\nSample usage:</p>\n\n<pre><code>myStore.add({some: 'data'}, {some: 'other data'});\n</code></pre>\n\n",
+ "linenr": 798,
+ "return": {
"type": "Array",
- "name": "args",
- "doc": "<p>(optional) Any arguments to append to the function call</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "Object",
- "doc": "<p>An object literal with the group names and their appropriate values.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 2124,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-aggregate",
- "shortDoc": "<p>Runs the aggregate function for all the records in the store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "average",
- "member": "Ext.data.Store",
- "doc": "<p>Gets the average value in the store.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "field",
- "doc": "<p>The field in each record</p>\n",
- "optional": false
- },
- {
- "type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the group average being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Mixed/undefined",
- "doc": "<p>The average value, if no items exist, 0.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 2091,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-average",
- "shortDoc": "<p>Gets the average value in the store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "capture",
- "member": "Ext.util.Observable",
- "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
- "params": [
- {
- "type": "Observable",
- "name": "o",
- "doc": "<p>The Observable to capture events from.</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to call when an event is fired.</p>\n",
- "optional": false
- },
- {
+ "doc": "<p>The array of newly created model instances</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addEvents",
+ "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>Either an object with event names as properties with a value of <code>true</code> or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:</p>\n\n<pre><code>this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n</code></pre>\n",
+ "name": "o"
+ },
+ {
+ "type": "String...",
+ "optional": false,
+ "doc": "<p>Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n",
+ "name": "more"
+ }
+ ],
+ "name": "addEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
+ "linenr": 494,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The method the event invokes. Will be called with arguments given to\n<a href=\"#/api/Ext.grid.property.Store-method-fireEvent\" rel=\"Ext.grid.property.Store-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\n<pre><code>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</code></pre>\n\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
+ "name": "options"
+ }
+ ],
+ "name": "addListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Appends an event handler to this object.</p>\n",
+ "linenr": 278,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>The item to which to add a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
+ "name": "opt"
+ }
+ ],
+ "name": "addManagedListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
+ "linenr": 156,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.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});\n</code></pre>\n",
+ "linenr": 388,
+ "return": {
+ "type": "Ext.Base",
+ "doc": "<p>this</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-aggregate",
+ "shortDoc": "Runs the aggregate function for all the records in the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to execute. The function is called with a single parameter,\nan array of records for that group.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope to execute the function in. Defaults to the store.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the group average being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ },
+ {
+ "type": "Array",
+ "optional": true,
+ "doc": "<p>(optional) Any arguments to append to the function call</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "aggregate",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Runs the aggregate function for all the records in the store.</p>\n",
+ "linenr": 2125,
+ "return": {
"type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 55,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-capture",
- "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
- },
- {
- "tagname": "method",
- "name": "clearFilter",
- "member": "Ext.data.Store",
- "doc": "<p>Revert to a view of the Record cache with no filtering applied.</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "suppressEvent",
- "doc": "<p>If <tt>true</tt> the filter is cleared silently without firing the\n<a href=\"#/api/Ext.grid.property.Store-event-datachanged\" rel=\"Ext.grid.property.Store-event-datachanged\" class=\"docClass\">datachanged</a> event.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1157,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-clearFilter",
- "shortDoc": "<p>Revert to a view of the Record cache with no filtering applied.</p>\n"
- },
- {
- "tagname": "method",
- "name": "clearGrouping",
- "member": "Ext.data.Store",
- "doc": "<p>Clear any groupers in the store</p>\n",
- "params": [
+ "doc": "<p>An object literal with the group names and their appropriate values.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-average",
+ "shortDoc": "Gets the average value in the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The field in each record</p>\n",
+ "name": "field"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the group average being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "average",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Gets the average value in the store.</p>\n",
+ "linenr": 2092,
+ "return": {
+ "type": "Mixed/undefined",
+ "doc": "<p>The average value, if no items exist, 0.</p>\n"
+ },
+ "html_filename": "Store2.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": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "callOverridden",
+ "owner": "Ext.Base",
+ "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.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\"\n</code></pre>\n",
+ "linenr": 269,
+ "return": {
+ "type": "Mixed",
+ "doc": "<p>Returns the result after calling the overridden method</p>\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": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "callParent",
+ "owner": "Ext.Base",
+ "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.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'\n</code></pre>\n",
+ "linenr": 124,
+ "return": {
+ "type": "Mixed",
+ "doc": "<p>Returns the result from the superclass' method</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-capture",
+ "shortDoc": "Starts capture on the specified Observable. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable",
+ "optional": false,
+ "doc": "<p>The Observable to capture events from.</p>\n",
+ "name": "o"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to call when an event is fired.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "capture",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event <strong>before</strong> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
+ "linenr": 54,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-clearFilter",
+ "shortDoc": "Revert to a view of the Record cache with no filtering applied. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>If <tt>true</tt> the filter is cleared silently without firing the\n<a href=\"#/api/Ext.grid.property.Store-event-datachanged\" rel=\"Ext.grid.property.Store-event-datachanged\" class=\"docClass\">datachanged</a> event.</p>\n",
+ "name": "suppressEvent"
+ }
+ ],
+ "name": "clearFilter",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Revert to a view of the Record cache with no filtering applied.</p>\n",
+ "linenr": 1158,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-clearGrouping",
+ "shortDoc": "Clear any groupers in the store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 531,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-clearGrouping",
- "shortDoc": "<p>Clear any groupers in the store</p>\n"
- },
- {
- "tagname": "method",
- "name": "clearListeners",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
- "params": [
+ ],
+ "name": "clearGrouping",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Clear any groupers in the store</p>\n",
+ "linenr": 532,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.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": "<p>Removes all listeners for this object including the managed listeners</p>\n"
- },
- {
- "tagname": "method",
- "name": "clearManagedListeners",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes all managed listeners for this object.</p>\n",
- "params": [
+ ],
+ "name": "clearListeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes all listeners for this object including the managed listeners</p>\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": "<p>Removes all managed listeners for this object.</p>\n"
- },
- {
- "tagname": "method",
- "name": "collect",
- "member": "Ext.data.Store",
- "doc": "<p>Collects unique values for a particular dataIndex from this store.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "dataIndex",
- "doc": "<p>The property to collect</p>\n",
- "optional": false
- },
- {
- "type": "Boolean",
- "name": "allowNull",
- "doc": "<p>(optional) Pass true to allow null, undefined or empty string values</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "bypassFilter",
- "doc": "<p>(optional) Pass true to collect from all records, even ones which are filtered</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "Array",
- "doc": "<p>An array of the unique values</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1806,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-collect",
- "shortDoc": "<p>Collects unique values for a particular dataIndex from this store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "count",
- "member": "Ext.data.Store",
- "doc": "<p>Gets the count of items in the store.</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the count for each group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>the count</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1994,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-count",
- "shortDoc": "<p>Gets the count of items in the store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "each",
- "member": "Ext.data.Store",
- "doc": "<p>Calls the specified function for each of the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Records</a> in the cache.</p>\n",
- "params": [
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to call. The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Record</a> is passed as the first parameter.\nReturning <tt>false</tt> aborts and exits the iteration.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed.\nDefaults to the current <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Record</a> in the iteration.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 846,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-each",
- "shortDoc": "<p>Calls the specified function for each of the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Records</a> in the cache.</p>\n"
- },
- {
- "tagname": "method",
- "name": "enableBubble",
- "member": "Ext.util.Observable",
- "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\n</code></pre>\n\n",
- "params": [
- {
- "type": "String/Array",
- "name": "events",
- "doc": "<p>The event name to bubble, or an Array of event names.</p>\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": "filter",
- "member": "Ext.data.Store",
- "doc": "<p>Filters the loaded set of records by a given set of filters.</p>\n",
- "params": [
- {
- "type": "Mixed",
- "name": "filters",
- "doc": "<p>The set of filters to apply to the data. These are stored internally on the store,\nbut the filtering itself is done on the Store's <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">MixedCollection</a>. See\nMixedCollection's <a href=\"#/api/Ext.util.MixedCollection-method-filter\" rel=\"Ext.util.MixedCollection-method-filter\" class=\"docClass\">filter</a> method for filter syntax. Alternatively,\npass in a property string</p>\n",
- "optional": false
- },
- {
- "type": "String",
- "name": "value",
- "doc": "<p>Optional value to filter by (only if using a property string as the first argument)</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1106,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-filter",
- "shortDoc": "<p>Filters the loaded set of records by a given set of filters.</p>\n"
- },
- {
- "tagname": "method",
- "name": "filterBy",
- "member": "Ext.data.Store",
- "doc": "<p>Filter by a function. The specified function will be called for each\nRecord in this Store. If the function returns <tt>true</tt> the Record is included,\notherwise it is filtered out.</p>\n",
- "params": [
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to be called. It will be passed the following parameters:<ul>\n<li><b>record</b> : Ext.data.Model<p class=\"sub-desc\">The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a>\nto test for filtering. Access field values using <a href=\"#/api/Ext.data.Model-method-get\" rel=\"Ext.data.Model-method-get\" class=\"docClass\">Ext.data.Model.get</a>.</p></li>\n<li><b>id</b> : Object<p class=\"sub-desc\">The ID of the Record passed.</p></li>\n</ul></p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1188,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-filterBy",
- "shortDoc": "Filter by a function. The specified function will be called for each\nRecord in this Store. If the function returns tr..."
- },
- {
- "tagname": "method",
- "name": "find",
- "member": "Ext.data.Store",
- "doc": "<p>Finds the index of the first matching Record in this store by a specific field value.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "fieldName",
- "doc": "<p>The name of the Record field to test.</p>\n",
- "optional": false
- },
- {
- "type": "String/RegExp",
- "name": "value",
- "doc": "<p>Either a string that the field value\nshould begin with, or a RegExp to test against the field.</p>\n",
- "optional": false
- },
- {
+ ],
+ "name": "clearManagedListeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes all managed listeners for this object.</p>\n",
+ "linenr": 454,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-collect",
+ "shortDoc": "Collects unique values for a particular dataIndex from this store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The property to collect</p>\n",
+ "name": "dataIndex"
+ },
+ {
+ "type": "Boolean",
+ "optional": true,
+ "doc": "<p>(optional) Pass true to allow null, undefined or empty string values</p>\n",
+ "name": "allowNull"
+ },
+ {
+ "type": "Boolean",
+ "optional": true,
+ "doc": "<p>(optional) Pass true to collect from all records, even ones which are filtered</p>\n",
+ "name": "bypassFilter"
+ }
+ ],
+ "name": "collect",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Collects unique values for a particular dataIndex from this store.</p>\n",
+ "linenr": 1807,
+ "return": {
+ "type": "Array",
+ "doc": "<p>An array of the unique values</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-count",
+ "shortDoc": "Gets the count of items in the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the count for each group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "count",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Gets the count of items in the store.</p>\n",
+ "linenr": 1995,
+ "return": {
"type": "Number",
- "name": "startIndex",
- "doc": "<p>(optional) The index to start searching at</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "anyMatch",
- "doc": "<p>(optional) True to match any part of the string, not just the beginning</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "caseSensitive",
- "doc": "<p>(optional) True for case sensitive comparison</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "exactMatch",
- "doc": "<p>True to force exact match (^ and $ characters added to the regex). Defaults to false.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The matched index or -1</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1722,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-find",
- "shortDoc": "<p>Finds the index of the first matching Record in this store by a specific field value.</p>\n"
- },
- {
- "tagname": "method",
- "name": "findBy",
- "member": "Ext.data.Store",
- "doc": "<p>Find the index of the first matching Record in this Store by a function.\nIf the function returns <tt>true</tt> it is considered a match.</p>\n",
- "params": [
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to be called. It will be passed the following parameters:<ul>\n<li><b>record</b> : Ext.data.Model<p class=\"sub-desc\">The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a>\nto test for filtering. Access field values using <a href=\"#/api/Ext.data.Model-method-get\" rel=\"Ext.data.Model-method-get\" class=\"docClass\">Ext.data.Model.get</a>.</p></li>\n<li><b>id</b> : Object<p class=\"sub-desc\">The ID of the Record passed.</p></li>\n</ul></p>\n",
- "optional": false
- },
- {
+ "doc": "<p>the count</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-create",
+ "shortDoc": "Create a new instance of this Class. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "create",
+ "owner": "Ext.Base",
+ "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
+ "linenr": 329,
+ "return": {
"type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>\n",
- "optional": true
- },
- {
+ "doc": "<p>the created instance.</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-createAlias",
+ "shortDoc": "Create aliases for existing prototype methods. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String/Object",
+ "optional": false,
+ "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
+ "name": "alias"
+ },
+ {
+ "type": "String/Object",
+ "optional": false,
+ "doc": "<p>The original method name</p>\n",
+ "name": "origin"
+ }
+ ],
+ "name": "createAlias",
+ "owner": "Ext.Base",
+ "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.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()\n</code></pre>\n",
+ "linenr": 648,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-each",
+ "shortDoc": "Calls the specified function for each of the Records in the cache. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to call. The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Record</a> is passed as the first parameter.\nReturning <tt>false</tt> aborts and exits the iteration.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed.\nDefaults to the current <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Record</a> in the iteration.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "each",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Calls the specified function for each of the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Records</a> in the cache.</p>\n",
+ "linenr": 847,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.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": "<p>The event name to bubble, or an Array of event names.</p>\n",
+ "name": "events"
+ }
+ ],
+ "name": "enableBubble",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling <code>this.getBubbleTarget()</code> if\npresent. There is no implementation in the Observable base class.</p>\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers.\nSee <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default implementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.</p>\n\n<p>Example:</p>\n\n<pre><code>Ext.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});\n</code></pre>\n",
+ "linenr": 609,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-filter",
+ "shortDoc": "Filters the loaded set of records by a given set of filters. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Mixed",
+ "optional": false,
+ "doc": "<p>The set of filters to apply to the data. These are stored internally on the store,\nbut the filtering itself is done on the Store's <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">MixedCollection</a>. See\nMixedCollection's <a href=\"#/api/Ext.util.MixedCollection-method-filter\" rel=\"Ext.util.MixedCollection-method-filter\" class=\"docClass\">filter</a> method for filter syntax. Alternatively,\npass in a property string</p>\n",
+ "name": "filters"
+ },
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>Optional value to filter by (only if using a property string as the first argument)</p>\n",
+ "name": "value"
+ }
+ ],
+ "name": "filter",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Filters the loaded set of records by a given set of filters.</p>\n",
+ "linenr": 1107,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-filterBy",
+ "shortDoc": "Filter by a function. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to be called. It will be passed the following parameters:<ul>\n<li><b>record</b> : Ext.data.Model<p class=\"sub-desc\">The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a>\nto test for filtering. Access field values using <a href=\"#/api/Ext.data.Model-method-get\" rel=\"Ext.data.Model-method-get\" class=\"docClass\">Ext.data.Model.get</a>.</p></li>\n<li><b>id</b> : Object<p class=\"sub-desc\">The ID of the Record passed.</p></li>\n</ul></p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "filterBy",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Filter by a function. The specified function will be called for each\nRecord in this Store. If the function returns <tt>true</tt> the Record is included,\notherwise it is filtered out.</p>\n",
+ "linenr": 1189,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-find",
+ "shortDoc": "Finds the index of the first matching Record in this store by a specific field value. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the Record field to test.</p>\n",
+ "name": "fieldName"
+ },
+ {
+ "type": "String/RegExp",
+ "optional": false,
+ "doc": "<p>Either a string that the field value\nshould begin with, or a RegExp to test against the field.</p>\n",
+ "name": "value"
+ },
+ {
+ "type": "Number",
+ "optional": true,
+ "doc": "<p>(optional) The index to start searching at</p>\n",
+ "name": "startIndex"
+ },
+ {
+ "type": "Boolean",
+ "optional": true,
+ "doc": "<p>(optional) True to match any part of the string, not just the beginning</p>\n",
+ "name": "anyMatch"
+ },
+ {
+ "type": "Boolean",
+ "optional": true,
+ "doc": "<p>(optional) True for case sensitive comparison</p>\n",
+ "name": "caseSensitive"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>True to force exact match (^ and $ characters added to the regex). Defaults to false.</p>\n",
+ "name": "exactMatch"
+ }
+ ],
+ "name": "find",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Finds the index of the first matching Record in this store by a specific field value.</p>\n",
+ "linenr": 1723,
+ "return": {
"type": "Number",
- "name": "startIndex",
- "doc": "<p>(optional) The index to start searching at</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The matched index or -1</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1790,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-findBy",
- "shortDoc": "Find the index of the first matching Record in this Store by a function.\nIf the function returns true it is considere..."
- },
- {
- "tagname": "method",
- "name": "findExact",
- "member": "Ext.data.Store",
- "doc": "<p>Finds the index of the first matching Record in this store by a specific field value.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "fieldName",
- "doc": "<p>The name of the Record field to test.</p>\n",
- "optional": false
- },
- {
- "type": "Mixed",
- "name": "value",
- "doc": "<p>The value to match the field against.</p>\n",
- "optional": false
- },
- {
+ "doc": "<p>The matched index or -1</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-findBy",
+ "shortDoc": "Find the index of the first matching Record in this Store by a function. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to be called. It will be passed the following parameters:<ul>\n<li><b>record</b> : Ext.data.Model<p class=\"sub-desc\">The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a>\nto test for filtering. Access field values using <a href=\"#/api/Ext.data.Model-method-get\" rel=\"Ext.data.Model-method-get\" class=\"docClass\">Ext.data.Model.get</a>.</p></li>\n<li><b>id</b> : Object<p class=\"sub-desc\">The ID of the Record passed.</p></li>\n</ul></p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Number",
+ "optional": true,
+ "doc": "<p>(optional) The index to start searching at</p>\n",
+ "name": "startIndex"
+ }
+ ],
+ "name": "findBy",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Find the index of the first matching Record in this Store by a function.\nIf the function returns <tt>true</tt> it is considered a match.</p>\n",
+ "linenr": 1791,
+ "return": {
"type": "Number",
- "name": "startIndex",
- "doc": "<p>(optional) The index to start searching at</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The matched index or -1</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1776,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-findExact",
- "shortDoc": "<p>Finds the index of the first matching Record in this store by a specific field value.</p>\n"
- },
- {
- "tagname": "method",
- "name": "findRecord",
- "member": "Ext.data.Store",
- "doc": "<p>Finds the first matching Record in this store by a specific field value.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "fieldName",
- "doc": "<p>The name of the Record field to test.</p>\n",
- "optional": false
- },
- {
- "type": "String/RegExp",
- "name": "value",
- "doc": "<p>Either a string that the field value\nshould begin with, or a RegExp to test against the field.</p>\n",
- "optional": false
- },
- {
+ "doc": "<p>The matched index or -1</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-findExact",
+ "shortDoc": "Finds the index of the first matching Record in this store by a specific field value. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the Record field to test.</p>\n",
+ "name": "fieldName"
+ },
+ {
+ "type": "Mixed",
+ "optional": false,
+ "doc": "<p>The value to match the field against.</p>\n",
+ "name": "value"
+ },
+ {
+ "type": "Number",
+ "optional": true,
+ "doc": "<p>(optional) The index to start searching at</p>\n",
+ "name": "startIndex"
+ }
+ ],
+ "name": "findExact",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Finds the index of the first matching Record in this store by a specific field value.</p>\n",
+ "linenr": 1777,
+ "return": {
"type": "Number",
- "name": "startIndex",
- "doc": "<p>(optional) The index to start searching at</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "anyMatch",
- "doc": "<p>(optional) True to match any part of the string, not just the beginning</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "caseSensitive",
- "doc": "<p>(optional) True for case sensitive comparison</p>\n",
- "optional": true
- },
- {
- "type": "Boolean",
- "name": "exactMatch",
- "doc": "<p>True to force exact match (^ and $ characters added to the regex). Defaults to false.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.data.Model",
- "doc": "<p>The matched record or null</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1738,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-findRecord",
- "shortDoc": "<p>Finds the first matching Record in this store by a specific field value.</p>\n"
- },
- {
- "tagname": "method",
- "name": "fireEvent",
- "member": "Ext.util.Observable",
- "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.grid.property.Store-method-enableBubble\" rel=\"Ext.grid.property.Store-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to fire.</p>\n",
- "optional": false
- },
- {
- "type": "Object...",
- "name": "args",
- "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\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": "first",
- "member": "Ext.data.Store",
- "doc": "<p>Convenience function for getting the first model instance in the store</p>\n",
- "params": [
- {
+ "doc": "<p>The matched index or -1</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-findRecord",
+ "shortDoc": "Finds the first matching Record in this store by a specific field value. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the Record field to test.</p>\n",
+ "name": "fieldName"
+ },
+ {
+ "type": "String/RegExp",
+ "optional": false,
+ "doc": "<p>Either a string that the field value\nshould begin with, or a RegExp to test against the field.</p>\n",
+ "name": "value"
+ },
+ {
+ "type": "Number",
+ "optional": true,
+ "doc": "<p>(optional) The index to start searching at</p>\n",
+ "name": "startIndex"
+ },
+ {
+ "type": "Boolean",
+ "optional": true,
+ "doc": "<p>(optional) True to match any part of the string, not just the beginning</p>\n",
+ "name": "anyMatch"
+ },
+ {
+ "type": "Boolean",
+ "optional": true,
+ "doc": "<p>(optional) True for case sensitive comparison</p>\n",
+ "name": "caseSensitive"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>True to force exact match (^ and $ characters added to the regex). Defaults to false.</p>\n",
+ "name": "exactMatch"
+ }
+ ],
+ "name": "findRecord",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Finds the first matching Record in this store by a specific field value.</p>\n",
+ "linenr": 1739,
+ "return": {
+ "type": "Ext.data.Model",
+ "doc": "<p>The matched record or null</p>\n"
+ },
+ "html_filename": "Store2.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": "<p>The name of the event to fire.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Object...",
+ "optional": false,
+ "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "fireEvent",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Fires the specified event with the passed parameters (minus the event name, plus the <code>options</code> object passed\nto <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a>).</p>\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>) by\ncalling <a href=\"#/api/Ext.grid.property.Store-method-enableBubble\" rel=\"Ext.grid.property.Store-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
+ "linenr": 233,
+ "return": {
"type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the first record being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.data.Model/undefined",
- "doc": "<p>The first model instance in the store, or undefined</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1920,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-first",
- "shortDoc": "<p>Convenience function for getting the first model instance in the store</p>\n"
- },
- {
- "tagname": "method",
- "name": "getAt",
- "member": "Ext.data.Store",
- "doc": "<p>Get the Record at the specified index.</p>\n",
- "params": [
- {
- "type": "Number",
- "name": "index",
- "doc": "<p>The index of the Record to find.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.data.Model",
- "doc": "<p>The Record at the passed index. Returns undefined if not found.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1842,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getAt",
- "shortDoc": "<p>Get the Record at the specified index.</p>\n"
- },
- {
- "tagname": "method",
- "name": "getById",
- "member": "Ext.data.Store",
- "doc": "<p>Get the Record with the specified id.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "id",
- "doc": "<p>The id of the Record to find.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.data.Model",
- "doc": "<p>The Record with the passed id. Returns undefined if not found.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1861,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getById",
- "shortDoc": "<p>Get the Record with the specified id.</p>\n"
- },
- {
- "tagname": "method",
- "name": "getCount",
- "member": "Ext.data.Store",
- "doc": "<p>Gets the number of cached records.</p>\n\n<p>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the <a href=\"#/api/Ext.grid.property.Store-method-getTotalCount\" rel=\"Ext.grid.property.Store-method-getTotalCount\" class=\"docClass\">getTotalCount</a> function returns\nthe dataset size. <b>Note</b>: see the Important note in <a href=\"#/api/Ext.grid.property.Store-event-load\" rel=\"Ext.grid.property.Store-event-load\" class=\"docClass\">load</a>.</p>\n\n",
- "params": [
-
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The number of Records in the Store's cache.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1820,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getCount",
- "shortDoc": "Gets the number of cached records.\n\nIf using paging, this may not be the total size of the dataset. If the data objec..."
- },
- {
- "tagname": "method",
- "name": "getGroupString",
- "member": "Ext.data.Store",
- "doc": "<p>Returns the string to group on for a given model instance. The default implementation of this method returns\nthe model's <a href=\"#/api/Ext.grid.property.Store-property-groupField\" rel=\"Ext.grid.property.Store-property-groupField\" class=\"docClass\">groupField</a>, but this can be overridden to group by an arbitrary string. For example, to\ngroup by the first letter of a model's 'name' field, use the following code:</p>\n\n\n<pre><code>new Ext.data.Store({\n groupDir: 'ASC',\n getGroupString: function(instance) {\n return instance.get('name')[0];\n }\n});\n</code></pre>\n\n",
- "params": [
- {
+ "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-first",
+ "shortDoc": "Convenience function for getting the first model instance in the store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the first record being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "first",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Convenience function for getting the first model instance in the store</p>\n",
+ "linenr": 1921,
+ "return": {
+ "type": "Ext.data.Model/undefined",
+ "doc": "<p>The first model instance in the store, or undefined</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getAt",
+ "shortDoc": "Get the Record at the specified index. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The index of the Record to find.</p>\n",
+ "name": "index"
+ }
+ ],
+ "name": "getAt",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Get the Record at the specified index.</p>\n",
+ "linenr": 1843,
+ "return": {
"type": "Ext.data.Model",
- "name": "instance",
- "doc": "<p>The model instance</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "String",
- "doc": "<p>The string to compare when forming groups</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 738,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getGroupString",
- "shortDoc": "Returns the string to group on for a given model instance. The default implementation of this method returns\nthe mode..."
- },
- {
- "tagname": "method",
- "name": "getGroups",
- "member": "Ext.data.Store",
- "doc": "<p>Returns an object containing the result of applying grouping to the records in this store. See <a href=\"#/api/Ext.grid.property.Store-property-groupField\" rel=\"Ext.grid.property.Store-property-groupField\" class=\"docClass\">groupField</a>,\n<a href=\"#/api/Ext.grid.property.Store-property-groupDir\" rel=\"Ext.grid.property.Store-property-groupDir\" class=\"docClass\">groupDir</a> and <a href=\"#/api/Ext.grid.property.Store-method-getGroupString\" rel=\"Ext.grid.property.Store-method-getGroupString\" class=\"docClass\">getGroupString</a>. Example for a store containing records with a color field:</p>\n\n<pre><code>var myStore = new Ext.data.Store({\n groupField: 'color',\n groupDir : 'DESC'\n});\n\nmyStore.getGroups(); //returns:\n[\n {\n name: 'yellow',\n children: [\n //all records where the color field is 'yellow'\n ]\n },\n {\n name: 'red',\n children: [\n //all records where the color field is 'red'\n ]\n }\n]\n</code></pre>\n\n",
- "params": [
- {
- "type": "String",
- "name": "groupName",
- "doc": "<p>(Optional) Pass in an optional groupName argument to access a specific group as defined by <a href=\"#/api/Ext.grid.property.Store-method-getGroupString\" rel=\"Ext.grid.property.Store-method-getGroupString\" class=\"docClass\">getGroupString</a></p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Array",
- "doc": "<p>The grouped data</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 569,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getGroups",
- "shortDoc": "Returns an object containing the result of applying grouping to the records in this store. See groupField,\ngroupDir a..."
- },
- {
- "tagname": "method",
- "name": "getNewRecords",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not\nyet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "Array",
- "doc": "<p>The Model instances</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 452,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-getNewRecords",
- "shortDoc": "Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not\nyet bee..."
- },
- {
- "tagname": "method",
- "name": "getPageFromRecordIndex",
- "member": "Ext.data.Store",
- "doc": "<p>Determines the page from a record index</p>\n",
- "params": [
- {
- "type": "Number",
- "name": "index",
- "doc": "<p>The record index</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The page the record belongs to</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1522,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getPageFromRecordIndex",
- "shortDoc": "<p>Determines the page from a record index</p>\n"
- },
- {
- "tagname": "method",
- "name": "getProxy",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Returns the proxy currently attached to this proxy instance</p>\n",
- "params": [
+ "doc": "<p>The Record at the passed index. Returns undefined if not found.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getById",
+ "shortDoc": "Get the Record with the specified id. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The id of the Record to find.</p>\n",
+ "name": "id"
+ }
+ ],
+ "name": "getById",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Get the Record with the specified id.</p>\n",
+ "linenr": 1862,
+ "return": {
+ "type": "Ext.data.Model",
+ "doc": "<p>The Record with the passed id. Returns undefined if not found.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getCount",
+ "shortDoc": "Gets the number of cached records. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "Ext.data.proxy.Proxy",
- "doc": "<p>The Proxy instance</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 307,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-getProxy",
- "shortDoc": "<p>Returns the proxy currently attached to this proxy instance</p>\n"
- },
- {
- "tagname": "method",
- "name": "getRange",
- "member": "Ext.data.Store",
- "doc": "<p>Returns a range of Records between specified indices.</p>\n",
- "params": [
- {
- "type": "Number",
- "name": "startIndex",
- "doc": "<p>(optional) The starting index (defaults to 0)</p>\n",
- "optional": true
- },
- {
+ ],
+ "name": "getCount",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Gets the number of cached records.</p>\n\n<p>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the <a href=\"#/api/Ext.grid.property.Store-method-getTotalCount\" rel=\"Ext.grid.property.Store-method-getTotalCount\" class=\"docClass\">getTotalCount</a> function returns\nthe dataset size. <b>Note</b>: see the Important note in <a href=\"#/api/Ext.grid.property.Store-event-load\" rel=\"Ext.grid.property.Store-event-load\" class=\"docClass\">load</a>.</p>\n\n",
+ "linenr": 1821,
+ "return": {
"type": "Number",
- "name": "endIndex",
- "doc": "<p>(optional) The ending index (defaults to the last Record in the Store)</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "Ext.data.Model[]",
- "doc": "<p>An array of Records</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1851,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getRange",
- "shortDoc": "<p>Returns a range of Records between specified indices.</p>\n"
- },
- {
- "tagname": "method",
- "name": "getRemovedRecords",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Returns any records that have been removed from the store but not yet destroyed on the proxy.</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "Array",
- "doc": "<p>The removed Model instances</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 478,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-getRemovedRecords",
- "shortDoc": "<p>Returns any records that have been removed from the store but not yet destroyed on the proxy.</p>\n"
- },
- {
- "tagname": "method",
- "name": "getTotalCount",
- "member": "Ext.data.Store",
- "doc": "<p>Returns the total number of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a> instances that the <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Proxy</a>\nindicates exist. This will usually differ from <a href=\"#/api/Ext.grid.property.Store-method-getCount\" rel=\"Ext.grid.property.Store-method-getCount\" class=\"docClass\">getCount</a> when using paging - getCount returns the\nnumber of records loaded into the Store at the moment, getTotalCount returns the number of records that\ncould be loaded into the Store if the Store contained all data</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The total number of Model instances available via the Proxy</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1831,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-getTotalCount",
- "shortDoc": "Returns the total number of Model instances that the Proxy\nindicates exist. This will usually differ from getCount wh..."
- },
- {
- "tagname": "method",
- "name": "getUpdatedRecords",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "Array",
- "doc": "<p>The updated Model instances</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 461,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-getUpdatedRecords",
- "shortDoc": "<p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>\n"
- },
- {
- "tagname": "method",
- "name": "group",
- "member": "Ext.data.Store",
- "doc": "<p>Group data in the store</p>\n",
- "params": [
- {
- "type": "String|Array",
- "name": "groupers",
- "doc": "<p>Either a string name of one of the fields in this Store's configured <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>,\nor an Array of grouper configurations.</p>\n",
- "optional": false
- },
- {
+ "doc": "<p>The number of Records in the Store's cache.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getGroupString",
+ "shortDoc": "Returns the string to group on for a given model instance. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Model",
+ "optional": false,
+ "doc": "<p>The model instance</p>\n",
+ "name": "instance"
+ }
+ ],
+ "name": "getGroupString",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Returns the string to group on for a given model instance. The default implementation of this method returns\nthe model's <a href=\"#/api/Ext.grid.property.Store-property-groupField\" rel=\"Ext.grid.property.Store-property-groupField\" class=\"docClass\">groupField</a>, but this can be overridden to group by an arbitrary string. For example, to\ngroup by the first letter of a model's 'name' field, use the following code:</p>\n\n\n<pre><code>new Ext.data.Store({\n groupDir: 'ASC',\n getGroupString: function(instance) {\n return instance.get('name')[0];\n }\n});\n</code></pre>\n\n",
+ "linenr": 739,
+ "return": {
"type": "String",
- "name": "direction",
- "doc": "<p>The overall direction to group the data by. Defaults to \"ASC\".</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 483,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-group",
- "shortDoc": "<p>Group data in the store</p>\n"
- },
- {
- "tagname": "method",
- "name": "guaranteeRange",
- "member": "Ext.data.Store",
- "doc": "<p>Guarantee a specific range, this will load the store with a range (that\nmust be the pageSize or smaller) and take care of any loading that may\nbe necessary.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "start",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "end",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "cb",
- "doc": "\n",
- "optional": false
- },
- {
- "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/Store.js",
- "linenr": 1600,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-guaranteeRange",
- "shortDoc": "Guarantee a specific range, this will load the store with a range (that\nmust be the pageSize or smaller) and take car..."
- },
- {
- "tagname": "method",
- "name": "hasListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to check for</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>True if the event is being listened for, else false</p>\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": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
- },
- {
- "tagname": "method",
- "name": "hasPendingRequests",
- "member": "Ext.data.Store",
- "doc": "<p>Returns the number of pending requests out.</p>\n",
- "params": [
+ "doc": "<p>The string to compare when forming groups</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getGroups",
+ "shortDoc": "Returns an object containing the result of applying grouping to the records in this store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>(Optional) Pass in an optional groupName argument to access a specific group as defined by <a href=\"#/api/Ext.grid.property.Store-method-getGroupString\" rel=\"Ext.grid.property.Store-method-getGroupString\" class=\"docClass\">getGroupString</a></p>\n",
+ "name": "groupName"
+ }
+ ],
+ "name": "getGroups",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Returns an object containing the result of applying grouping to the records in this store. See <a href=\"#/api/Ext.grid.property.Store-property-groupField\" rel=\"Ext.grid.property.Store-property-groupField\" class=\"docClass\">groupField</a>,\n<a href=\"#/api/Ext.grid.property.Store-property-groupDir\" rel=\"Ext.grid.property.Store-property-groupDir\" class=\"docClass\">groupDir</a> and <a href=\"#/api/Ext.grid.property.Store-method-getGroupString\" rel=\"Ext.grid.property.Store-method-getGroupString\" class=\"docClass\">getGroupString</a>. Example for a store containing records with a color field:</p>\n\n<pre><code>var myStore = new Ext.data.Store({\n groupField: 'color',\n groupDir : 'DESC'\n});\n\nmyStore.getGroups(); //returns:\n[\n {\n name: 'yellow',\n children: [\n //all records where the color field is 'yellow'\n ]\n },\n {\n name: 'red',\n children: [\n //all records where the color field is 'red'\n ]\n }\n]\n</code></pre>\n\n",
+ "linenr": 570,
+ "return": {
+ "type": "Array",
+ "doc": "<p>The grouped data</p>\n"
+ },
+ "html_filename": "Store2.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": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1585,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-hasPendingRequests",
- "shortDoc": "<p>Returns the number of pending requests out.</p>\n"
- },
- {
- "tagname": "method",
- "name": "indexOf",
- "member": "Ext.data.Store",
- "doc": "<p>Get the index within the cache of the passed Record.</p>\n",
- "params": [
- {
- "type": "Ext.data.Model",
- "name": "record",
- "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> object to find.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The index of the passed Record. Returns -1 if not found.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1872,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-indexOf",
- "shortDoc": "<p>Get the index within the cache of the passed Record.</p>\n"
- },
- {
- "tagname": "method",
- "name": "indexOfId",
- "member": "Ext.data.Store",
- "doc": "<p>Get the index within the cache of the Record with the passed id.</p>\n",
- "params": [
- {
+ ],
+ "name": "getName",
+ "owner": "Ext.Base",
+ "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.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'\n</code></pre>\n",
+ "linenr": 631,
+ "return": {
"type": "String",
- "name": "id",
- "doc": "<p>The id of the Record to find.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The index of the Record. Returns -1 if not found.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1891,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-indexOfId",
- "shortDoc": "<p>Get the index within the cache of the Record with the passed id.</p>\n"
- },
- {
- "tagname": "method",
- "name": "indexOfTotal",
- "member": "Ext.data.Store",
- "doc": "<p>Get the index within the entire dataset. From 0 to the totalCount.</p>\n",
- "params": [
- {
- "type": "Ext.data.Model",
- "name": "record",
- "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> object to find.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The index of the passed Record. Returns -1 if not found.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1882,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-indexOfTotal",
- "shortDoc": "<p>Get the index within the entire dataset. From 0 to the totalCount.</p>\n"
- },
- {
- "tagname": "method",
- "name": "initSortable",
- "member": "Ext.util.Sortable",
- "doc": "<p>Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.</p>\n",
- "params": [
+ "doc": "<p>className</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-getNewRecords",
+ "shortDoc": "Returns all Model instances that are either currently a phantom (e.g. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
- "linenr": 37,
- "html_filename": "Sortable.html",
- "href": "Sortable.html#Ext-util-Sortable-method-initSortable",
- "shortDoc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own in..."
- },
- {
- "tagname": "method",
- "name": "insert",
- "member": "Ext.data.Store",
- "doc": "<p>Inserts Model instances into the Store at the given index and fires the <a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a> event.\nSee also <code><a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a></code>.</p>\n",
- "params": [
- {
+ ],
+ "name": "getNewRecords",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not\nyet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)</p>\n",
+ "linenr": 450,
+ "return": {
+ "type": "Array",
+ "doc": "<p>The Model instances</p>\n"
+ },
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getPageFromRecordIndex",
+ "shortDoc": "Determines the page from a record index ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The record index</p>\n",
+ "name": "index"
+ }
+ ],
+ "name": "getPageFromRecordIndex",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Determines the page from a record index</p>\n",
+ "linenr": 1523,
+ "return": {
"type": "Number",
- "name": "index",
- "doc": "<p>The start index at which to insert the passed Records.</p>\n",
- "optional": false
- },
- {
- "type": "Ext.data.Model[]",
- "name": "records",
- "doc": "<p>An Array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> objects to add to the cache.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 760,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-insert",
- "shortDoc": "<p>Inserts Model instances into the Store at the given index and fires the <a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a> event.\nSee also <code><a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a></code>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "isFiltered",
- "member": "Ext.data.Store",
- "doc": "<p>Returns true if this store is currently filtered</p>\n",
- "params": [
+ "doc": "<p>The page the record belongs to</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-getProxy",
+ "shortDoc": "Returns the proxy currently attached to this proxy instance ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "Boolean",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1179,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-isFiltered",
- "shortDoc": "<p>Returns true if this store is currently filtered</p>\n"
- },
- {
- "tagname": "method",
- "name": "isGrouped",
- "member": "Ext.data.Store",
- "doc": "<p>Checks if the store is currently grouped</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>True if the store is grouped.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 552,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-isGrouped",
- "shortDoc": "<p>Checks if the store is currently grouped</p>\n"
- },
- {
- "tagname": "method",
- "name": "isLoading",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Returns true if the Store is currently performing a load operation</p>\n",
- "params": [
+ ],
+ "name": "getProxy",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Returns the proxy currently attached to this proxy instance</p>\n",
+ "linenr": 305,
+ "return": {
+ "type": "Ext.data.proxy.Proxy",
+ "doc": "<p>The Proxy instance</p>\n"
+ },
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getRange",
+ "shortDoc": "Returns a range of Records between specified indices. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": true,
+ "doc": "<p>(optional) The starting index (defaults to 0)</p>\n",
+ "name": "startIndex"
+ },
+ {
+ "type": "Number",
+ "optional": true,
+ "doc": "<p>(optional) The ending index (defaults to the last Record in the Store)</p>\n",
+ "name": "endIndex"
+ }
+ ],
+ "name": "getRange",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Returns a range of Records between specified indices.</p>\n",
+ "linenr": 1852,
+ "return": {
+ "type": "Ext.data.Model[]",
+ "doc": "<p>An array of Records</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-getRemovedRecords",
+ "shortDoc": "Returns any records that have been removed from the store but not yet destroyed on the proxy. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>True if the Store is currently loading</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 717,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-isLoading",
- "shortDoc": "<p>Returns true if the Store is currently performing a load operation</p>\n"
- },
- {
- "tagname": "method",
- "name": "last",
- "member": "Ext.data.Store",
- "doc": "<p>Convenience function for getting the last model instance in the store</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the last record being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.data.Model/undefined",
- "doc": "<p>The last model instance in the store, or undefined</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1940,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-last",
- "shortDoc": "<p>Convenience function for getting the last model instance in the store</p>\n"
- },
- {
- "tagname": "method",
- "name": "load",
- "member": "Ext.data.Store",
- "doc": "<p>Loads data into the Store via the configured <a href=\"#/api/Ext.grid.property.Store-cfg-proxy\" rel=\"Ext.grid.property.Store-cfg-proxy\" class=\"docClass\">proxy</a>. This uses the Proxy to make an\nasynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved\ninstances into the Store and calling an optional callback if required. Example usage:</p>\n\n\n\n\n<pre><code>store.load({\n scope : this,\n callback: function(records, operation, success) {\n //the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">operation</a> object contains all of the details of the load operation\n console.log(records);\n }\n});\n</code></pre>\n\n\n\n\n<p>If the callback scope does not need to be set, a function can simply be passed:</p>\n\n\n\n\n<pre><code>store.load(function(records, operation, success) {\n console.log('loaded records');\n});\n</code></pre>\n\n",
- "params": [
- {
- "type": "Object/Function",
- "name": "options",
- "doc": "<p>Optional config object, passed into the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object before loading.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 920,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-load",
- "shortDoc": "Loads data into the Store via the configured proxy. This uses the Proxy to make an\nasynchronous call to whatever stor..."
- },
- {
- "tagname": "method",
- "name": "loadData",
- "member": "Ext.data.Store",
- "doc": "<p>Loads an array of data straight into the Store</p>\n",
- "params": [
- {
+ ],
+ "name": "getRemovedRecords",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Returns any records that have been removed from the store but not yet destroyed on the proxy.</p>\n",
+ "linenr": 476,
+ "return": {
"type": "Array",
- "name": "data",
- "doc": "<p>Array of data to load. Any non-model instances will be cast into model instances first</p>\n",
- "optional": false
- },
- {
- "type": "Boolean",
- "name": "append",
- "doc": "<p>True to add the records to the existing records in the store, false to remove the old ones first</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1225,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-loadData",
- "shortDoc": "<p>Loads an array of data straight into the Store</p>\n"
- },
- {
- "tagname": "method",
- "name": "loadPage",
- "member": "Ext.data.Store",
- "doc": "<p>Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal\nload operation, passing in calculated 'start' and 'limit' params</p>\n",
- "params": [
- {
+ "doc": "<p>The removed Model instances</p>\n"
+ },
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-getTotalCount",
+ "shortDoc": "Returns the total number of Model instances that the Proxy\nindicates exist. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "getTotalCount",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Returns the total number of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a> instances that the <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Proxy</a>\nindicates exist. This will usually differ from <a href=\"#/api/Ext.grid.property.Store-method-getCount\" rel=\"Ext.grid.property.Store-method-getCount\" class=\"docClass\">getCount</a> when using paging - getCount returns the\nnumber of records loaded into the Store at the moment, getTotalCount returns the number of records that\ncould be loaded into the Store if the Store contained all data</p>\n",
+ "linenr": 1832,
+ "return": {
"type": "Number",
- "name": "page",
- "doc": "<p>The number of the page to load</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1298,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-loadPage",
- "shortDoc": "Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a norma..."
- },
- {
- "tagname": "method",
- "name": "loadRecords",
- "member": "Ext.data.Store",
- "doc": "<p>Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usually\nbe called internally when loading from the <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Proxy</a>, when adding records manually use <a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a> instead</p>\n",
- "params": [
- {
+ "doc": "<p>The total number of Model instances available via the Proxy</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-getUpdatedRecords",
+ "shortDoc": "Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "getUpdatedRecords",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>\n",
+ "linenr": 459,
+ "return": {
"type": "Array",
- "name": "records",
- "doc": "<p>The array of records to load</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>{addRecords: true} to add these records to the existing records, false to remove the Store's existing records first</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1248,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-loadRecords",
- "shortDoc": "Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usu..."
- },
- {
- "tagname": "method",
- "name": "max",
- "member": "Ext.data.Store",
- "doc": "<p>Gets the maximum value in the store.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "field",
- "doc": "<p>The field in each record</p>\n",
- "optional": false
- },
- {
+ "doc": "<p>The updated Model instances</p>\n"
+ },
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-group",
+ "shortDoc": "Group data in the store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String|Array",
+ "optional": false,
+ "doc": "<p>Either a string name of one of the fields in this Store's configured <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>,\nor an Array of grouper configurations.</p>\n",
+ "name": "groupers"
+ },
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The overall direction to group the data by. Defaults to \"ASC\".</p>\n",
+ "name": "direction"
+ }
+ ],
+ "name": "group",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Group data in the store</p>\n",
+ "linenr": 484,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-guaranteeRange",
+ "shortDoc": "Guarantee a specific range, this will load the store with a range (that\nmust be the pageSize or smaller) and take car...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "start"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "end"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "cb"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "scope"
+ }
+ ],
+ "name": "guaranteeRange",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Guarantee a specific range, this will load the store with a range (that\nmust be the pageSize or smaller) and take care of any loading that may\nbe necessary.</p>\n",
+ "linenr": 1601,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-hasListener",
+ "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to check for</p>\n",
+ "name": "eventName"
+ }
+ ],
+ "name": "hasListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
+ "linenr": 530,
+ "return": {
"type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the maximum in the group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Mixed/undefined",
- "doc": "<p>The maximum value, if no items exist, undefined.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 2052,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-max",
- "shortDoc": "<p>Gets the maximum value in the store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "min",
- "member": "Ext.data.Store",
- "doc": "<p>Gets the minimum value in the store.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "field",
- "doc": "<p>The field in each record</p>\n",
- "optional": false
- },
- {
- "type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the minimum in the group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Mixed/undefined",
- "doc": "<p>The minimum value, if no items exist, undefined.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 2014,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-min",
- "shortDoc": "<p>Gets the minimum value in the store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "nextPage",
- "member": "Ext.data.Store",
- "doc": "<p>Loads the next 'page' in the current data set</p>\n",
- "params": [
+ "doc": "<p>True if the event is being listened for, else false</p>\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-hasPendingRequests",
+ "shortDoc": "Returns the number of pending requests out. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1316,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-nextPage",
- "shortDoc": "<p>Loads the next 'page' in the current data set</p>\n"
- },
- {
- "tagname": "method",
- "name": "observe",
- "member": "Ext.util.Observable",
- "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
- "params": [
- {
- "type": "Function",
- "name": "c",
- "doc": "<p>The class constructor to make observable.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "listeners",
- "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a>.</p>\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": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event to listen for</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The method the event invokes</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
- "optional": true
- },
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) An object containing handler configuration.</p>\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": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
- },
- {
- "tagname": "method",
- "name": "prefetch",
- "member": "Ext.data.Store",
- "doc": "<p>Prefetches data the Store using its configured <a href=\"#/api/Ext.grid.property.Store-cfg-proxy\" rel=\"Ext.grid.property.Store-cfg-proxy\" class=\"docClass\">proxy</a>.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>Optional config object, passed into the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object before loading.\nSee <a href=\"#/api/Ext.grid.property.Store-event-load\" rel=\"Ext.grid.property.Store-event-load\" class=\"docClass\">load</a></p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1340,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-prefetch",
- "shortDoc": "<p>Prefetches data the Store using its configured <a href=\"#/api/Ext.grid.property.Store-cfg-proxy\" rel=\"Ext.grid.property.Store-cfg-proxy\" class=\"docClass\">proxy</a>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "prefetchPage",
- "member": "Ext.data.Store",
- "doc": "<p>Prefetches a page of data.</p>\n",
- "params": [
- {
+ ],
+ "name": "hasPendingRequests",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Returns the number of pending requests out.</p>\n",
+ "linenr": 1586,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.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": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.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();\n</code></pre>\n",
+ "linenr": 415,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-indexOf",
+ "shortDoc": "Get the index within the cache of the passed Record. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Model",
+ "optional": false,
+ "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> object to find.</p>\n",
+ "name": "record"
+ }
+ ],
+ "name": "indexOf",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Get the index within the cache of the passed Record.</p>\n",
+ "linenr": 1873,
+ "return": {
"type": "Number",
- "name": "page",
- "doc": "<p>The page to prefetch</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>Optional config object, passed into the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object before loading.\nSee <a href=\"#/api/Ext.grid.property.Store-event-load\" rel=\"Ext.grid.property.Store-event-load\" class=\"docClass\">load</a></p>\n",
- "optional": false
- },
- {
+ "doc": "<p>The index of the passed Record. Returns -1 if not found.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-indexOfId",
+ "shortDoc": "Get the index within the cache of the Record with the passed id. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The id of the Record to find.</p>\n",
+ "name": "id"
+ }
+ ],
+ "name": "indexOfId",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Get the index within the cache of the Record with the passed id.</p>\n",
+ "linenr": 1892,
+ "return": {
+ "type": "Number",
+ "doc": "<p>The index of the Record. Returns -1 if not found.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-indexOfTotal",
+ "shortDoc": "Get the index within the entire dataset. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Model",
+ "optional": false,
+ "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> object to find.</p>\n",
+ "name": "record"
+ }
+ ],
+ "name": "indexOfTotal",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Get the index within the entire dataset. From 0 to the totalCount.</p>\n",
+ "linenr": 1883,
+ "return": {
+ "type": "Number",
+ "doc": "<p>The index of the passed Record. Returns -1 if not found.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "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": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.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'\n</code></pre>\n",
+ "linenr": 63,
+ "return": {
"type": "Object",
- "name": "",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1374,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-prefetchPage",
- "shortDoc": "<p>Prefetches a page of data.</p>\n"
- },
- {
- "tagname": "method",
- "name": "previousPage",
- "member": "Ext.data.Store",
- "doc": "<p>Loads the previous 'page' in the current data set</p>\n",
- "params": [
+ "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Sortable.html#Ext-util-Sortable-method-initSortable",
+ "shortDoc": "Performs initialization of this mixin. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1323,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-previousPage",
- "shortDoc": "<p>Loads the previous 'page' in the current data set</p>\n"
- },
- {
- "tagname": "method",
- "name": "purgeRecords",
- "member": "Ext.data.Store",
- "doc": "<p>Purge the least recently used records in the prefetch if the purgeCount\nhas been exceeded.</p>\n",
- "params": [
+ ],
+ "name": "initSortable",
+ "owner": "Ext.util.Sortable",
+ "doc": "<p>Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.</p>\n",
+ "linenr": 36,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Sortable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-insert",
+ "shortDoc": "Inserts Model instances into the Store at the given index and fires the add event. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The start index at which to insert the passed Records.</p>\n",
+ "name": "index"
+ },
+ {
+ "type": "Ext.data.Model[]",
+ "optional": false,
+ "doc": "<p>An Array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> objects to add to the cache.</p>\n",
+ "name": "records"
+ }
+ ],
+ "name": "insert",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Inserts Model instances into the Store at the given index and fires the <a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a> event.\nSee also <code><a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a></code>.</p>\n",
+ "linenr": 761,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-isFiltered",
+ "shortDoc": "Returns true if this store is currently filtered ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1481,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-purgeRecords",
- "shortDoc": "<p>Purge the least recently used records in the prefetch if the purgeCount\nhas been exceeded.</p>\n"
- },
- {
- "tagname": "method",
- "name": "queryBy",
- "member": "Ext.data.Store",
- "doc": "<p>Query the cached records in this Store using a filtering function. The specified function\nwill be called with each record in this Store. If the function returns <tt>true</tt> the record is\nincluded in the results.</p>\n",
- "params": [
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to be called. It will be passed the following parameters:<ul>\n<li><b>record</b> : Ext.data.Model<p class=\"sub-desc\">The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a>\nto test for filtering. Access field values using <a href=\"#/api/Ext.data.Model-method-get\" rel=\"Ext.data.Model-method-get\" class=\"docClass\">Ext.data.Model.get</a>.</p></li>\n<li><b>id</b> : Object<p class=\"sub-desc\">The ID of the Record passed.</p></li>\n</ul></p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "MixedCollection",
- "doc": "<p>Returns an <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">Ext.util.MixedCollection</a> of the matched records</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1207,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-queryBy",
- "shortDoc": "Query the cached records in this Store using a filtering function. The specified function\nwill be called with each re..."
- },
- {
- "tagname": "method",
- "name": "relayEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "origin",
- "doc": "<p>The Observable whose events this object is to relay.</p>\n",
- "optional": false
- },
- {
- "type": "Array",
- "name": "events",
- "doc": "<p>Array of event names to relay.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "prefix",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 520,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-relayEvents",
- "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "releaseCapture",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
- "params": [
- {
- "type": "Observable",
- "name": "o",
- "doc": "<p>The Observable to release</p>\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": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
- },
- {
- "tagname": "method",
- "name": "remove",
- "member": "Ext.data.Store",
- "doc": "<p>Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single\n'datachanged' event after removal.</p>\n",
- "params": [
- {
- "type": "Ext.data.Model/Array",
- "name": "records",
- "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instance or array of instances to remove</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "isMove",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 857,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-remove",
- "shortDoc": "Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single\n'..."
- },
- {
- "tagname": "method",
- "name": "removeAll",
- "member": "Ext.data.Store",
- "doc": "<p>Remove all items from the store.</p>\n",
- "params": [
- {
+ ],
+ "name": "isFiltered",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Returns true if this store is currently filtered</p>\n",
+ "linenr": 1180,
+ "return": {
"type": "Boolean",
- "name": "silent",
- "doc": "<p>Prevent the <code>clear</code> event from being fired.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1900,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-removeAll",
- "shortDoc": "<p>Remove all items from the store.</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeAt",
- "member": "Ext.data.Store",
- "doc": "<p>Removes the model instance at the given index</p>\n",
- "params": [
- {
- "type": "Number",
- "name": "index",
- "doc": "<p>The record index</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 908,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-removeAt",
- "shortDoc": "<p>Removes the model instance at the given index</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes an event handler.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event the handler was associated with.</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope originally specified for the handler.</p>\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": "<p>Removes an event handler.</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeManagedListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.property.Store--mon\" rel=\"Ext.grid.property.Store--mon\" class=\"docClass\">mon</a> method.</p>\n",
- "params": [
- {
- "type": "Observable|Element",
- "name": "item",
- "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
- "optional": false
- },
- {
- "type": "Object|String",
- "name": "ename",
- "doc": "<p>The event name, or an object containing event name properties.</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 196,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
- "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.property.Store--mon\" rel=\"Ext.grid.property.Store--mon\" class=\"docClass\">mon</a> method.</p>\n"
- },
- {
- "tagname": "method",
- "name": "resumeEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.grid.property.Store-method-suspendEvents\" rel=\"Ext.grid.property.Store-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
- "params": [
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-isGrouped",
+ "shortDoc": "Checks if the store is currently grouped ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.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": 502,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
- "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
- },
- {
- "tagname": "method",
- "name": "setProxy",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Sets the Store's Proxy by string, config object or Proxy instance</p>\n",
- "params": [
- {
- "type": "String|Object|Ext.data.proxy.Proxy",
- "name": "proxy",
- "doc": "<p>The new Proxy, which can be either a type string, a configuration object\nor an <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Ext.data.proxy.Proxy</a> instance</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.data.proxy.Proxy",
- "doc": "<p>The attached Proxy object</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 278,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-setProxy",
- "shortDoc": "<p>Sets the Store's Proxy by string, config object or Proxy instance</p>\n"
- },
- {
- "tagname": "method",
- "name": "sort",
- "member": "Ext.util.Sortable",
- "doc": "<p>Sorts the data in the Store by one or more of its properties. Example usage:</p>\n\n\n<pre><code>//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n {\n property : 'age',\n direction: 'ASC'\n },\n {\n property : 'name',\n direction: 'DESC'\n }\n]);\n</code></pre>\n\n\n<p>Internally, Store converts the passed arguments into an array of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Ext.util.Sorter</a> instances, and delegates the actual\nsorting to its internal <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">Ext.util.MixedCollection</a>.</p>\n\n\n<p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>\n\n\n<pre><code>store.sort('myField');\nstore.sort('myField');\n </code></pre>\n\n\n<p>Is equivalent to this code, because Store handles the toggling automatically:</p>\n\n\n<pre><code>store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n</code></pre>\n\n",
- "params": [
- {
- "type": "String|Array",
- "name": "sorters",
- "doc": "<p>Either a string name of one of the fields in this Store's configured <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>,\nor an Array of sorter configurations.</p>\n",
- "optional": false
- },
- {
- "type": "String",
- "name": "direction",
- "doc": "<p>The overall direction to sort the data by. Defaults to \"ASC\".</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "where",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "doSort",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
- "linenr": 59,
- "html_filename": "Sortable.html",
- "href": "Sortable.html#Ext-util-Sortable-method-sort",
- "shortDoc": "Sorts the data in the Store by one or more of its properties. Example usage:\n\n\n//sort by a single field\nmyStore.sort(..."
- },
- {
- "tagname": "method",
- "name": "sum",
- "member": "Ext.data.Store",
- "doc": "<p>Sums the value of <tt>property</tt> for each <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a> between <tt>start</tt>\nand <tt>end</tt> and returns the result.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "field",
- "doc": "<p>A field in each record</p>\n",
- "optional": false
- },
- {
+ ],
+ "name": "isGrouped",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Checks if the store is currently grouped</p>\n",
+ "linenr": 553,
+ "return": {
"type": "Boolean",
- "name": "grouped",
- "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the sum for that group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Number",
- "doc": "<p>The sum</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1961,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-method-sum",
- "shortDoc": "<p>Sums the value of <tt>property</tt> for each <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a> between <tt>start</tt>\nand <tt>end</tt> and returns the result.</p>\n"
- },
- {
- "tagname": "method",
- "name": "suspendEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.property.Store-method-resumeEvents\" rel=\"Ext.grid.property.Store-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "queueSuspended",
- "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.property.Store-method-resumeEvents\" rel=\"Ext.grid.property.Store-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\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": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.property.Store-method-resumeEvents\" rel=\"Ext.grid.property.Store-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
- },
- {
- "tagname": "method",
- "name": "sync",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated\nand deleted records in the store, updating the Store's internal representation of the records\nas each operation completes.</p>\n",
- "params": [
+ "doc": "<p>True if the store is grouped.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-isLoading",
+ "shortDoc": "Returns true if the Store is currently performing a load operation ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 548,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-method-sync",
- "shortDoc": "Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated\nand deleted records in ..."
- },
- {
- "tagname": "method",
- "name": "un",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.property.Store-method-removeListener\" rel=\"Ext.grid.property.Store-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event the handler was associated with.</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope originally specified for the handler.</p>\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": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.property.Store-method-removeListener\" rel=\"Ext.grid.property.Store-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
- }
- ],
- "property": [
- {
- "tagname": "property",
- "name": "batchUpdateMode",
- "member": "Ext.data.AbstractStore",
- "type": "String",
- "doc": "<p>Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's\ninternal representation of the data after each operation of the batch has completed, 'complete' will wait until\nthe entire batch has been completed before updating the Store's data. 'complete' is a good choice for local\nstorage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 69,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-property-batchUpdateMode",
- "shortDoc": "Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's\ninternal..."
- },
- {
- "tagname": "property",
- "name": "currentPage",
- "member": "Ext.data.Store",
- "type": "Number",
- "doc": "<p>The page that the Store has most recently loaded (see <a href=\"#/api/Ext.grid.property.Store-method-loadPage\" rel=\"Ext.grid.property.Store-method-loadPage\" class=\"docClass\">loadPage</a>)</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 277,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-property-currentPage"
- },
- {
- "tagname": "property",
- "name": "data",
- "member": "Ext.data.Store",
- "type": "Ext.util.MixedCollection",
- "doc": "<p>The MixedCollection that holds this store's local cache of records</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 369,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-property-data"
- },
- {
- "tagname": "property",
- "name": "defaultProxyType",
- "member": "Ext.data.AbstractStore",
- "type": "String",
- "doc": "<p>The string type of the Proxy to create if none is specified. This defaults to creating a <a href=\"#/api/Ext.data.proxy.Memory\" rel=\"Ext.data.proxy.Memory\" class=\"docClass\">memory proxy</a>.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 104,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-property-defaultProxyType"
- },
- {
- "tagname": "property",
- "name": "defaultSortDirection",
- "member": "Ext.util.Sortable",
- "type": "String",
- "doc": "<p>The default sort direction to use if one is not specified (defaults to \"ASC\")</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
- "linenr": 20,
- "html_filename": "Sortable.html",
- "href": "Sortable.html#Ext-util-Sortable-property-defaultSortDirection"
- },
- {
- "tagname": "property",
- "name": "filterOnLoad",
- "member": "Ext.data.AbstractStore",
- "type": "Boolean",
- "doc": "<p>If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.\nDefaults to true, ignored if <a href=\"#/api/Ext.grid.property.Store-cfg-remoteFilter\" rel=\"Ext.grid.property.Store-cfg-remoteFilter\" class=\"docClass\">remoteFilter</a> is true</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 79,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-property-filterOnLoad",
- "shortDoc": "If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.\nDe..."
- },
- {
- "tagname": "property",
- "name": "filters",
- "member": "Ext.data.AbstractStore",
- "type": "Ext.util.MixedCollection",
- "doc": "<p>The collection of <a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Filters</a> currently applied to this Store</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 268,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-property-filters"
- },
- {
- "tagname": "property",
- "name": "groupDir",
- "member": "Ext.data.Store",
- "type": "String",
- "doc": "<p>The direction in which sorting should be applied when grouping. Defaults to \"ASC\" - the other supported value is \"DESC\"</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 263,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-property-groupDir"
- },
- {
- "tagname": "property",
- "name": "groupField",
- "member": "Ext.data.Store",
- "type": "String",
- "doc": "<p>The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the\ngroupField and <a href=\"#/api/Ext.grid.property.Store-property-groupDir\" rel=\"Ext.grid.property.Store-property-groupDir\" class=\"docClass\">groupDir</a> are injected as the first sorter (see <a href=\"#/api/Ext.grid.property.Store-method-sort\" rel=\"Ext.grid.property.Store-method-sort\" class=\"docClass\">sort</a>). Stores support a single\nlevel of grouping, and groups can be fetched via the <a href=\"#/api/Ext.grid.property.Store-method-getGroups\" rel=\"Ext.grid.property.Store-method-getGroups\" class=\"docClass\">getGroups</a> method.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 254,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-property-groupField",
- "shortDoc": "The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the\ngroup..."
- },
- {
- "tagname": "property",
- "name": "groupers",
- "member": "Ext.data.Store",
- "type": "Ext.util.MixedCollection",
- "doc": "<p>The collection of <a href=\"#/api/Ext.util.Grouper\" rel=\"Ext.util.Grouper\" class=\"docClass\">Groupers</a> currently applied to this Store</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 391,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-property-groupers"
- },
- {
- "tagname": "property",
- "name": "isDestroyed",
- "member": "Ext.data.AbstractStore",
- "type": "Boolean",
- "doc": "<p>True if the Store has already been destroyed via <a href=\"#/api/Ext.grid.property.Store--destroyStore\" rel=\"Ext.grid.property.Store--destroyStore\" class=\"docClass\">destroyStore</a>. If this is true, the reference to Store should be deleted\nas it will not function correctly any more.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 111,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-property-isDestroyed",
- "shortDoc": "True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be dele..."
- },
- {
- "tagname": "property",
- "name": "isSortable",
- "member": "Ext.util.Sortable",
- "type": "Boolean",
- "doc": "<p>Flag denoting that this object is sortable. Always true.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
- "linenr": 13,
- "html_filename": "Sortable.html",
- "href": "Sortable.html#Ext-util-Sortable-property-isSortable"
- },
- {
- "tagname": "property",
- "name": "snapshot",
- "member": "Ext.data.Store",
- "type": "Ext.util.MixedCollection",
- "doc": "<p>A pristine (unfiltered) collection of the records in this store. This is used to reinstate\nrecords when a filter is removed or changed</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 1136,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-property-snapshot",
- "shortDoc": "A pristine (unfiltered) collection of the records in this store. This is used to reinstate\nrecords when a filter is r..."
- },
- {
- "tagname": "property",
- "name": "sortOnLoad",
- "member": "Ext.data.AbstractStore",
- "type": "Boolean",
- "doc": "<p>If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.\nDefaults to true, igored if <a href=\"#/api/Ext.grid.property.Store-cfg-remoteSort\" rel=\"Ext.grid.property.Store-cfg-remoteSort\" class=\"docClass\">remoteSort</a> is true</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 87,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-property-sortOnLoad",
- "shortDoc": "If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.\nDe..."
- },
- {
- "tagname": "property",
- "name": "sortRoot",
- "member": "Ext.util.Sortable",
- "type": "String",
- "doc": "<p>The property in each item that contains the data to sort. (defaults to null)</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
- "linenr": 31,
- "html_filename": "Sortable.html",
- "href": "Sortable.html#Ext-util-Sortable-property-sortRoot"
- },
- {
- "tagname": "property",
- "name": "sorters",
- "member": "Ext.util.Sortable",
- "type": "Ext.util.MixedCollection",
- "doc": "<p>The collection of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Sorters</a> currently applied to this Store</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js",
- "linenr": 45,
- "html_filename": "Sortable.html",
- "href": "Sortable.html#Ext-util-Sortable-property-sorters"
- }
- ],
- "event": [
- {
- "tagname": "event",
- "name": "add",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Fired when a Model instance has been added to this Store</p>\n",
- "params": [
- {
- "type": "Ext.data.Store",
- "name": "store",
- "doc": "<p>The store</p>\n",
- "optional": false
- },
- {
- "type": "Array",
- "name": "records",
- "doc": "<p>The Model instances that were added</p>\n",
- "optional": false
- },
- {
- "type": "Number",
- "name": "index",
- "doc": "<p>The index at which the instances were inserted</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 143,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-add",
- "shortDoc": "<p>Fired when a Model instance has been added to this Store</p>\n"
- },
- {
- "tagname": "event",
- "name": "beforeload",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Event description</p>\n",
- "params": [
- {
- "type": "Ext.data.Store",
- "name": "store",
- "doc": "<p>This Store</p>\n",
- "optional": false
- },
- {
- "type": "Ext.data.Operation",
- "name": "operation",
- "doc": "<p>The <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object that will be passed to the Proxy to load the Store</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 183,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforeload",
- "shortDoc": "<p>Event description</p>\n"
- },
- {
- "tagname": "event",
- "name": "beforeprefetch",
- "member": "Ext.data.Store",
- "doc": "<p>Fires before a prefetch occurs. Return false to cancel.</p>\n",
- "params": [
- {
- "type": "Ext.data.store",
- "name": "this",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Ext.data.Operation",
- "name": "operation",
- "doc": "<p>The associated operation</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 343,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-event-beforeprefetch",
- "shortDoc": "<p>Fires before a prefetch occurs. Return false to cancel.</p>\n"
- },
- {
- "tagname": "event",
- "name": "beforesync",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Called before a call to <a href=\"#/api/Ext.grid.property.Store-method-sync\" rel=\"Ext.grid.property.Store-method-sync\" class=\"docClass\">sync</a> is executed. Return false from any listener to cancel the synv</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>Hash of all records to be synchronized, broken down into create, update and destroy</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 200,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforesync",
- "shortDoc": "<p>Called before a call to <a href=\"#/api/Ext.grid.property.Store-method-sync\" rel=\"Ext.grid.property.Store-method-sync\" class=\"docClass\">sync</a> is executed. Return false from any listener to cancel the synv</p>\n"
- },
- {
- "tagname": "event",
- "name": "clear",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Fired after the <a href=\"#/api/Ext.grid.property.Store-method-removeAll\" rel=\"Ext.grid.property.Store-method-removeAll\" class=\"docClass\">removeAll</a> method is called.</p>\n",
- "params": [
- {
- "type": "Ext.data.Store",
- "name": "this",
- "doc": "\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 206,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-clear",
- "shortDoc": "<p>Fired after the <a href=\"#/api/Ext.grid.property.Store-method-removeAll\" rel=\"Ext.grid.property.Store-method-removeAll\" class=\"docClass\">removeAll</a> method is called.</p>\n"
- },
- {
- "tagname": "event",
- "name": "datachanged",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Fires whenever the records in the Store have changed in some way - this could include adding or removing records,\nor updating the data in existing records</p>\n",
- "params": [
- {
- "type": "Ext.data.Store",
- "name": "this",
- "doc": "<p>The data store</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 175,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-datachanged",
- "shortDoc": "Fires whenever the records in the Store have changed in some way - this could include adding or removing records,\nor ..."
- },
- {
- "tagname": "event",
- "name": "groupchange",
- "member": "Ext.data.Store",
- "doc": "<p>Fired whenever the grouping in the grid changes</p>\n",
- "params": [
- {
- "type": "Ext.data.Store",
- "name": "store",
- "doc": "<p>The store</p>\n",
- "optional": false
- },
- {
- "type": "Array",
- "name": "groupers",
- "doc": "<p>The array of grouper objects</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 350,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-event-groupchange",
- "shortDoc": "<p>Fired whenever the grouping in the grid changes</p>\n"
- },
- {
- "tagname": "event",
- "name": "load",
- "member": "Ext.data.Store",
- "doc": "<p>Fires whenever records have been prefetched</p>\n",
- "params": [
- {
- "type": "Ext.data.store",
- "name": "this",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Array",
- "name": "records",
- "doc": "<p>An array of records</p>\n",
- "optional": false
- },
- {
+ ],
+ "name": "isLoading",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Returns true if the Store is currently performing a load operation</p>\n",
+ "linenr": 715,
+ "return": {
"type": "Boolean",
- "name": "successful",
- "doc": "<p>True if the operation was successful.</p>\n",
- "optional": false
- },
- {
- "type": "Ext.data.Operation",
- "name": "operation",
- "doc": "<p>The associated operation</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Store.js",
- "linenr": 357,
- "html_filename": "Store2.html",
- "href": "Store2.html#Ext-data-Store-event-load",
- "shortDoc": "<p>Fires whenever records have been prefetched</p>\n"
- },
- {
- "tagname": "event",
- "name": "remove",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Fired when a Model instance has been removed from this Store</p>\n",
- "params": [
- {
- "type": "Ext.data.Store",
- "name": "store",
- "doc": "<p>The Store object</p>\n",
- "optional": false
- },
- {
- "type": "Ext.data.Model",
- "name": "record",
- "doc": "<p>The record that was removed</p>\n",
- "optional": false
- },
- {
+ "doc": "<p>True if the Store is currently loading</p>\n"
+ },
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-last",
+ "shortDoc": "Convenience function for getting the last model instance in the store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the last record being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "last",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Convenience function for getting the last model instance in the store</p>\n",
+ "linenr": 1941,
+ "return": {
+ "type": "Ext.data.Model/undefined",
+ "doc": "<p>The last model instance in the store, or undefined</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-load",
+ "shortDoc": "Loads data into the Store via the configured proxy. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object/Function",
+ "optional": false,
+ "doc": "<p>Optional config object, passed into the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object before loading.</p>\n",
+ "name": "options"
+ }
+ ],
+ "name": "load",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Loads data into the Store via the configured <a href=\"#/api/Ext.grid.property.Store-cfg-proxy\" rel=\"Ext.grid.property.Store-cfg-proxy\" class=\"docClass\">proxy</a>. This uses the Proxy to make an\nasynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved\ninstances into the Store and calling an optional callback if required. Example usage:</p>\n\n\n\n\n<pre><code>store.load({\n scope : this,\n callback: function(records, operation, success) {\n //the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">operation</a> object contains all of the details of the load operation\n console.log(records);\n }\n});\n</code></pre>\n\n\n\n\n<p>If the callback scope does not need to be set, a function can simply be passed:</p>\n\n\n\n\n<pre><code>store.load(function(records, operation, success) {\n console.log('loaded records');\n});\n</code></pre>\n\n",
+ "linenr": 921,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-loadData",
+ "shortDoc": "Loads an array of data straight into the Store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Array",
+ "optional": false,
+ "doc": "<p>Array of data to load. Any non-model instances will be cast into model instances first</p>\n",
+ "name": "data"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>True to add the records to the existing records in the store, false to remove the old ones first</p>\n",
+ "name": "append"
+ }
+ ],
+ "name": "loadData",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Loads an array of data straight into the Store</p>\n",
+ "linenr": 1226,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-loadPage",
+ "shortDoc": "Loads a given 'page' of data by setting the start and limit values appropriately. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The number of the page to load</p>\n",
+ "name": "page"
+ }
+ ],
+ "name": "loadPage",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal\nload operation, passing in calculated 'start' and 'limit' params</p>\n",
+ "linenr": 1299,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-loadRecords",
+ "shortDoc": "Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Array",
+ "optional": false,
+ "doc": "<p>The array of records to load</p>\n",
+ "name": "records"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>{addRecords: true} to add these records to the existing records, false to remove the Store's existing records first</p>\n",
+ "name": "options"
+ }
+ ],
+ "name": "loadRecords",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usually\nbe called internally when loading from the <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Proxy</a>, when adding records manually use <a href=\"#/api/Ext.grid.property.Store-event-add\" rel=\"Ext.grid.property.Store-event-add\" class=\"docClass\">add</a> instead</p>\n",
+ "linenr": 1249,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-max",
+ "shortDoc": "Gets the maximum value in the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The field in each record</p>\n",
+ "name": "field"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the maximum in the group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "max",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Gets the maximum value in the store.</p>\n",
+ "linenr": 2053,
+ "return": {
+ "type": "Mixed/undefined",
+ "doc": "<p>The maximum value, if no items exist, undefined.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-min",
+ "shortDoc": "Gets the minimum value in the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The field in each record</p>\n",
+ "name": "field"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the minimum in the group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "min",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Gets the minimum value in the store.</p>\n",
+ "linenr": 2015,
+ "return": {
+ "type": "Mixed/undefined",
+ "doc": "<p>The minimum value, if no items exist, undefined.</p>\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "addManagedListener"
+ },
+ "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": "<p>The item to which to add a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
+ "name": "opt"
+ }
+ ],
+ "name": "mon",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.property.Store-method-addManagedListener\" rel=\"Ext.grid.property.Store-method-addManagedListener\" class=\"docClass\">addManagedListener</a>.</p>\n\n<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
+ "linenr": 681,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "removeManagedListener"
+ },
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-mun",
+ "shortDoc": "Shorthand for removeManagedListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable|Element",
+ "optional": false,
+ "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object|String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "mun",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.property.Store-method-removeManagedListener\" rel=\"Ext.grid.property.Store-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.property.Store-method-mon\" rel=\"Ext.grid.property.Store-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
+ "linenr": 687,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-nextPage",
+ "shortDoc": "Loads the next 'page' in the current data set ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "nextPage",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Loads the next 'page' in the current data set</p>\n",
+ "linenr": 1317,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.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": "<p>The class constructor to make observable.</p>\n",
+ "name": "c"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
+ "name": "listeners"
+ }
+ ],
+ "name": "observe",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
+ "linenr": 69,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "addListener"
+ },
+ "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": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The method the event invokes. Will be called with arguments given to\n<a href=\"#/api/Ext.grid.property.Store-method-fireEvent\" rel=\"Ext.grid.property.Store-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\n<pre><code>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</code></pre>\n\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
+ "name": "options"
+ }
+ ],
+ "name": "on",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
+ "linenr": 669,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-override",
+ "shortDoc": "Override prototype members of this class. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "members"
+ }
+ ],
+ "name": "override",
+ "owner": "Ext.Base",
+ "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.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\"\n</code></pre>\n",
+ "linenr": 518,
+ "return": {
+ "type": "Ext.Base",
+ "doc": "<p>this</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-prefetch",
+ "shortDoc": "Prefetches data the Store using its configured proxy. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional config object, passed into the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object before loading.\nSee <a href=\"#/api/Ext.grid.property.Store-event-load\" rel=\"Ext.grid.property.Store-event-load\" class=\"docClass\">load</a></p>\n",
+ "name": "options"
+ }
+ ],
+ "name": "prefetch",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Prefetches data the Store using its configured <a href=\"#/api/Ext.grid.property.Store-cfg-proxy\" rel=\"Ext.grid.property.Store-cfg-proxy\" class=\"docClass\">proxy</a>.</p>\n",
+ "linenr": 1341,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-prefetchPage",
+ "shortDoc": "Prefetches a page of data. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The page to prefetch</p>\n",
+ "name": "page"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional config object, passed into the <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object before loading.\nSee <a href=\"#/api/Ext.grid.property.Store-event-load\" rel=\"Ext.grid.property.Store-event-load\" class=\"docClass\">load</a></p>\n",
+ "name": "options"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": ""
+ }
+ ],
+ "name": "prefetchPage",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Prefetches a page of data.</p>\n",
+ "linenr": 1375,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-previousPage",
+ "shortDoc": "Loads the previous 'page' in the current data set ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "previousPage",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Loads the previous 'page' in the current data set</p>\n",
+ "linenr": 1324,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-purgeRecords",
+ "shortDoc": "Purge the least recently used records in the prefetch if the purgeCount\nhas been exceeded. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "purgeRecords",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Purge the least recently used records in the prefetch if the purgeCount\nhas been exceeded.</p>\n",
+ "linenr": 1482,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-queryBy",
+ "shortDoc": "Query the cached records in this Store using a filtering function. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to be called. It will be passed the following parameters:<ul>\n<li><b>record</b> : Ext.data.Model<p class=\"sub-desc\">The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a>\nto test for filtering. Access field values using <a href=\"#/api/Ext.data.Model-method-get\" rel=\"Ext.data.Model-method-get\" class=\"docClass\">Ext.data.Model.get</a>.</p></li>\n<li><b>id</b> : Object<p class=\"sub-desc\">The ID of the Record passed.</p></li>\n</ul></p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "queryBy",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Query the cached records in this Store using a filtering function. The specified function\nwill be called with each record in this Store. If the function returns <tt>true</tt> the record is\nincluded in the results.</p>\n",
+ "linenr": 1208,
+ "return": {
+ "type": "MixedCollection",
+ "doc": "<p>Returns an <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">Ext.util.MixedCollection</a> of the matched records</p>\n"
+ },
+ "html_filename": "Store2.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": "<p>The Observable whose events this object is to relay.</p>\n",
+ "name": "origin"
+ },
+ {
+ "type": "[String]",
+ "optional": false,
+ "doc": "<p>Array of event names to relay.</p>\n",
+ "name": "events"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "prefix"
+ }
+ ],
+ "name": "relayEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
+ "linenr": 573,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
+ "shortDoc": "Removes all added captures from the Observable. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable",
+ "optional": false,
+ "doc": "<p>The Observable to release</p>\n",
+ "name": "o"
+ }
+ ],
+ "name": "releaseCapture",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
+ "linenr": 44,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-remove",
+ "shortDoc": "Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single\n'...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Model/Array",
+ "optional": false,
+ "doc": "<p>The <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instance or array of instances to remove</p>\n",
+ "name": "records"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "isMove"
+ }
+ ],
+ "name": "remove",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single\n'datachanged' event after removal.</p>\n",
+ "linenr": 858,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-removeAll",
+ "shortDoc": "Remove all items from the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>Prevent the <code>clear</code> event from being fired.</p>\n",
+ "name": "silent"
+ }
+ ],
+ "name": "removeAll",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Remove all items from the store.</p>\n",
+ "linenr": 1901,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-removeAt",
+ "shortDoc": "Removes the model instance at the given index ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The record index</p>\n",
+ "name": "index"
+ }
+ ],
+ "name": "removeAt",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Removes the model instance at the given index</p>\n",
+ "linenr": 909,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Store2.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": "<p>The type of event the handler was associated with.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "removeListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes an event handler.</p>\n",
+ "linenr": 392,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
+ "shortDoc": "Removes listeners that were added by the mon method. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable|Element",
+ "optional": false,
+ "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object|String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "removeManagedListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.property.Store-method-mon\" rel=\"Ext.grid.property.Store-method-mon\" class=\"docClass\">mon</a> method.</p>\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": "<p>Resumes firing events (see <a href=\"#/api/Ext.grid.property.Store-method-suspendEvents\" rel=\"Ext.grid.property.Store-method-suspendEvents\" class=\"docClass\">suspendEvents</a>).</p>\n\n<p>If events were suspended using the <code>**queueSuspended**</code> parameter, then all events fired\nduring event suspension will be sent to any listeners now.</p>\n",
+ "linenr": 554,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-setProxy",
+ "shortDoc": "Sets the Store's Proxy by string, config object or Proxy instance ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String|Object|Ext.data.proxy.Proxy",
+ "optional": false,
+ "doc": "<p>The new Proxy, which can be either a type string, a configuration object\nor an <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Ext.data.proxy.Proxy</a> instance</p>\n",
+ "name": "proxy"
+ }
+ ],
+ "name": "setProxy",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Sets the Store's Proxy by string, config object or Proxy instance</p>\n",
+ "linenr": 276,
+ "return": {
+ "type": "Ext.data.proxy.Proxy",
+ "doc": "<p>The attached Proxy object</p>\n"
+ },
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Sortable.html#Ext-util-Sortable-method-sort",
+ "shortDoc": "Sorts the data in the Store by one or more of its properties. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String|Array",
+ "optional": false,
+ "doc": "<p>Either a string name of one of the fields in this Store's configured <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>,\nor an Array of sorter configurations.</p>\n",
+ "name": "sorters"
+ },
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The overall direction to sort the data by. Defaults to \"ASC\".</p>\n",
+ "name": "direction"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "where"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "doSort"
+ }
+ ],
+ "name": "sort",
+ "owner": "Ext.util.Sortable",
+ "doc": "<p>Sorts the data in the Store by one or more of its properties. Example usage:</p>\n\n\n<pre><code>//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n {\n property : 'age',\n direction: 'ASC'\n },\n {\n property : 'name',\n direction: 'DESC'\n }\n]);\n</code></pre>\n\n\n<p>Internally, Store converts the passed arguments into an array of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Ext.util.Sorter</a> instances, and delegates the actual\nsorting to its internal <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">Ext.util.MixedCollection</a>.</p>\n\n\n<p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>\n\n\n<pre><code>store.sort('myField');\nstore.sort('myField');\n </code></pre>\n\n\n<p>Is equivalent to this code, because Store handles the toggling automatically:</p>\n\n\n<pre><code>store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n</code></pre>\n\n",
+ "linenr": 58,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Sortable.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": [
+
+ ],
+ "name": "statics",
+ "owner": "Ext.Base",
+ "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>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\n</code></pre>\n",
+ "linenr": 199,
+ "return": {
+ "type": "Class",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Store2.html#Ext-data-Store-method-sum",
+ "shortDoc": "Sums the value of property for each record between start\nand end and returns the result. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>A field in each record</p>\n",
+ "name": "field"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>(Optional) True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the sum for that group being the value. The grouped parameter is only honored if\nthe store has a groupField.</p>\n",
+ "name": "grouped"
+ }
+ ],
+ "name": "sum",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Sums the value of <tt>property</tt> for each <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">record</a> between <tt>start</tt>\nand <tt>end</tt> and returns the result.</p>\n",
+ "linenr": 1962,
+ "return": {
"type": "Number",
- "name": "index",
- "doc": "<p>The index of the record that was removed</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 152,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-remove",
- "shortDoc": "<p>Fired when a Model instance has been removed from this Store</p>\n"
- },
- {
- "tagname": "event",
- "name": "update",
- "member": "Ext.data.AbstractStore",
- "doc": "<p>Fires when a Record has been updated</p>\n",
- "params": [
- {
- "type": "Store",
- "name": "this",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Ext.data.Model",
- "name": "record",
- "doc": "<p>The Model instance that was updated</p>\n",
- "optional": false
- },
- {
- "type": "String",
- "name": "operation",
- "doc": "<p>The update operation being performed. Value may be one of:</p>\n\n<pre><code> Ext.data.Model.EDIT\n Ext.data.Model.REJECT\n Ext.data.Model.COMMIT\n</code></pre>\n\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 161,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-update",
- "shortDoc": "<p>Fires when a Record has been updated</p>\n"
- }
- ],
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/property/Store.js",
- "linenr": 1,
- "html_filename": "Store.html",
- "href": "Store.html#Ext-grid-property-Store",
- "cssVar": [
+ "doc": "<p>The sum</p>\n"
+ },
+ "html_filename": "Store2.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": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.property.Store-method-resumeEvents\" rel=\"Ext.grid.property.Store-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events.</p>\n",
+ "name": "queueSuspended"
+ }
+ ],
+ "name": "suspendEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Suspends the firing of all events. (see <a href=\"#/api/Ext.grid.property.Store-method-resumeEvents\" rel=\"Ext.grid.property.Store-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
+ "linenr": 541,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-method-sync",
+ "shortDoc": "Synchronizes the Store with its Proxy. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
- ],
- "cssMixin": [
+ ],
+ "name": "sync",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated\nand deleted records in the store, updating the Store's internal representation of the records\nas each operation completes.</p>\n",
+ "linenr": 546,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "AbstractStore.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": "<p>The type of event the handler was associated with.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.grid.property.Store-method-addListener\" rel=\"Ext.grid.property.Store-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "un",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.property.Store-method-removeListener\" rel=\"Ext.grid.property.Store-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
+ "linenr": 675,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
+ }
+ ],
+ "property": [
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Sortable.html#Ext-util-Sortable-property-",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js",
+ "private": false,
+ "name": "",
+ "owner": "Ext.util.Sortable",
+ "doc": "<p>The property in each item that contains the data to sort.</p>\n",
+ "linenr": 31,
+ "html_filename": "Sortable.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-property-batchUpdateMode",
+ "shortDoc": "Sets the updating behavior based on batch synchronization. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "batchUpdateMode",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's\ninternal representation of the data after each operation of the batch has completed, 'complete' will wait until\nthe entire batch has been completed before updating the Store's data. 'complete' is a good choice for local\nstorage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.</p>\n",
+ "linenr": 67,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "Number",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Store2.html#Ext-data-Store-property-currentPage",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "currentPage",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The page that the Store has most recently loaded (see <a href=\"#/api/Ext.grid.property.Store-method-loadPage\" rel=\"Ext.grid.property.Store-method-loadPage\" class=\"docClass\">loadPage</a>)</p>\n",
+ "linenr": 275,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Ext.util.MixedCollection",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Store2.html#Ext-data-Store-property-data",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "data",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The MixedCollection that holds this store's local cache of records</p>\n",
+ "linenr": 370,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-property-defaultProxyType",
+ "shortDoc": "The string type of the Proxy to create if none is specified. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "defaultProxyType",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>The string type of the Proxy to create if none is specified. This defaults to creating a <a href=\"#/api/Ext.data.proxy.Memory\" rel=\"Ext.data.proxy.Memory\" class=\"docClass\">memory proxy</a>.</p>\n",
+ "linenr": 102,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Sortable.html#Ext-util-Sortable-property-defaultSortDirection",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js",
+ "private": false,
+ "name": "defaultSortDirection",
+ "owner": "Ext.util.Sortable",
+ "doc": "<p>The default sort direction to use if one is not specified (defaults to \"ASC\")</p>\n",
+ "linenr": 20,
+ "html_filename": "Sortable.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-property-filterOnLoad",
+ "shortDoc": "If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "filterOnLoad",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.\nDefaults to true, ignored if <a href=\"#/api/Ext.grid.property.Store-cfg-remoteFilter\" rel=\"Ext.grid.property.Store-cfg-remoteFilter\" class=\"docClass\">remoteFilter</a> is true</p>\n",
+ "linenr": 77,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "Ext.util.MixedCollection",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-property-filters",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "filters",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>The collection of <a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Filters</a> currently applied to this Store</p>\n",
+ "linenr": 266,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Store2.html#Ext-data-Store-property-groupDir",
+ "shortDoc": "The direction in which sorting should be applied when grouping. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "groupDir",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The direction in which sorting should be applied when grouping. Defaults to \"ASC\" - the other supported value is \"DESC\"</p>\n",
+ "linenr": 261,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Store2.html#Ext-data-Store-property-groupField",
+ "shortDoc": "The (optional) field by which to group data in the store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "groupField",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the\ngroupField and <a href=\"#/api/Ext.grid.property.Store-property-groupDir\" rel=\"Ext.grid.property.Store-property-groupDir\" class=\"docClass\">groupDir</a> are injected as the first sorter (see <a href=\"#/api/Ext.grid.property.Store-method-sort\" rel=\"Ext.grid.property.Store-method-sort\" class=\"docClass\">sort</a>). Stores support a single\nlevel of grouping, and groups can be fetched via the <a href=\"#/api/Ext.grid.property.Store-method-getGroups\" rel=\"Ext.grid.property.Store-method-getGroups\" class=\"docClass\">getGroups</a> method.</p>\n",
+ "linenr": 252,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Ext.util.MixedCollection",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Store2.html#Ext-data-Store-property-groupers",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "groupers",
+ "owner": "Ext.data.Store",
+ "doc": "<p>The collection of <a href=\"#/api/Ext.util.Grouper\" rel=\"Ext.util.Grouper\" class=\"docClass\">Groupers</a> currently applied to this Store</p>\n",
+ "linenr": 392,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-property-isDestroyed",
+ "shortDoc": "True if the Store has already been destroyed via destroyStore. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "isDestroyed",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be deleted\nas it will not function correctly any more.</p>\n",
+ "linenr": 109,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Sortable.html#Ext-util-Sortable-property-isSortable",
+ "shortDoc": "Flag denoting that this object is sortable. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js",
+ "private": false,
+ "name": "isSortable",
+ "owner": "Ext.util.Sortable",
+ "doc": "<p>Flag denoting that this object is sortable. Always true.</p>\n",
+ "linenr": 13,
+ "html_filename": "Sortable.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": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>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'\n</code></pre>\n",
+ "linenr": 18,
+ "html_filename": "Base3.html"
+ },
+ {
+ "type": "Ext.util.MixedCollection",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Store2.html#Ext-data-Store-property-snapshot",
+ "shortDoc": "A pristine (unfiltered) collection of the records in this store. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "name": "snapshot",
+ "owner": "Ext.data.Store",
+ "doc": "<p>A pristine (unfiltered) collection of the records in this store. This is used to reinstate\nrecords when a filter is removed or changed</p>\n",
+ "linenr": 1137,
+ "html_filename": "Store2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-property-sortOnLoad",
+ "shortDoc": "If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "name": "sortOnLoad",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.\nDefaults to true, igored if <a href=\"#/api/Ext.grid.property.Store-cfg-remoteSort\" rel=\"Ext.grid.property.Store-cfg-remoteSort\" class=\"docClass\">remoteSort</a> is true</p>\n",
+ "linenr": 85,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "type": "Ext.util.MixedCollection",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Sortable.html#Ext-util-Sortable-property-sorters",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js",
+ "private": false,
+ "name": "sorters",
+ "owner": "Ext.util.Sortable",
+ "doc": "<p>The collection of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Sorters</a> currently applied to this Store</p>\n",
+ "linenr": 44,
+ "html_filename": "Sortable.html"
+ }
+ ],
+ "cssVar": [
- ],
- "component": false,
+ ],
+ "cssMixin": [
+
+ ],
+ "event": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-add",
+ "shortDoc": "Fired when a Model instance has been added to this Store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Store",
+ "optional": false,
+ "doc": "<p>The store</p>\n",
+ "name": "store"
+ },
+ {
+ "type": "Array",
+ "optional": false,
+ "doc": "<p>The Model instances that were added</p>\n",
+ "name": "records"
+ },
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The index at which the instances were inserted</p>\n",
+ "name": "index"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "add",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Fired when a Model instance has been added to this Store</p>\n",
+ "linenr": 141,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforeload",
+ "shortDoc": "Event description ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Store",
+ "optional": false,
+ "doc": "<p>This Store</p>\n",
+ "name": "store"
+ },
+ {
+ "type": "Ext.data.Operation",
+ "optional": false,
+ "doc": "<p>The <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object that will be passed to the Proxy to load the Store</p>\n",
+ "name": "operation"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "beforeload",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Event description</p>\n",
+ "linenr": 181,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "Store2.html#Ext-data-Store-event-beforeprefetch",
+ "shortDoc": "Fires before a prefetch occurs. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.store",
+ "optional": false,
+ "doc": "\n",
+ "name": "this"
+ },
+ {
+ "type": "Ext.data.Operation",
+ "optional": false,
+ "doc": "<p>The associated operation</p>\n",
+ "name": "operation"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "beforeprefetch",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Fires before a prefetch occurs. Return false to cancel.</p>\n",
+ "linenr": 344,
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforesync",
+ "shortDoc": "Called before a call to sync is executed. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Hash of all records to be synchronized, broken down into create, update and destroy</p>\n",
+ "name": "options"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "beforesync",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Called before a call to <a href=\"#/api/Ext.grid.property.Store-method-sync\" rel=\"Ext.grid.property.Store-method-sync\" class=\"docClass\">sync</a> is executed. Return false from any listener to cancel the synv</p>\n",
+ "linenr": 198,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-clear",
+ "shortDoc": "Fired after the removeAll method is called. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Store",
+ "optional": false,
+ "doc": "\n",
+ "name": "this"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "clear",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Fired after the <a href=\"#/api/Ext.grid.property.Store-method-removeAll\" rel=\"Ext.grid.property.Store-method-removeAll\" class=\"docClass\">removeAll</a> method is called.</p>\n",
+ "linenr": 204,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-datachanged",
+ "shortDoc": "Fires whenever the records in the Store have changed in some way - this could include adding or removing records,\nor ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Store",
+ "optional": false,
+ "doc": "<p>The data store</p>\n",
+ "name": "this"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "datachanged",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Fires whenever the records in the Store have changed in some way - this could include adding or removing records,\nor updating the data in existing records</p>\n",
+ "linenr": 173,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "Store2.html#Ext-data-Store-event-groupchange",
+ "shortDoc": "Fired whenever the grouping in the grid changes ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Store",
+ "optional": false,
+ "doc": "<p>The store</p>\n",
+ "name": "store"
+ },
+ {
+ "type": "Array",
+ "optional": false,
+ "doc": "<p>The array of grouper objects</p>\n",
+ "name": "groupers"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "groupchange",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Fired whenever the grouping in the grid changes</p>\n",
+ "linenr": 351,
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "Store2.html#Ext-data-Store-event-load",
+ "shortDoc": "Fires whenever records have been prefetched ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Store.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.store",
+ "optional": false,
+ "doc": "\n",
+ "name": "this"
+ },
+ {
+ "type": "Array",
+ "optional": false,
+ "doc": "<p>An array of records</p>\n",
+ "name": "records"
+ },
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>True if the operation was successful.</p>\n",
+ "name": "successful"
+ },
+ {
+ "type": "Ext.data.Operation",
+ "optional": false,
+ "doc": "<p>The associated operation</p>\n",
+ "name": "operation"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "load",
+ "owner": "Ext.data.Store",
+ "doc": "<p>Fires whenever records have been prefetched</p>\n",
+ "linenr": 358,
+ "html_filename": "Store2.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-remove",
+ "shortDoc": "Fired when a Model instance has been removed from this Store ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.data.Store",
+ "optional": false,
+ "doc": "<p>The Store object</p>\n",
+ "name": "store"
+ },
+ {
+ "type": "Ext.data.Model",
+ "optional": false,
+ "doc": "<p>The record that was removed</p>\n",
+ "name": "record"
+ },
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The index of the record that was removed</p>\n",
+ "name": "index"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "remove",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Fired when a Model instance has been removed from this Store</p>\n",
+ "linenr": 150,
+ "html_filename": "AbstractStore.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-update",
+ "shortDoc": "Fires when a Record has been updated ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Store",
+ "optional": false,
+ "doc": "\n",
+ "name": "this"
+ },
+ {
+ "type": "Ext.data.Model",
+ "optional": false,
+ "doc": "<p>The Model instance that was updated</p>\n",
+ "name": "record"
+ },
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The update operation being performed. Value may be one of:</p>\n\n<pre><code> Ext.data.Model.EDIT\n Ext.data.Model.REJECT\n Ext.data.Model.COMMIT\n</code></pre>\n\n",
+ "name": "operation"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "update",
+ "owner": "Ext.data.AbstractStore",
+ "doc": "<p>Fires when a Record has been updated</p>\n",
+ "linenr": 159,
+ "html_filename": "AbstractStore.html"
+ }
+ ]
+ },
+ "singleton": false,
+ "alias": null,
"superclasses": [
+ "Ext.Base",
"Ext.data.AbstractStore",
"Ext.data.Store"
],
+ "protected": false,
+ "tagname": "class",
+ "mixins": [
+
+ ],
+ "href": "Store.html#Ext-grid-property-Store",
"subclasses": [
],
+ "static": false,
+ "author": null,
+ "component": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/property/Store.js",
+ "private": false,
+ "alternateClassNames": [
+ "Ext.grid.PropertyStore"
+ ],
+ "name": "Ext.grid.property.Store",
+ "doc": "<p>A custom <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> for the <a href=\"#/api/Ext.grid.property.Grid\" rel=\"Ext.grid.property.Grid\" class=\"docClass\">Ext.grid.property.Grid</a>. This class handles the mapping\nbetween the custom data source objects supported by the grid and the <a href=\"#/api/Ext.grid.property.Property\" rel=\"Ext.grid.property.Property\" class=\"docClass\">Ext.grid.property.Property</a> format\nused by the <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> base class.</p>\n",
"mixedInto": [
],
- "allMixins": [
- "Ext.util.Observable",
- "Ext.util.Sortable"
- ]
+ "linenr": 1,
+ "xtypes": [
+
+ ],
+ "html_filename": "Store.html",
+ "extends": "Ext.data.Store"
});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff