Roo.util.Observable
Roo.data.Store

Class Roo.data.Store

Package:	Roo.data
Defined In:	Roo/data/Store.js.
Class:	Store
Subclasses:	Roo.data.JsonStore, Roo.data.SimpleStore
Extends:	Roo.util.Observable

The Store class encapsulates a client side cache of {link Roo.data.Record} objects which provide input data
for widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.

A Store object uses an implementation of {link Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object
has no knowledge of the format of the data returned by the Proxy.

A Store object uses its configured implementation of {link Roo.data.DataReader} to create {link Roo.data.Record}
instances from the data object. These records are cached and made available through accessor functions.

Class Comments / Notes => [Add Your comment/notes about this class]

Config Options (Usually are also Properties)
Options		Defined By
	baseParams : Object An object containing properties which are to be sent as parameters on any HTTP request An object containing properties which are to be sent as parameters on any HTTP request	Roo.data.Store
	data : Array Inline data to be loaded when the store is initialized. Inline data to be loaded when the store is initialized.	Roo.data.Store
	isLocal : boolean flag if data is locally available (and can be always looked up without a remote query - used by combo/forms at present. flag if data is locally available (and can be always looked up without a remote query - used by combo/forms at present.	Roo.data.Store
	listeners : Object list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... }`	Roo.util.Observable
	multiSort : Boolean enable multi column sorting (sort is based on the order of columns, remote only at present) enable multi column sorting (sort is based on the order of columns, remote only at present)	Roo.data.Store
	proxy : Roo.data.DataProxy The Proxy object which provides access to a data object. The Proxy object which provides access to a data object.	Roo.data.Store
	pruneModifiedRecords : boolean True to clear all modified record information each time the store is loaded or when a record is removed. True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to false).	Roo.data.Store
	reader : Roo.data.Reader The Reader object which processes the data object and returns an Array of Roo.data.record objects which are cached keyed by their id property. The Reader object which processes the data object and returns an Array of Roo.data.record objects which are cached keyed by their id property.	Roo.data.Store
	remoteSort : boolean True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false). True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).	Roo.data.Store
	sortInfo : Object A config object in the format: {field: "fieldName", direction: "ASC\|DESC"} A config object in the format: {field: "fieldName", direction: "ASC\|DESC"}	Roo.data.Store

Public Methods
Method		Defined By
	new Roo.data.Store (Object *config) Create a new Roo.data.Store Create a new Roo.data.Store Parameters: Object config* A config object containing the objects needed for the Store to access data, and read the data into Records.
	add (Roo.data.Record[] *records) Add Records to the Store and fires the add event. Add Records to the Store and fires the add event. Parameters: Roo.data.Record[] records* An Array of Roo.data.Record objects to add to the cache.	Roo.data.Store
	addEvents (Object *object) Used to define events on this Observable Used to define events on this Observable Parameters: Object object* The object with the events defined	Roo.util.Observable
	addListener (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this component Appends an event handler to this component Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires. single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `el.on({ 'click': { fn: this.onClick, scope: this, delay: 100 }, 'mouseover': { fn: this.onMouseOver, scope: this }, 'mouseout': { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax which passes the same scope object to all handlers: `el.on({ 'click': this.onClick, 'mouseover': this.onMouseOver, 'mouseout': this.onMouseOut, scope: this });`	Roo.util.Observable
	clearFilter (Boolean *suppressEvent) Revert to a view of the Record cache with no filtering applied. Revert to a view of the Record cache with no filtering applied. Parameters: Boolean suppressEvent* If true the filter is cleared silently without notifying listeners	Roo.data.Store
	collect (String *dataIndex, Boolean allowNull, Boolean bypassFilter) : Array Collects unique values for a particular dataIndex from this store. Collects unique values for a particular dataIndex from this store. Parameters: String dataIndex* The property to collect Boolean allowNull (optional) Pass true to allow null, undefined or empty string values Boolean bypassFilter (optional) Pass true to collect from all records, even ones which are filtered Returns: Array An array of the unique values	Roo.data.Store
	commitChanges () Commit all Records with outstanding changes. Commit all Records with outstanding changes. To handle updates for changes, subscribe to the Store's "update" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.	Roo.data.Store
	each (Function fn, Object *scope) Calls the specified function for each of the Records in the cache. Calls the specified function for each of the Records in the cache. Parameters: Function fn The function to call. The Record is passed as the first parameter. Returning false* aborts and exits the iteration. Object scope (optional) The scope in which to call the function (defaults to the Record).	Roo.data.Store
	filter (String *field, String/RegExp value, Boolean anyMatch) Filter the records by a specified property. Filter the records by a specified property. Parameters: String field* A field on your records String/RegExp value Either a string that the field should start with or a RegExp to test against the field Boolean anyMatch True to match any part not just the beginning	Roo.data.Store
	filterBy (Function fn, Object *scope) Filter by a function. Filter by a function. The specified function will be called with each record in this data source. If the function returns true the record is included, otherwise it is filtered. Parameters: Function fn The function to be called, it will receive 2 args (record, id) Object scope* (optional) The scope of the function (defaults to this)	Roo.data.Store
	fireEvent (String *eventName, Object... args) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: String eventName* Object... args Variable number of parameters are passed to handlers Returns: Boolean returns false if any of the handlers return false otherwise it returns true	Roo.util.Observable
	getAt (Number *index) : Roo.data.Record Get the Record at the specified index. Get the Record at the specified index. Parameters: Number index* The index of the Record to find. Returns: Roo.data.Record The Record at the passed index. Returns undefined if not found.	Roo.data.Store
	getById (String id) : Roo.data.Record Get the Record with the specified id. Get the Record with the specified id. Parameters: String id The id of the Record to find. Returns: Roo.data.Record The Record with the passed id. Returns undefined if not found.	Roo.data.Store
	getCount () Gets the number of cached records. Gets the number of cached records. If using paging, this may not be the total size of the dataset. If the data object used by the Reader contains the dataset size, then the getTotalCount() function returns the data set size	Roo.data.Store
	getModifiedRecords () : Roo.data.Record[] Gets all records modified since the last commit. Gets all records modified since the last commit. Modified records are persisted across load operations (e.g., during paging). Returns: Roo.data.Record[] An array of Records containing outstanding modifications.	Roo.data.Store
	getRange (Number *startIndex, Number endIndex) : Roo.data.Record[] Returns a range of Records between specified indices. Returns a range of Records between specified indices. Parameters: Number startIndex* (optional) The starting index (defaults to 0) Number endIndex (optional) The ending index (defaults to the last Record in the Store) Returns: Roo.data.Record[] An array of Records	Roo.data.Store
	getSortState () Returns the sort state of the Store as an object with two properties: `field {String} The name of the field by which the Records are sorted direction {String} The sort order, "ASC" or "DESC"` Returns the sort state of the Store as an object with two properties: `field {String} The name of the field by which the Records are sorted direction {String} The sort order, "ASC" or "DESC"`	Roo.data.Store
	getTotalCount () Gets the total number of records in the dataset as returned by the server. Gets the total number of records in the dataset as returned by the server. If using paging, for this to be accurate, the data object used by the Reader must contain the dataset size	Roo.data.Store
	hasListener (String *eventName) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: String eventName* The name of the event to check for Returns: Boolean True if the event is being listened for, else false	Roo.util.Observable
	indexOf (Roo.data.Record *record) : Number Get the index within the cache of the passed Record. Get the index within the cache of the passed Record. Parameters: Roo.data.Record record* The Roo.data.Record object to to find. Returns: Number The index of the passed Record. Returns -1 if not found.	Roo.data.Store
	indexOfId (String id) : Number Get the index within the cache of the Record with the passed id. Get the index within the cache of the Record with the passed id. Parameters: String id The id of the Record to find. Returns: Number The index of the Record. Returns -1 if not found.	Roo.data.Store
	insert (Number *index, Roo.data.Record[] records) Inserts Records to the Store at the given index and fires the add event. Inserts Records to the Store at the given index and fires the add event. Parameters: Number index* The start index at which to insert the passed Records. Roo.data.Record[] records An Array of Roo.data.Record objects to add to the cache.	Roo.data.Store
	load (Object *options) Loads the Record cache from the configured Proxy using the configured Reader. Loads the Record cache from the configured Proxy using the configured Reader. If using remote paging, then the first load call must specify the start* and limit properties in the options.params property to establish the initial position within the dataset, and the number of Records to cache on each read from the Proxy. It is important to note that for remote data sources, loading is asynchronous, and this call will return before the new data has been loaded. Perform any post-processing in a callback function, or in a "load" event handler. Parameters: Object options An object containing properties which control loading options: params {Object} An object containing properties to pass as HTTP parameters to a remote data source. callback {Function} A function to be called after the Records have been loaded. The callback is passed the following arguments: r : Roo.data.Record[] options: Options object from the load call success: Boolean success indicator scope {Object} Scope with which to call the callback (defaults to the Store object) add {Boolean} indicator to append loaded records rather than replace the current cache.	Roo.data.Store
	loadData (Object *data, Boolean append) Loads data from a passed data block. Loads data from a passed data block. A Reader which understands the format of the data must have been configured in the constructor. Parameters: Object data* The data block from which to read the Records. The format of the data expected is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter. Boolean append (Optional) True to append the new Records rather than replace the existing cache.	Roo.data.Store
	on (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional)	Roo.util.Observable
	purgeListeners () Removes all listeners for this object Removes all listeners for this object	Roo.util.Observable
	query (String *field, String/RegExp value, Boolean anyMatch) : MixedCollection Query the records by a specified property. Query the records by a specified property. Parameters: String field* A field on your records String/RegExp value Either a string that the field should start with or a RegExp to test against the field Boolean anyMatch True to match any part not just the beginning Returns: MixedCollection Returns an Roo.util.MixedCollection of the matched records	Roo.data.Store
	queryBy (Function fn, Object *scope) : MixedCollection Query by a function. Query by a function. The specified function will be called with each record in this data source. If the function returns true the record is included in the results. Parameters: Function fn The function to be called, it will receive 2 args (record, id) Object scope* (optional) The scope of the function (defaults to this) Returns: MixedCollection Returns an Roo.util.MixedCollection of the matched records	Roo.data.Store
	rejectChanges () Cancel outstanding changes on all changed records. Cancel outstanding changes on all changed records.	Roo.data.Store
	reload (Object *options) Reloads the Record cache from the configured Proxy using the configured Reader and the options from the last load operation performed. Reloads the Record cache from the configured Proxy using the configured Reader and the options from the last load operation performed. Parameters: Object options* (optional) An object containing properties which may override the options used in the last load operation. See {link load} for details (defaults to null, in which case the most recently used options are reused).	Roo.data.Store
	remove (Ext.data.Record *record) Remove a Record from the Store and fires the remove event. Remove a Record from the Store and fires the remove event. Parameters: Ext.data.Record record* The Roo.data.Record object to remove from the cache.	Roo.data.Store
	removeAll () Remove all Records from the Store and fires the clear event. Remove all Records from the Store and fires the clear event.	Roo.data.Store
	removeListener (String *eventName, Function handler, Object scope) Removes a listener Removes a listener Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	setDefaultSort (String *fieldName, String dir) Sets the default sort column and order to be used by the next load operation. Sets the default sort column and order to be used by the next load operation. Parameters: String fieldName* The name of the field to sort by. String dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC")	Roo.data.Store
	sort (String *fieldName, String dir) Sort the Records. Sort the Records. If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local sorting is used, the cache is sorted internally. Parameters: String fieldName* The name of the field to sort by. String dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC")	Roo.data.Store
	sum (String *property, Number start, Number end) : Number Sums the value of property* for each record between start and end and returns the result. Sums the value of property for each record between start and end and returns the result. Parameters: String property A field on your records Number start The record index to start at (defaults to 0) Number end The last record index to include (defaults to length - 1) Returns: Number The sum	Roo.data.Store
	un (String *eventName, Function handler, Object scope) Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable

Events
Event		Defined By
	add (Store *this, Roo.data.Record[] records, Number index) Fires when Records have been added to the Store Fires when Records have been added to the Store Parameters: Store this* Roo.data.Record[] records The array of Records added Number index The index at which the record(s) were added	Roo.data.Store
	beforeload (Store *this, Object options) Fires before a request is made for a new data object. Fires before a request is made for a new data object. If the beforeload handler returns false the load action will be canceled. Parameters: Store this* Object options The loading options that were specified (see {link load} for details)	Roo.data.Store
	beforeloadadd (Store *this, Roo.data.Record[] records, Object options) Fires after a new set of Records has been loaded. Fires after a new set of Records has been loaded. Parameters: Store this* Roo.data.Record[] records The Records that were loaded Object options The loading options that were specified (see {link load} for details)	Roo.data.Store
	clear (Store *this) Fires when the data cache has been cleared. Fires when the data cache has been cleared. Parameters: Store this*	Roo.data.Store
	datachanged (Store *this) Fires when the data cache has changed, and a widget which is using this Store as a Record cache should refresh its view. Fires when the data cache has changed, and a widget which is using this Store as a Record cache should refresh its view. Parameters: Store this*	Roo.data.Store
	load (Store *this, Roo.data.Record[] records, Object options) Fires after a new set of Records has been loaded, before they are added to the store. Fires after a new set of Records has been loaded, before they are added to the store. Parameters: Store this* Roo.data.Record[] records The Records that were loaded Object options The loading options that were specified (see {link load} for details)	Roo.data.Store
	loadexception (Proxy , Object *return, Object load, Object jsonData) Fires if an exception occurs in the Proxy during loading. Fires if an exception occurs in the Proxy during loading. Called with the signature of the Proxy's "loadexception" event. If you return Json { data: [] , success: false, .... } then this will be thrown with the following args Parameters: Proxy Object return* from JsonData.reader() - success, totalRecords, records Object load options Object jsonData from your request (normally this contains the Exception)	Roo.data.Store
	metachange (Store *this, Object meta) Fires when this store's reader provides new metadata (fields). Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders. Parameters: Store this* Object meta The JSON metadata	Roo.data.Store
	remove (Store *this, Roo.data.Record record, Number index) Fires when a Record has been removed from the Store Fires when a Record has been removed from the Store Parameters: Store this* Roo.data.Record record The Record that was removed Number index The index at which the record was removed	Roo.data.Store
	update (Store *this, Roo.data.Record record, String operation) Fires when a Record has been updated Fires when a Record has been updated Parameters: Store this* Roo.data.Record record The Record that was updated String operation The update operation being performed. Value may be one of: `Roo.data.Record.EDIT Roo.data.Record.REJECT Roo.data.Record.COMMIT`	Roo.data.Store

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT) Based on JsDoc Toolkit