X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.data.JsonPStore.js diff --git a/docs/output/Ext.data.JsonPStore.js b/docs/output/Ext.data.JsonPStore.js new file mode 100644 index 00000000..61bd8d61 --- /dev/null +++ b/docs/output/Ext.data.JsonPStore.js @@ -0,0 +1 @@ +Ext.data.JsonP.Ext_data_JsonPStore({"tagname":"class","html":"
Hierarchy
Ext.BaseExt.data.AbstractStoreExt.data.StoreExt.data.JsonPStoreMixins
Files
NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.
Small helper class to make creating Ext.data.Stores from different domain JSON data easier.\nA JsonPStore will be automatically configured with a Ext.data.reader.Json and a JsonPProxy.
\n\n\nA store configuration would be something like:\n
var store = new Ext.data.JsonPStore({\n // store configs\n autoDestroy: true,\n storeId: 'myStore',\n\n // proxy configs\n url: 'get-images.php',\n\n // reader configs\n root: 'images',\n idProperty: 'name',\n fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}]\n});\n
\n\n\nThis store is configured to consume a returned object of the form:\n
stcCallback({\n images: [\n {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)},\n {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)}\n ]\n})\n
\nWhere stcCallback is the callback name passed in the request to the remote domain. See JsonPProxy\nfor details of how this works.
\nAn object literal of this form could also be used as the data config option.\n\n\n*Note: Although not listed here, this class accepts all of the configuration options of\nJsonReader and JsonPProxy.
\n\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
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.
\nDefaults to: false
True to empty the store when loading another page via loadPage,\nnextPage or previousPage. Setting to false keeps existing records, allowing\nlarge data sets to be loaded one page at a time but rendered all together.
\nDefaults to: true
Optional array of Model instances or data objects to load locally. See \"Inline data\" above for details.
\nThis 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 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.
\nDefaults to: 25
The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see setProxy for details.
\nThe 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.
\nDefaults to: 5
True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to false.
\nDefaults to: false
True if the grouping should apply on the server side, false if it is local only. 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.
\nDefaults to: false
True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to false.
\nDefaults to: false
Unique 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 MixedCollection that holds this store's local cache of records
\nThe MixedCollection that holds this store's local cache of records
\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
\nThe direction in which sorting should be applied when grouping. Defaults to \"ASC\" - the other supported value is \"DESC\"
\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
\nA pristine (unfiltered) collection of the records in this store. This is used to reinstate\nrecords when a filter is removed or changed
\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 Model instance to the Store. This method accepts either:
\n\nThe new Model instances will be added at the end of the existing collection.
\n\nSample usage:
\n\nmyStore.add({some: 'data'}, {some: 'other data'});\n
\nAn array of Model instances\nor Model configuration objects, or variable number of Model instance or config arguments.
\nThe model instances that were added
\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.
Runs the aggregate function for all the records in the store.
\nThe function to execute. The function is called with a single parameter,\nan array of records for that group.
\nThe scope to execute the function in. Defaults to the store.
\nTrue 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.
\nAny arguments to append to the function call
\nAn object literal with the group names and their appropriate values.
\nGets the average value in the store.
\nThe field in each record
\nTrue 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.
\nThe average value, if no items exist, 0.
\nCall 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
\nRevert to a view of the Record cache with no filtering applied.
\nIf true the filter is cleared silently without firing the\ndatachanged event.
\nRemoves all listeners for this object including the managed listeners
\nCollects unique values for a particular dataIndex from this store.
\nThe property to collect
\nPass true to allow null, undefined or empty string values
\nPass true to collect from all records, even ones which are filtered
\nAn array of the unique values
\nGets the count of items in the store.
\nTrue 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.
\nthe count
\nCalls the specified function for each of the Records in the cache.
\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
\nFilters the loaded set of records by a given set of filters.
\n\nFiltering by single field:
\n\nstore.filter(\"email\", /\\.com$/);\n
\n\nUsing multiple filters:
\n\nstore.filter([\n {property: \"email\", value: /\\.com$/},\n {filterFn: function(item) { return item.get(\"age\") > 10; }}\n]);\n
\n\nUsing Ext.util.Filter instances instead of config objects\n(note that we need to specify the root config option in this case):
\n\nstore.filter([\n Ext.create('Ext.util.Filter', {property: \"email\", value: /\\.com$/, root: 'data'}),\n Ext.create('Ext.util.Filter', {filterFn: function(item) { return item.get(\"age\") > 10; }, root: 'data'})\n]);\n
\nThe 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
\nvalue to filter by (only if using a property string as the first argument)
\nFilter 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.
\nThe 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.
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.
\nThe name of the Record field to test.
\nEither a string that the field value\nshould begin with, or a RegExp to test against the field.
\nThe index to start searching at
\nTrue to match any part of the string, not just the beginning
\nTrue for case sensitive comparison
\nTrue to force exact match (^ and $ characters added to the regex). Defaults to false.
\nThe matched index or -1
\nFind the index of the first matching Record in this Store by a function.\nIf the function returns true it is considered a match.
\nThe 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.
The scope (this
reference) in which the function is executed. Defaults to this Store.
The index to start searching at
\nThe matched index or -1
\nFinds the index of the first matching Record in this store by a specific field value.
\nThe name of the Record field to test.
\nThe value to match the field against.
\nThe index to start searching at
\nThe matched index or -1
\nFinds the first matching Record in this store by a specific field value.
\nThe name of the Record field to test.
\nEither a string that the field value\nshould begin with, or a RegExp to test against the field.
\nThe index to start searching at
\nTrue to match any part of the string, not just the beginning
\nTrue for case sensitive comparison
\nTrue to force exact match (^ and $ characters added to the regex). Defaults to false.
\nThe matched record or null
\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.
\nConvenience function for getting the first model instance in the store
\nTrue 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.
\nThe first model instance in the store, or undefined
\nGet the Record at the specified index.
\nThe index of the Record to find.
\nThe Record at the passed index. Returns undefined if not found.
\nGet the Record with the specified id.
\nThe id of the Record to find.
\nThe Record with the passed id. Returns null if not found.
\nGets 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\nThe number of Records in the Store's cache.
\nReturns 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\nExt.create('Ext.data.Store', {\n groupDir: 'ASC',\n getGroupString: function(instance) {\n return instance.get('name')[0];\n }\n});\n
\n\nThe model instance
\nThe string to compare when forming groups
\nReturns an array 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 = Ext.create('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
\n\nPass in an optional groupName argument to access a specific group as defined by getGroupString
\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 a range of Records between specified indices.
\nThe starting index
\nDefaults to: 0
The ending index. Defaults to the last Record in the Store.
\nAn array of Records
\nReturns any records that have been removed from the store but not yet destroyed on the proxy.
\nThe removed Model instances
\nReturns 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
\nThe total number of Model instances available via the Proxy
\nReturns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\nThe updated Model instances
\nGet the index within the cache of the passed Record.
\nThe Ext.data.Model object to find.
\nThe index of the passed Record. Returns -1 if not found.
\nGet the index within the entire dataset. From 0 to the totalCount.
\nThe Ext.data.Model object to find.
\nThe index of the passed Record. Returns -1 if not found.
\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.
\nInserts 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.
\nAn Array of Ext.data.Model objects to add to the cache.
\nReturns true if the Store is currently performing a load operation
\nTrue if the Store is currently loading
\nConvenience function for getting the last model instance in the store
\nTrue 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.
\nThe last model instance in the store, or undefined
\nLoads 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});\n
\n\n\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});\n
\n\nconfig object, passed into the Ext.data.Operation object before loading.
\nLoads an array of data straight into the Store.
\n\nUsing this method is great if the data is in the correct format already (e.g. it doesn't need to be\nprocessed by a reader). If your data requires processing to decode the data structure, use a\nMemoryProxy instead.
\nArray of data to load. Any non-model instances will be cast\ninto model instances.
\nTrue to add the records to the existing records in the store, false\nto remove the old ones first.
\nDefaults to: false
Loads data via the bound Proxy's reader
\n\nUse this method if you are attempting to load data and want to utilize the configured data reader.
\nLoads an array of 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
\nThe array of records to load
\n{addRecords: true} to add these records to the existing records, false to remove the Store's existing records first
\nGets the maximum value in the store.
\nThe field in each record
\nTrue 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.
\nThe maximum value, if no items exist, undefined.
\nGets the minimum value in the store.
\nThe field in each record
\nTrue 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.
\nThe minimum value, if no items exist, undefined.
\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\nPrefetches data into the store using its configured proxy.
\nconfig object, passed into the Ext.data.Operation object before loading.\nSee load
\nPrefetches a page of data.
\nThe page to prefetch
\nconfig object, passed into the Ext.data.Operation object before loading.\nSee load
\nPurge the least recently used records in the prefetch if the purgeCount\nhas been exceeded.
\nQuery 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.
\nThe 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.
The scope (this
reference) in which the function is executed. Defaults to this Store.
Returns an Ext.util.MixedCollection of the matched records
\nRemoves the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single\n'datachanged' event after removal.
\nThe Ext.data.Model instance or array of instances to remove
\nRemove all items from the store.
\nPrevent the clear
event from being fired.
Removes 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
\nSums the value of property for each record between start\nand end and returns the result.
\nA field in each record
\nTrue 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.
\nThe sum
\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\nFires before a prefetch occurs. Return false to cancel.
\nThe associated operation
\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\nFired whenever the grouping in the grid changes
\nThe store
\nThe array of grouper objects
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever records have been prefetched
\nAn array of records
\nTrue if the operation was successful.
\nThe associated operation
\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