Small helper class to make creating Ext.data.Stores from XML data easier.\nA XmlStore will be automatically configured with a Ext.data.reader.Xml.
\n\n\nA store configuration would be something like:\n
var store = new Ext.data.XmlStore({\n // store configs\n autoDestroy: true,\n storeId: 'myStore',\n url: 'sheldon.xml', // automatically configures a HttpProxy\n // reader configs\n record: 'Item', // records will have an \"Item\" tag\n idPath: 'ASIN',\n totalRecords: '@TotalResults'\n fields: [\n // set up the fields mapping into the xml doc\n // The first needs mapping, the others are very basic\n {name: 'Author', mapping: 'ItemAttributes > Author'},\n 'Title', 'Manufacturer', 'ProductGroup'\n ]\n});\nThis store is configured to consume a returned object of the form:\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ItemSearchResponse xmlns=\"http://webservices.amazon.com/AWSECommerceService/2009-05-15\">\n <Items>\n <Request>\n <IsValid>True</IsValid>\n <ItemSearchRequest>\n <Author>Sidney Sheldon</Author>\n <SearchIndex>Books</SearchIndex>\n </ItemSearchRequest>\n </Request>\n <TotalResults>203</TotalResults>\n <TotalPages>21</TotalPages>\n <Item>\n <ASIN>0446355453</ASIN>\n <DetailPageURL>\n http://www.amazon.com/\n </DetailPageURL>\n <ItemAttributes>\n <Author>Sidney Sheldon</Author>\n <Manufacturer>Warner Books</Manufacturer>\n <ProductGroup>Book</ProductGroup>\n <Title>Master of the Game</Title>\n </ItemAttributes>\n </Item>\n </Items>\n</ItemSearchResponse>\nNote: Although not listed here, this class accepts all of the configuration options of\nXmlReader.
\n\n", + "extends": "Ext.data.Store", + "mixins": [ + + ], + "alternateClassNames": [ + "Ext.data.XmlStore" + ], + "xtype": "xmlstore", + "author": "Ed Spencer", + "docauthor": null, + "singleton": false, + "private": true, + "cfg": [ + { + "tagname": "cfg", + "name": "autoLoad", + "member": "Ext.data.AbstractStore", + "type": "Boolean/Object", + "doc": "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.
\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": "True to automatically sync the Store with its Proxy after every edit to one of its Records.\nDefaults to false.
\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": "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.
\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": "True to empty the store when loading another page via loadPage,\nnextPage or previousPage (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.
\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": "Optional array of Model instances or data objects to load locally. See \"Inline data\" above for details.
\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": "This may be used in place of specifying a model configuration. The fields should be a\nset of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model\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 Ext.data.Model should be defined and specified for the model config.
\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": "(optional)
A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element option to\nidentify the Component property to add a DOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\nThe Ext.data.Model associated with this store
\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": "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.
\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": "The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see setProxy for details.
\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": "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 buffered option is set to true.
\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": "True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to false.
\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": "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.
\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": "True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to false.
\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": "For local filtering only, causes sort to be called whenever filter is called,\ncausing the sorters to be reapplied after filtering. Defaults to true
\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": "Optional unique identifier for this store. If present, this Store will be registered with\nthe Ext.data.StoreManager, making it easy to reuse elsewhere. Defaults to undefined.
\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": "XmlStore", + "member": "Ext.data.XmlStore", + "doc": "\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/XmlStore.js", + "linenr": 1, + "html_filename": "XmlStore.html", + "href": "XmlStore.html#Ext-data-XmlStore-method-constructor", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "add", + "member": "Ext.data.Store", + "doc": "Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already-\ninstantiated Models, use insert 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:
\n\nmyStore.add({some: 'data'}, {some: 'other data'});\nThe data for each model
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "The array of newly created model instances
\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": "Adds the specified events to the list of events which this Observable may fire.
\n", + "params": [ + { + "type": "Object/String", + "name": "o", + "doc": "Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n" + }, + { + "tagname": "method", + "name": "addListener", + "member": "Ext.util.Observable", + "doc": "Appends an event handler to this object.
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\n\n\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n
myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n\n\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 271, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "
Appends an event handler to this object.
\n" + }, + { + "tagname": "method", + "name": "addManagedListener", + "member": "Ext.util.Observable", + "doc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", + "params": [ + { + "type": "Observable/Element", + "name": "item", + "doc": "
The item to which to add a listener/listeners.
\n", + "optional": false + }, + { + "type": "Object/String", + "name": "ename", + "doc": "The event name, or an object containing event name properties.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
Optional. If the ename parameter was an event name, this\nis the addListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" + }, + { + "tagname": "method", + "name": "aggregate", + "member": "Ext.data.Store", + "doc": "
Runs the aggregate function for all the records in the store.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The function to execute. The function is called with a single parameter,\nan array of records for that group.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope to execute the function in. Defaults to the store.
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + }, + { + "type": "Array", + "name": "args", + "doc": "(optional) Any arguments to append to the function call
\n", + "optional": true + } + ], + "return": { + "type": "Object", + "doc": "An object literal with the group names and their appropriate values.
\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": "Runs the aggregate function for all the records in the store.
\n" + }, + { + "tagname": "method", + "name": "average", + "member": "Ext.data.Store", + "doc": "Gets the average value in the store.
\n", + "params": [ + { + "type": "String", + "name": "field", + "doc": "The field in each record
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Mixed/undefined", + "doc": "The average value, if no items exist, 0.
\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": "Gets the average value in the store.
\n" + }, + { + "tagname": "method", + "name": "capture", + "member": "Ext.util.Observable", + "doc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "The Observable to capture events from.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "The function to call when an event is fired.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Revert to a view of the Record cache with no filtering applied.
\n", + "params": [ + { + "type": "Boolean", + "name": "suppressEvent", + "doc": "If true the filter is cleared silently without firing the\ndatachanged event.
\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": "Revert to a view of the Record cache with no filtering applied.
\n" + }, + { + "tagname": "method", + "name": "clearGrouping", + "member": "Ext.data.Store", + "doc": "Clear any groupers in the store
\n", + "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": "Clear any groupers in the store
\n" + }, + { + "tagname": "method", + "name": "clearListeners", + "member": "Ext.util.Observable", + "doc": "Removes all listeners for this object including the managed listeners
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 383, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners
\n" + }, + { + "tagname": "method", + "name": "clearManagedListeners", + "member": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 412, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "Removes all managed listeners for this object.
\n" + }, + { + "tagname": "method", + "name": "collect", + "member": "Ext.data.Store", + "doc": "Collects unique values for a particular dataIndex from this store.
\n", + "params": [ + { + "type": "String", + "name": "dataIndex", + "doc": "The property to collect
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "allowNull", + "doc": "(optional) Pass true to allow null, undefined or empty string values
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "bypassFilter", + "doc": "(optional) Pass true to collect from all records, even ones which are filtered
\n", + "optional": true + } + ], + "return": { + "type": "Array", + "doc": "An array of the unique values
\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": "Collects unique values for a particular dataIndex from this store.
\n" + }, + { + "tagname": "method", + "name": "count", + "member": "Ext.data.Store", + "doc": "Gets the count of items in the store.
\n", + "params": [ + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "the count
\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": "Gets the count of items in the store.
\n" + }, + { + "tagname": "method", + "name": "each", + "member": "Ext.data.Store", + "doc": "Calls the specified function for each of the Records in the cache.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the function is executed.\nDefaults to the current Record in the iteration.
Calls the specified function for each of the Records in the cache.
\n" + }, + { + "tagname": "method", + "name": "enableBubble", + "member": "Ext.util.Observable", + "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\nThe event name to bubble, or an Array of event names.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 554, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." + }, + { + "tagname": "method", + "name": "filter", + "member": "Ext.data.Store", + "doc": "Filters the loaded set of records by a given set of filters.
\n", + "params": [ + { + "type": "Mixed", + "name": "filters", + "doc": "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 MixedCollection. See\nMixedCollection's filter method for filter syntax. Alternatively,\npass in a property string
\n", + "optional": false + }, + { + "type": "String", + "name": "value", + "doc": "Optional value to filter by (only if using a property string as the first argument)
\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": "Filters the loaded set of records by a given set of filters.
\n" + }, + { + "tagname": "method", + "name": "filterBy", + "member": "Ext.data.Store", + "doc": "Filter by a function. The specified function will be called for each\nRecord in this Store. If the function returns true the Record is included,\notherwise it is filtered out.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The function to be called. It will be passed the following parameters:
The record\nto test for filtering. Access field values using Ext.data.Model.get.
The ID of the Record passed.
(optional) The scope (this reference) in which the function is executed. Defaults to this Store.
Finds the index of the first matching Record in this store by a specific field value.
\n", + "params": [ + { + "type": "String", + "name": "fieldName", + "doc": "The name of the Record field to test.
\n", + "optional": false + }, + { + "type": "String/RegExp", + "name": "value", + "doc": "Either a string that the field value\nshould begin with, or a RegExp to test against the field.
\n", + "optional": false + }, + { + "type": "Number", + "name": "startIndex", + "doc": "(optional) The index to start searching at
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "anyMatch", + "doc": "(optional) True to match any part of the string, not just the beginning
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "caseSensitive", + "doc": "(optional) True for case sensitive comparison
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "exactMatch", + "doc": "True to force exact match (^ and $ characters added to the regex). Defaults to false.
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The matched index or -1
\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": "Finds the index of the first matching Record in this store by a specific field value.
\n" + }, + { + "tagname": "method", + "name": "findBy", + "member": "Ext.data.Store", + "doc": "Find the index of the first matching Record in this Store by a function.\nIf the function returns true it is considered a match.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The function to be called. It will be passed the following parameters:
The record\nto test for filtering. Access field values using Ext.data.Model.get.
The ID of the Record passed.
(optional) The scope (this reference) in which the function is executed. Defaults to this Store.
(optional) The index to start searching at
\n", + "optional": true + } + ], + "return": { + "type": "Number", + "doc": "The matched index or -1
\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": "Finds the index of the first matching Record in this store by a specific field value.
\n", + "params": [ + { + "type": "String", + "name": "fieldName", + "doc": "The name of the Record field to test.
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "value", + "doc": "The value to match the field against.
\n", + "optional": false + }, + { + "type": "Number", + "name": "startIndex", + "doc": "(optional) The index to start searching at
\n", + "optional": true + } + ], + "return": { + "type": "Number", + "doc": "The matched index or -1
\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": "Finds the index of the first matching Record in this store by a specific field value.
\n" + }, + { + "tagname": "method", + "name": "findRecord", + "member": "Ext.data.Store", + "doc": "Finds the first matching Record in this store by a specific field value.
\n", + "params": [ + { + "type": "String", + "name": "fieldName", + "doc": "The name of the Record field to test.
\n", + "optional": false + }, + { + "type": "String/RegExp", + "name": "value", + "doc": "Either a string that the field value\nshould begin with, or a RegExp to test against the field.
\n", + "optional": false + }, + { + "type": "Number", + "name": "startIndex", + "doc": "(optional) The index to start searching at
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "anyMatch", + "doc": "(optional) True to match any part of the string, not just the beginning
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "caseSensitive", + "doc": "(optional) True for case sensitive comparison
\n", + "optional": true + }, + { + "type": "Boolean", + "name": "exactMatch", + "doc": "True to force exact match (^ and $ characters added to the regex). Defaults to false.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.Model", + "doc": "The matched record or null
\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": "Finds the first matching Record in this store by a specific field value.
\n" + }, + { + "tagname": "method", + "name": "fireEvent", + "member": "Ext.util.Observable", + "doc": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to fire.
\n", + "optional": false + }, + { + "type": "Object...", + "name": "args", + "doc": "Variable number of parameters are passed to handlers.
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 232, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-fireEvent", + "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." + }, + { + "tagname": "method", + "name": "first", + "member": "Ext.data.Store", + "doc": "Convenience function for getting the first model instance in the store
\n", + "params": [ + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.Model/undefined", + "doc": "The first model instance in the store, or undefined
\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": "Convenience function for getting the first model instance in the store
\n" + }, + { + "tagname": "method", + "name": "getAt", + "member": "Ext.data.Store", + "doc": "Get the Record at the specified index.
\n", + "params": [ + { + "type": "Number", + "name": "index", + "doc": "The index of the Record to find.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.Model", + "doc": "The Record at the passed index. Returns undefined if not found.
\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": "Get the Record at the specified index.
\n" + }, + { + "tagname": "method", + "name": "getById", + "member": "Ext.data.Store", + "doc": "Get the Record with the specified id.
\n", + "params": [ + { + "type": "String", + "name": "id", + "doc": "The id of the Record to find.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.Model", + "doc": "The Record with the passed id. Returns undefined if not found.
\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": "Get the Record with the specified id.
\n" + }, + { + "tagname": "method", + "name": "getCount", + "member": "Ext.data.Store", + "doc": "Gets the number of cached records.
\n\nIf 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 getTotalCount function returns\nthe dataset size. Note: see the Important note in load.
\n\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "The number of Records in the Store's cache.
\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": "Returns the string to group on for a given model instance. The default implementation of this method returns\nthe model's groupField, 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:
\n\n\nnew Ext.data.Store({\n groupDir: 'ASC',\n getGroupString: function(instance) {\n return instance.get('name')[0];\n }\n});\nThe model instance
\n", + "optional": false + } + ], + "return": { + "type": "String", + "doc": "The string to compare when forming groups
\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": "Returns an object containing the result of applying grouping to the records in this store. See groupField,\ngroupDir and getGroupString. Example for a store containing records with a color field:
\n\nvar 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(Optional) Pass in an optional groupName argument to access a specific group as defined by getGroupString
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "The grouped data
\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": "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)
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The Model instances
\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": "Determines the page from a record index
\n", + "params": [ + { + "type": "Number", + "name": "index", + "doc": "The record index
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The page the record belongs to
\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": "Determines the page from a record index
\n" + }, + { + "tagname": "method", + "name": "getProxy", + "member": "Ext.data.AbstractStore", + "doc": "Returns the proxy currently attached to this proxy instance
\n", + "params": [ + + ], + "return": { + "type": "Ext.data.proxy.Proxy", + "doc": "The Proxy instance
\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": "Returns the proxy currently attached to this proxy instance
\n" + }, + { + "tagname": "method", + "name": "getRange", + "member": "Ext.data.Store", + "doc": "Returns a range of Records between specified indices.
\n", + "params": [ + { + "type": "Number", + "name": "startIndex", + "doc": "(optional) The starting index (defaults to 0)
\n", + "optional": true + }, + { + "type": "Number", + "name": "endIndex", + "doc": "(optional) The ending index (defaults to the last Record in the Store)
\n", + "optional": true + } + ], + "return": { + "type": "Ext.data.Model[]", + "doc": "An array of Records
\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": "Returns a range of Records between specified indices.
\n" + }, + { + "tagname": "method", + "name": "getRemovedRecords", + "member": "Ext.data.AbstractStore", + "doc": "Returns any records that have been removed from the store but not yet destroyed on the proxy.
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The removed Model instances
\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": "Returns any records that have been removed from the store but not yet destroyed on the proxy.
\n" + }, + { + "tagname": "method", + "name": "getTotalCount", + "member": "Ext.data.Store", + "doc": "Returns the total number of Model instances that the Proxy\nindicates exist. This will usually differ from getCount 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
\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "The total number of Model instances available via the Proxy
\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": "Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The updated Model instances
\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": "Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\n" + }, + { + "tagname": "method", + "name": "group", + "member": "Ext.data.Store", + "doc": "Group data in the store
\n", + "params": [ + { + "type": "String|Array", + "name": "groupers", + "doc": "Either a string name of one of the fields in this Store's configured Model,\nor an Array of grouper configurations.
\n", + "optional": false + }, + { + "type": "String", + "name": "direction", + "doc": "The overall direction to group the data by. Defaults to \"ASC\".
\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": "Group data in the store
\n" + }, + { + "tagname": "method", + "name": "guaranteeRange", + "member": "Ext.data.Store", + "doc": "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.
\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": "Checks to see if this object has any listeners for a specified event
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to check for
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if the event is being listened for, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 480, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event
\n" + }, + { + "tagname": "method", + "name": "hasPendingRequests", + "member": "Ext.data.Store", + "doc": "Returns the number of pending requests out.
\n", + "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": "Returns the number of pending requests out.
\n" + }, + { + "tagname": "method", + "name": "indexOf", + "member": "Ext.data.Store", + "doc": "Get the index within the cache of the passed Record.
\n", + "params": [ + { + "type": "Ext.data.Model", + "name": "record", + "doc": "The Ext.data.Model object to find.
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The index of the passed Record. Returns -1 if not found.
\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": "Get the index within the cache of the passed Record.
\n" + }, + { + "tagname": "method", + "name": "indexOfId", + "member": "Ext.data.Store", + "doc": "Get the index within the cache of the Record with the passed id.
\n", + "params": [ + { + "type": "String", + "name": "id", + "doc": "The id of the Record to find.
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The index of the Record. Returns -1 if not found.
\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": "Get the index within the cache of the Record with the passed id.
\n" + }, + { + "tagname": "method", + "name": "indexOfTotal", + "member": "Ext.data.Store", + "doc": "Get the index within the entire dataset. From 0 to the totalCount.
\n", + "params": [ + { + "type": "Ext.data.Model", + "name": "record", + "doc": "The Ext.data.Model object to find.
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The index of the passed Record. Returns -1 if not found.
\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": "Get the index within the entire dataset. From 0 to the totalCount.
\n" + }, + { + "tagname": "method", + "name": "initSortable", + "member": "Ext.util.Sortable", + "doc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.
\n", + "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": "Inserts Model instances into the Store at the given index and fires the add event.\nSee also add.
The start index at which to insert the passed Records.
\n", + "optional": false + }, + { + "type": "Ext.data.Model[]", + "name": "records", + "doc": "An Array of Ext.data.Model objects to add to the cache.
\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": "Inserts Model instances into the Store at the given index and fires the add event.\nSee also add.
Returns true if this store is currently filtered
\n", + "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": "Returns true if this store is currently filtered
\n" + }, + { + "tagname": "method", + "name": "isGrouped", + "member": "Ext.data.Store", + "doc": "Checks if the store is currently grouped
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the store is grouped.
\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": "Checks if the store is currently grouped
\n" + }, + { + "tagname": "method", + "name": "isLoading", + "member": "Ext.data.AbstractStore", + "doc": "Returns true if the Store is currently performing a load operation
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the Store is currently loading
\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": "Returns true if the Store is currently performing a load operation
\n" + }, + { + "tagname": "method", + "name": "last", + "member": "Ext.data.Store", + "doc": "Convenience function for getting the last model instance in the store
\n", + "params": [ + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.Model/undefined", + "doc": "The last model instance in the store, or undefined
\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": "Convenience function for getting the last model instance in the store
\n" + }, + { + "tagname": "method", + "name": "load", + "member": "Ext.data.Store", + "doc": "Loads data into the Store via the configured proxy. 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:
\n\n\n\n\nstore.load({\n scope : this,\n callback: function(records, operation, success) {\n //the operation object contains all of the details of the load operation\n console.log(records);\n }\n});\nIf the callback scope does not need to be set, a function can simply be passed:
\n\n\n\n\nstore.load(function(records, operation, success) {\n console.log('loaded records');\n});\nOptional config object, passed into the Ext.data.Operation object before loading.
\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": "Loads an array of data straight into the Store
\n", + "params": [ + { + "type": "Array", + "name": "data", + "doc": "Array of data to load. Any non-model instances will be cast into model instances first
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "append", + "doc": "True to add the records to the existing records in the store, false to remove the old ones first
\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": "Loads an array of data straight into the Store
\n" + }, + { + "tagname": "method", + "name": "loadPage", + "member": "Ext.data.Store", + "doc": "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
\n", + "params": [ + { + "type": "Number", + "name": "page", + "doc": "The number of the page to load
\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": "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 Proxy, when adding records manually use add instead
\n", + "params": [ + { + "type": "Array", + "name": "records", + "doc": "The array of records to load
\n", + "optional": false + }, + { + "type": "Object", + "name": "options", + "doc": "{addRecords: true} to add these records to the existing records, false to remove the Store's existing records first
\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": "Gets the maximum value in the store.
\n", + "params": [ + { + "type": "String", + "name": "field", + "doc": "The field in each record
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Mixed/undefined", + "doc": "The maximum value, if no items exist, undefined.
\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": "Gets the maximum value in the store.
\n" + }, + { + "tagname": "method", + "name": "min", + "member": "Ext.data.Store", + "doc": "Gets the minimum value in the store.
\n", + "params": [ + { + "type": "String", + "name": "field", + "doc": "The field in each record
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Mixed/undefined", + "doc": "The minimum value, if no items exist, undefined.
\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": "Gets the minimum value in the store.
\n" + }, + { + "tagname": "method", + "name": "nextPage", + "member": "Ext.data.Store", + "doc": "Loads the next 'page' in the current data set
\n", + "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": "Loads the next 'page' in the current data set
\n" + }, + { + "tagname": "method", + "name": "observe", + "member": "Ext.util.Observable", + "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\nThe class constructor to make observable.
\n", + "optional": false + }, + { + "type": "Object", + "name": "listeners", + "doc": "An object containing a series of listeners to add. See addListener.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 69, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." + }, + { + "tagname": "method", + "name": "on", + "member": "Ext.util.Observable", + "doc": "Appends an event handler to this object (shorthand for addListener.)
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The type of event to listen for
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 616, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "Appends an event handler to this object (shorthand for addListener.)
\n" + }, + { + "tagname": "method", + "name": "prefetch", + "member": "Ext.data.Store", + "doc": "Prefetches data the Store using its configured proxy.
\n", + "params": [ + { + "type": "Object", + "name": "options", + "doc": "Optional config object, passed into the Ext.data.Operation object before loading.\nSee load
\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": "Prefetches data the Store using its configured proxy.
\n" + }, + { + "tagname": "method", + "name": "prefetchPage", + "member": "Ext.data.Store", + "doc": "Prefetches a page of data.
\n", + "params": [ + { + "type": "Number", + "name": "page", + "doc": "The page to prefetch
\n", + "optional": false + }, + { + "type": "Object", + "name": "options", + "doc": "Optional config object, passed into the Ext.data.Operation object before loading.\nSee load
\n", + "optional": false + }, + { + "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": "Prefetches a page of data.
\n" + }, + { + "tagname": "method", + "name": "previousPage", + "member": "Ext.data.Store", + "doc": "Loads the previous 'page' in the current data set
\n", + "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": "Loads the previous 'page' in the current data set
\n" + }, + { + "tagname": "method", + "name": "purgeRecords", + "member": "Ext.data.Store", + "doc": "Purge the least recently used records in the prefetch if the purgeCount\nhas been exceeded.
\n", + "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": "Purge the least recently used records in the prefetch if the purgeCount\nhas been exceeded.
\n" + }, + { + "tagname": "method", + "name": "queryBy", + "member": "Ext.data.Store", + "doc": "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 true the record is\nincluded in the results.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The function to be called. It will be passed the following parameters:
The record\nto test for filtering. Access field values using Ext.data.Model.get.
The ID of the Record passed.
(optional) The scope (this reference) in which the function is executed. Defaults to this Store.
Returns an Ext.util.MixedCollection of the matched records
\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": "Relays selected events from the specified Observable as if the events were fired by this.
The Observable whose events this object is to relay.
\n", + "optional": false + }, + { + "type": "Array", + "name": "events", + "doc": "Array of event names to relay.
\n", + "optional": false + }, + { + "type": "Object", + "name": "prefix", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 520, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this.
Removes all added captures from the Observable.
\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "The Observable to release
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 46, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "Removes all added captures from the Observable.
\n" + }, + { + "tagname": "method", + "name": "remove", + "member": "Ext.data.Store", + "doc": "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.
\n", + "params": [ + { + "type": "Ext.data.Model/Array", + "name": "records", + "doc": "The Ext.data.Model instance or array of instances to remove
\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": "Remove all items from the store.
\n", + "params": [ + { + "type": "Boolean", + "name": "silent", + "doc": "Prevent the clear event from being fired.
Remove all items from the store.
\n" + }, + { + "tagname": "method", + "name": "removeAt", + "member": "Ext.data.Store", + "doc": "Removes the model instance at the given index
\n", + "params": [ + { + "type": "Number", + "name": "index", + "doc": "The record index
\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": "Removes the model instance at the given index
\n" + }, + { + "tagname": "method", + "name": "removeListener", + "member": "Ext.util.Observable", + "doc": "Removes an event handler.
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The type of event the handler was associated with.
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope originally specified for the handler.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 352, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler.
\n" + }, + { + "tagname": "method", + "name": "removeManagedListener", + "member": "Ext.util.Observable", + "doc": "Removes listeners that were added by the mon method.
\n", + "params": [ + { + "type": "Observable|Element", + "name": "item", + "doc": "The item from which to remove a listener/listeners.
\n", + "optional": false + }, + { + "type": "Object|String", + "name": "ename", + "doc": "The event name, or an object containing event name properties.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
Removes listeners that were added by the mon method.
\n" + }, + { + "tagname": "method", + "name": "resumeEvents", + "member": "Ext.util.Observable", + "doc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.
Sets the Store's Proxy by string, config object or Proxy instance
\n", + "params": [ + { + "type": "String|Object|Ext.data.proxy.Proxy", + "name": "proxy", + "doc": "The new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.proxy.Proxy", + "doc": "The attached Proxy object
\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": "Sets the Store's Proxy by string, config object or Proxy instance
\n" + }, + { + "tagname": "method", + "name": "sort", + "member": "Ext.util.Sortable", + "doc": "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('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]);\nInternally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual\nsorting to its internal Ext.util.MixedCollection.
\n\n\nWhen passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
\n\n\nstore.sort('myField');\nstore.sort('myField');\n Is equivalent to this code, because Store handles the toggling automatically:
\n\n\nstore.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\nEither a string name of one of the fields in this Store's configured Model,\nor an Array of sorter configurations.
\n", + "optional": false + }, + { + "type": "String", + "name": "direction", + "doc": "The overall direction to sort the data by. Defaults to \"ASC\".
\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": "Sums the value of property for each record between start\nand end and returns the result.
\n", + "params": [ + { + "type": "String", + "name": "field", + "doc": "A field in each record
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "grouped", + "doc": "(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.
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The sum
\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": "Sums the value of property for each record between start\nand end and returns the result.
\n" + }, + { + "tagname": "method", + "name": "suspendEvents", + "member": "Ext.util.Observable", + "doc": "Suspend the firing of all events. (see resumeEvents)
\n", + "params": [ + { + "type": "Boolean", + "name": "queueSuspended", + "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 490, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "Suspend the firing of all events. (see resumeEvents)
\n" + }, + { + "tagname": "method", + "name": "sync", + "member": "Ext.data.AbstractStore", + "doc": "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.
\n", + "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": "Removes an event handler (shorthand for removeListener.)
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The type of event the handler was associated with.
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope originally specified for the handler.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 608, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Removes an event handler (shorthand for removeListener.)
\n" + } + ], + "property": [ + { + "tagname": "property", + "name": "batchUpdateMode", + "member": "Ext.data.AbstractStore", + "type": "String", + "doc": "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.
\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": "The page that the Store has most recently loaded (see loadPage)
\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": "The MixedCollection that holds this store's local cache of records
\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": "The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.
\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": "The default sort direction to use if one is not specified (defaults to \"ASC\")
\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": "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 remoteFilter is true
\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": "The collection of Filters currently applied to this Store
\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": "The direction in which sorting should be applied when grouping. Defaults to \"ASC\" - the other supported value is \"DESC\"
\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": "The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the\ngroupField and groupDir are injected as the first sorter (see sort). Stores support a single\nlevel of grouping, and groups can be fetched via the getGroups method.
\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": "The collection of Groupers currently applied to this Store
\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": "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.
\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": "Flag denoting that this object is sortable. Always true.
\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": "A pristine (unfiltered) collection of the records in this store. This is used to reinstate\nrecords when a filter is removed or changed
\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": "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 remoteSort is true
\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": "The property in each item that contains the data to sort. (defaults to null)
\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": "The collection of Sorters currently applied to this Store
\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": "Fired when a Model instance has been added to this Store
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "store", + "doc": "The store
\n", + "optional": false + }, + { + "type": "Array", + "name": "records", + "doc": "The Model instances that were added
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index at which the instances were inserted
\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": "Fired when a Model instance has been added to this Store
\n" + }, + { + "tagname": "event", + "name": "beforeload", + "member": "Ext.data.AbstractStore", + "doc": "Event description
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "store", + "doc": "This Store
\n", + "optional": false + }, + { + "type": "Ext.data.Operation", + "name": "operation", + "doc": "The Ext.data.Operation object that will be passed to the Proxy to load the Store
\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": "Event description
\n" + }, + { + "tagname": "event", + "name": "beforeprefetch", + "member": "Ext.data.Store", + "doc": "Fires before a prefetch occurs. Return false to cancel.
\n", + "params": [ + { + "type": "Ext.data.store", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.data.Operation", + "name": "operation", + "doc": "The associated operation
\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": "Fires before a prefetch occurs. Return false to cancel.
\n" + }, + { + "tagname": "event", + "name": "beforesync", + "member": "Ext.data.AbstractStore", + "doc": "Called before a call to sync is executed. Return false from any listener to cancel the synv
\n", + "params": [ + { + "type": "Object", + "name": "options", + "doc": "Hash of all records to be synchronized, broken down into create, update and destroy
\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": "Called before a call to sync is executed. Return false from any listener to cancel the synv
\n" + }, + { + "tagname": "event", + "name": "clear", + "member": "Ext.data.AbstractStore", + "doc": "Fired after the removeAll method is called.
\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": "Fired after the removeAll method is called.
\n" + }, + { + "tagname": "event", + "name": "datachanged", + "member": "Ext.data.AbstractStore", + "doc": "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
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "this", + "doc": "The data store
\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": "Fired whenever the grouping in the grid changes
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "store", + "doc": "The store
\n", + "optional": false + }, + { + "type": "Array", + "name": "groupers", + "doc": "The array of grouper objects
\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": "Fired whenever the grouping in the grid changes
\n" + }, + { + "tagname": "event", + "name": "load", + "member": "Ext.data.Store", + "doc": "Fires whenever records have been prefetched
\n", + "params": [ + { + "type": "Ext.data.store", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Array", + "name": "records", + "doc": "An array of records
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "successful", + "doc": "True if the operation was successful.
\n", + "optional": false + }, + { + "type": "Ext.data.Operation", + "name": "operation", + "doc": "The associated operation
\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": "Fires whenever records have been prefetched
\n" + }, + { + "tagname": "event", + "name": "remove", + "member": "Ext.data.AbstractStore", + "doc": "Fired when a Model instance has been removed from this Store
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "store", + "doc": "The Store object
\n", + "optional": false + }, + { + "type": "Ext.data.Model", + "name": "record", + "doc": "The record that was removed
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index of the record that was removed
\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": "Fired when a Model instance has been removed from this Store
\n" + }, + { + "tagname": "event", + "name": "update", + "member": "Ext.data.AbstractStore", + "doc": "Fires when a Record has been updated
\n", + "params": [ + { + "type": "Store", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.data.Model", + "name": "record", + "doc": "The Model instance that was updated
\n", + "optional": false + }, + { + "type": "String", + "name": "operation", + "doc": "The update operation being performed. Value may be one of:
\n\n Ext.data.Model.EDIT\n Ext.data.Model.REJECT\n Ext.data.Model.COMMIT\nFires when a Record has been updated
\n" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/XmlStore.js", + "linenr": 1, + "html_filename": "XmlStore.html", + "href": "XmlStore.html#Ext-data-XmlStore", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + "Ext.data.AbstractStore", + "Ext.data.Store" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.util.Observable", + "Ext.util.Sortable" + ] +}); \ No newline at end of file