X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.data.AbstractStore.js?ds=sidebyside diff --git a/docs/output/Ext.data.AbstractStore.js b/docs/output/Ext.data.AbstractStore.js index c5243471..f9fd527b 100644 --- a/docs/output/Ext.data.AbstractStore.js +++ b/docs/output/Ext.data.AbstractStore.js @@ -1,1309 +1 @@ -Ext.data.JsonP.Ext_data_AbstractStore({ - "tagname": "class", - "name": "Ext.data.AbstractStore", - "doc": "
AbstractStore is a superclass of Ext.data.Store and Ext.data.TreeStore. It's never used directly,\nbut offers a set of methods used by both of those subclasses.
\n\n\n\n\nWe've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what\nyou're probably looking for is Ext.data.Store. If you're still interested, here's a brief description of what \nAbstractStore is and is not.
\n\n\n\n\nAbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be \ngiven a Model that represents the type of data in the Store. It also expects to be given a \nProxy that handles the loading of data into the Store.
\n\n\n\n\nAbstractStore provides a few helpful methods such as load and sync, which load and save data\nrespectively, passing the requests through the configured proxy. Both built-in Store subclasses add extra\nbehavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - \nin Ext.data.Store the data is saved as a flat MixedCollection, whereas in\nTreeStore we use a Ext.data.Tree to maintain the data's hierarchy.
\n\n\nTODO: Update these docs to explain about the sortable and filterable mixins.
\n\nFinally, AbstractStore provides an API for sorting and filtering data via its sorters and filters\nMixedCollections. Although this functionality is provided by AbstractStore, there's a\ngood description of how to use it in the introduction of Ext.data.Store.\n\n", - "extends": null, - "mixins": [ - "Ext.util.Observable", - "Ext.util.Sortable" - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": "Ed Spencer", - "docauthor": null, - "singleton": false, - "private": false, - "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": "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});\n
\n\n\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 103,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-cfg-listeners",
- "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..."
- },
- {
- "tagname": "cfg",
- "name": "proxy",
- "member": "Ext.data.AbstractStore",
- "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/AbstractStore.js", - "linenr": 51, - "html_filename": "AbstractStore.html", - "href": "AbstractStore.html#Ext-data-AbstractStore-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": "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": "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');\n
\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 452,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addEvents",
- "shortDoc": "Adds the specified events to the list of events which this Observable may fire.
\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false - }, - { - "type": "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});\n
\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});
\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\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": "capture", - "member": "Ext.util.Observable", - "doc": "
Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to capture events from.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 383, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "Removes all listeners for this object including the managed listeners
\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "Removes all managed listeners for this object.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 412, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "Removes all managed listeners for this object.
\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget()
if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\n
\n\n",
- "params": [
- {
- "type": "String/Array",
- "name": "events",
- "doc": "The event name to bubble, or an Array of event names.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 554, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." - }, - { - "tagname": "method", - "name": "fireEvent", - "member": "Ext.util.Observable", - "doc": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\n", - "optional": false - }, - { - "type": "Object...", - "name": "args", - "doc": "Variable number of parameters are passed to handlers.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 232, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." - }, - { - "tagname": "method", - "name": "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": "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": "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": "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": "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": "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": "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": "load", - "member": "Ext.data.AbstractStore", - "doc": "Loads the Store using its configured proxy.
\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "Optional config object. This is passed into the Operation\nobject that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", - "linenr": 609, - "html_filename": "AbstractStore.html", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-load", - "shortDoc": "Loads the Store using its configured proxy.
\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});\n
\n",
- "params": [
- {
- "type": "Function",
- "name": "c",
- "doc": "The 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": "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": "removeAll", - "member": "Ext.data.AbstractStore", - "doc": "Removes all records from the store. This method does a \"fast remove\",\nindividual remove events are not called. The clear event is\nfired upon completion.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", - "linenr": 707, - "html_filename": "AbstractStore.html", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-removeAll", - "shortDoc": "Removes all records from the store. This method does a \"fast remove\",\nindividual remove events are not called. The cl..." - }, - { - "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]);\n
\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
\n\n\nIs equivalent to this code, because Store handles the toggling automatically:
\n\n\nstore.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\n\n",
- "params": [
- {
- "type": "String|Array",
- "name": "sorters",
- "doc": "Either 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": "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": "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": "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": "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": "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": "load", - "member": "Ext.data.AbstractStore", - "doc": "Fires whenever the store reads data from a remote data source.
\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 - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", - "linenr": 191, - "html_filename": "AbstractStore.html", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-load", - "shortDoc": "Fires whenever the store reads data from a remote data source.
\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\n
\n\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
- "linenr": 161,
- "html_filename": "AbstractStore.html",
- "href": "AbstractStore.html#Ext-data-AbstractStore-event-update",
- "shortDoc": "Fires when a Record has been updated
\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", - "linenr": 1, - "html_filename": "AbstractStore.html", - "href": "AbstractStore.html#Ext-data-AbstractStore", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - "Ext.data.NodeStore", - "Ext.data.Store", - "Ext.data.TreeStore" - ], - "mixedInto": [ - - ], - "allMixins": [ - "Ext.util.Observable", - "Ext.util.Sortable" - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_AbstractStore({"tagname":"class","html":"Hierarchy
Ext.BaseExt.data.AbstractStoreMixins
Requires
Files
AbstractStore is a superclass of Ext.data.Store and Ext.data.TreeStore. It's never used directly,\nbut offers a set of methods used by both of those subclasses.
\n\nWe've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what\nyou're probably looking for is Ext.data.Store. If you're still interested, here's a brief description of what\nAbstractStore is and is not.
\n\nAbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be\ngiven a Model that represents the type of data in the Store. It also expects to be given a\nProxy that handles the loading of data into the Store.
\n\nAbstractStore provides a few helpful methods such as load and sync, which load and save data\nrespectively, passing the requests through the configured proxy. Both built-in Store subclasses add extra\nbehavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data -\nin Ext.data.Store the data is saved as a flat MixedCollection, whereas in\nTreeStore we use a Ext.data.Tree to maintain the data's hierarchy.
\n\nThe store provides filtering and sorting support. This sorting/filtering can happen on the client side\nor can be completed on the server. This is controlled by the remoteSort and\nremoteFilter config options. For more information see the sort and\nfilter methods.
\nIf data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called\nafter creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.\nDefaults to false.
\nDefaults to: false
True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.
\nDefaults to: false
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\nconfig.
\nA config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from Ext JS Components
\n\nWhile some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element
option to identify the Component property to add a\nDOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\nName of the Model associated with this store.\nThe string is used as an argument for Ext.ModelManager.getModel.
\nThe Proxy to use for this Store. This can be either a string, a config object or a Proxy instance -\nsee setProxy for details.
\nUnique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager,\nmaking it easy to reuse elsewhere. Defaults to undefined.
\nSets 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.
\nThe string type of the Proxy to create if none is specified. This defaults to creating a\nmemory proxy.
\nThe default sort direction to use if one is not specified.
\nThe default sort direction to use if one is not specified.
\nIf 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
\nTrue if the Store has already been destroyed. If this is true, the reference to Store should be deleted\nas it will not function correctly any more.
\nFlag denoting that this object is sortable. Always true.
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nIf 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
\nThe property in each item that contains the data to sort.
\nThe property in each item that contains the data to sort.
\nAdds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all listeners for this object including the managed listeners
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nReturns 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)
\nThe Model instances
\nReturns the proxy currently attached to this proxy instance
\nThe Proxy instance
\nReturns any records that have been removed from the store but not yet destroyed on the proxy.
\nThe removed Model instances
\nReturns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\nThe updated Model instances
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nPerforms initialization of this mixin. Component classes using this mixin should call this method during their\nown initialization.
\nReturns true if the Store is currently performing a load operation
\nTrue if the Store is currently loading
\nLoads the Store using its configured proxy.
\nconfig object. This is passed into the Operation\nobject that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemoves all records from the store. This method does a \"fast remove\",\nindividual remove events are not called. The clear event is\nfired upon completion.
\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Sets the Store's Proxy by string, config object or Proxy instance
\nThe new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\nThe attached Proxy object
\nSorts the data in the Store by one or more of its properties. Example usage:
\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]);\n
\n\nInternally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates\nthe actual sorting to its internal Ext.util.MixedCollection.
\n\nWhen passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
\n\nstore.sort('myField');\nstore.sort('myField');\n
\n\nIs equivalent to this code, because Store handles the toggling automatically:
\n\nstore.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\nEither a string name of one of the fields in this Store's configured\nModel, or an array of sorter configurations.
\nThe overall direction to sort the data by. Defaults to \"ASC\".
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nSynchronizes 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.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\nFired when a Model instance has been added to this Store
\nThe store
\nThe Model instances that were added
\nThe index at which the instances were inserted
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a request is made for a new data object. If the beforeload handler returns false the load\naction will be canceled.
\nThis Store
\nThe Ext.data.Operation object that will be passed to the Proxy to\nload the Store
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFired before a call to sync is executed. Return false from any listener to cancel the synv
\nHash of all records to be synchronized, broken down into create, update and destroy
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFired after the removeAll method is called.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever the records in the Store have changed in some way - this could include adding or removing\nrecords, or updating the data in existing records
\nThe data store
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever the store reads data from a remote data source.
\nAn array of records
\nTrue if the operation was successful.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFired when a Model instance has been removed from this Store
\nThe Store object
\nThe record that was removed
\nThe index of the record that was removed
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when a Model instance has been updated
\nThe Model instance that was updated
\nThe update operation being performed. Value may be one of:
\n\nExt.data.Model.EDIT\nExt.data.Model.REJECT\nExt.data.Model.COMMIT\n
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever a successful write has been made via the configured Proxy
\nThis Store
\nThe Operation object that was used in\nthe write
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\n