| autoDestroy : Booleantrue to destroy the store when the component the store is bound
-to is destroyed (defaults to false).
+ Small helper class to make creating Ext.data.Stores from XML data easier.
+A XmlStore will be automatically configured with a Ext.data.XmlReader.
+ A store configuration would be something like: var store = new Ext.data.XmlStore({
+ // store configs
+ autoDestroy: true,
+ storeId: 'myStore',
+ url: 'sheldon.xml', // automatically configures a HttpProxy
+ // reader configs
+ record: 'Item', // records will have an "Item" tag
+ idPath: 'ASIN',
+ totalRecords: '@TotalResults'
+ fields: [
+ // set up the fields mapping into the xml doc
+ // The first needs mapping, the others are very basic
+ {name: 'Author', mapping: 'ItemAttributes > Author'},
+ 'Title', 'Manufacturer', 'ProductGroup'
+ ]
+});
+ This store is configured to consume a returned object of the form: <?xml version="1.0" encoding="UTF-8"?>
+<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
+ <Items>
+ <Request>
+ <IsValid>True</IsValid>
+ <ItemSearchRequest>
+ <Author>Sidney Sheldon</Author>
+ <SearchIndex>Books</SearchIndex>
+ </ItemSearchRequest>
+ </Request>
+ <TotalResults>203</TotalResults>
+ <TotalPages>21</TotalPages>
+ <Item>
+ <ASIN>0446355453</ASIN>
+ <DetailPageURL>
+ http://www.amazon.com/
+ </DetailPageURL>
+ <ItemAttributes>
+ <Author>Sidney Sheldon</Author>
+ <Manufacturer>Warner Books</Manufacturer>
+ <ProductGroup>Book</ProductGroup>
+ <Title>Master of the Game</Title>
+ </ItemAttributes>
+ </Item>
+ </Items>
+</ItemSearchResponse>
+An object literal of this form could also be used as the data config option.
+ Note: Although not listed here, this class accepts all of the configuration options of
+XmlReader. Config Options|
| autoDestroy : Booleantrue to destroy the store when the component the store is bound
+to is destroyed (defaults to false).
Note: this shoul... true to destroy the store when the component the store is bound
to is destroyed (defaults to false).
- Note: this should be set to true when using stores that are bound to only 1 component. | Store | | autoLoad : Boolean/ObjectIf data is not specified, and if autoLoad
-is true or an Object, this store's load method is automatically called
+ Note: this should be set to true when using stores that are bound to only 1 component. | Store | | autoLoad : Boolean/ObjectIf data is not specified, and if autoLoad
+is true or an Object, this store's load method is automatically called
afte... If data is not specified, and if autoLoad
is true or an Object, this store's load method is automatically called
after creation. If the value of autoLoad is an Object, this Object will
-be passed to the store's load method. | Store | | autoSave : BooleanDefaults to true causing the store to automatically save records to
+be passed to the store's load method. | Store | | autoSave : BooleanDefaults to true causing the store to automatically save records to
the server when a record is modified (ie: becomes... Defaults to true causing the store to automatically save records to
the server when a record is modified (ie: becomes 'dirty'). Specify false to manually call save
to send all modifiedRecords to the server.
- Note: each CRUD action will be sent as a separate request. | Store | | baseParams : ObjectAn object containing properties which are to be sent as parameters
-for every HTTP request.
+ Note: each CRUD action will be sent as a separate request. | Store | | baseParams : ObjectAn object containing properties which are to be sent as parameters
+for every HTTP request.
Parameters are encoded as ... An object containing properties which are to be sent as parameters
for every HTTP request.
Parameters are encoded as standard HTTP parameters using Ext.urlEncode.
@@ -66,16 +66,16 @@ for every HTTP request.
specified in a load request, see load
for more details.
This property may be modified after creation using the setBaseParam
-method. | Store | | batch : BooleanDefaults to true (unless restful:true). Multiple
+method. | Store | | batch : BooleanDefaults to true (unless restful:true). Multiple
requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) wil... Defaults to true (unless restful:true ). Multiple
requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
and sent as one transaction. Only applies when autoSave is set
to false.
If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is
generated for each record. | Store | | data : ArrayAn inline data object readable by the reader .
-Typically this option, or the url option will be specified. | Store | | defaultParamNames : ObjectProvides the default values for the paramNames property. To globally modify the parameters
+Typically this option, or the url option will be specified. | Store | | defaultParamNames : ObjectProvides the default values for the paramNames property. To globally modify the parameters
for all stores, this objec... Provides the default values for the paramNames property. To globally modify the parameters
-for all stores, this object should be changed on the store prototype. | Store | | listeners : ObjectA config object containing one or more event handlers to be added to this
+for all stores, this object should be changed on the store prototype. | Store | | listeners : ObjectA config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
addListener example for attaching multiple handlers at once.
@@ -130,7 +130,7 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | paramNames : ObjectAn object containing properties which specify the names of the paging and
+}); | Observable | | paramNames : ObjectAn object containing properties which specify the names of the paging and
sorting parameters passed to remote servers... An object containing properties which specify the names of the paging and
sorting parameters passed to remote servers when loading blocks of data. By default, this
object takes the following form: {
@@ -144,10 +144,10 @@ If different parameter names are required, this property can be overriden using
property.
A PagingToolbar bound to this Store uses this property to determine
the parameter names to use in its requests.
| Store | | proxy : Ext.data.DataProxyThe DataProxy object which provides
-access to a data object. See url . | Store | | pruneModifiedRecords : Booleantrue to clear all modified record information each time
+access to a data object. See url . | Store | | pruneModifiedRecords : Booleantrue to clear all modified record information each time
the store is loaded or when a record is removed (defaults to ... true to clear all modified record information each time
the store is loaded or when a record is removed (defaults to false). See getModifiedRecords
-for the accessor method to retrieve the modified records. | Store | | remoteSort : booleantrue if sorting is to be handled by requesting the Proxy
+for the accessor method to retrieve the modified records. | Store | | remoteSort : booleantrue if sorting is to be handled by requesting the Proxy
to provide a refreshed version of the data object in sorted ... 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).
@@ -157,29 +157,29 @@ the following two parameters to the The name (as specified in the Record's
Field definition) of the field to sort on.
dir : StringThe direction of the sort, 'ASC' or 'DESC' (case-sensitive).
- | Store | | restful : BooleanDefaults to false. Set to true to have the Store and the set
+ | Store | | restful : BooleanDefaults to false. Set to true to have the Store and the set
Proxy operate in a RESTful manner. The store will autom... Defaults to false. Set to true to have the Store and the set
Proxy operate in a RESTful manner. The store will automatically generate GET, POST,
PUT and DELETE requests to the server. The HTTP method used for any given CRUD
action is described in Ext.data.Api.restActions. For additional information
see Ext.data.DataProxy.restful.
Note: if restful:true batch will
-internally be set to false. | Store | | sortInfo : ObjectA config object to specify the sort order in the request of a Store's
+internally be set to false. | Store | | sortInfo : ObjectA config object to specify the sort order in the request of a Store's
load operation. Note that for local sorting, t... A config object to specify the sort order in the request of a Store's
load operation. Note that for local sorting, the direction property is
case-sensitive. See also remoteSort and paramNames.
For example: sortInfo: {
field: 'fieldName',
direction: 'ASC' // or 'DESC' (case sensitive for local sorting)
-}
| Store | | storeId : StringIf passed, the id to use to register with the StoreMgr.
+} | Store | | storeId : StringIf passed, the id to use to register with the StoreMgr.
Note: if a (deprecated) id is specified it will supersede the... If passed, the id to use to register with the StoreMgr.
Note: if a (deprecated) id is specified it will supersede the storeId
-assignment. | Store | | url : StringIf a proxy is not specified the url will be used to
-implicitly configure a HttpProxy if an url is specified.
+assignment. | Store | | url : StringIf a proxy is not specified the url will be used to
+implicitly configure a HttpProxy if an url is specified.
Typicall... If a proxy is not specified the url will be used to
implicitly configure a HttpProxy if an url is specified.
-Typically this option, or the data option will be specified. | Store | | writer : Ext.data.DataWriterThe Writer object which processes a record object for being written
-to the server-side database.
+Typically this option, or the data option will be specified. | Store | | writer : Ext.data.DataWriterThe Writer object which processes a record object for being written
+to the server-side database.
When a writer is ins... The Writer object which processes a record object for being written
to the server-side database.
When a writer is installed into a Store the add, remove, and update
@@ -202,16 +202,18 @@ events on the store are monitored in order to remotely Store |
Public Properties|
| baseParams : ObjectSee the corresponding configuration option
-for a description of this property.
+}); | Store |
Public Properties|
| baseParams : ObjectSee the corresponding configuration option
+for a description of this property.
To modify this property see setBasePar... | Store | | fields : Ext.util.MixedCollection | Store | | lastOptions : ObjectContains the last options object used as the parameter to the load method. See load
+for the Records stored in this Store. Read-only. | Store | | isDestroyed : Boolean
+True if the store has been destroyed already. Read only | Store | | lastOptions : ObjectContains the last options object used as the parameter to the load method. See load
for the details of what this may ... Contains the last options object used as the parameter to the load method. See load
for the details of what this may contain. This may be useful for accessing any params which were used
-to load the current Record cache. | Store | | recordType : FunctionThe Record constructor as supplied to (or created by) the
-Reader. Read-only.
+to load the current Record cache. | Store | | multiSort : Boolean
+True if this store is currently sorted by more than one field/direction combination. | Store | | multiSortInfo : Object Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields | Store | | recordType : FunctionThe Record constructor as supplied to (or created by) the
+Reader. Read-only.
If the Reader was constructed by passing... The Record constructor as supplied to (or created by) the
Reader. Read-only.
If the Reader was constructed by passing in an Array of Ext.data.Field definition objects,
@@ -269,19 +271,19 @@ instead of a Record constructor, it will implicitly create a Record constructor
grid.startEditing(0, 0);
}
}]
- }); | Store |
Public Methods|
| XmlStore( Object config )
- | XmlStore | | add( Ext.data.Record[] records )
- :
- voidAdd Records to the Store and fires the add event. To add Records
+ }); | Store |
Public Methods|
| XmlStore( Object config )
+ | XmlStore | | add( Ext.data.Record[] records )
+ :
+ voidAdd Records to the Store and fires the add event. To add Records
to the store from a remote source use load({add:tru... Add Records to the Store and fires the add event. To add Records
to the store from a remote source use load({add:true}) .
See also recordType and insert . Parameters:records : Ext.data.Record[]An Array of Ext.data.Record objects
-to add to the cache. See recordType. Returns: | Store | | addEvents( Object|String o , string Optional. )
- :
+to add to the cache. See recordType.Returns: | Store | | addEvents( Object|String o , string Optional. )
+ :
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared'); Returns: | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -331,142 +333,162 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-}); Returns: | Observable | | addSorted( Ext.data.Record record )
- :
- void(Local sort only) Inserts the passed Record into the Store at the index where it
+}); Returns: | Observable | | addSorted( Ext.data.Record record )
+ :
+ void(Local sort only) Inserts the passed Record into the Store at the index where it
should go based on the current sort ... (Local sort only) Inserts the passed Record into the Store at the index where it
-should go based on the current sort information. | Store | | clearFilter( Boolean suppressEvent )
- :
+should go based on the current sort information. | Store | | clearFilter( Boolean suppressEvent )
+ :
voidRevert to a view of the Record cache with no filtering applied. Revert to a view of the Record cache with no filtering applied. Parameters:suppressEvent : BooleanIf true the filter is cleared silently without firing the
- datachanged event. Returns: | Store | | collect( String dataIndex , [Boolean allowNull ], [Boolean bypassFilter ] )
- :
- ArrayCollects unique values for a particular dataIndex from this store. Collects unique values for a particular dataIndex from this store. Parameters:dataIndex : StringThe property to collect allowNull : Boolean(optional) Pass true to allow null, undefined or empty string values bypassFilter : Boolean(optional) Pass true to collect from all records, even ones which are filtered Returns: | Store | | commitChanges()
- :
- voidCommit all Records with outstanding changes. To handle updates for changes,
+ datachanged event. Returns: | Store | | collect( String dataIndex , [Boolean allowNull ], [Boolean bypassFilter ] )
+ :
+ ArrayCollects unique values for a particular dataIndex from this store. Collects unique values for a particular dataIndex from this store. Parameters:dataIndex : StringThe property to collect allowNull : Boolean(optional) Pass true to allow null, undefined or empty string values bypassFilter : Boolean(optional) Pass true to collect from all records, even ones which are filtered Returns: | Store | | commitChanges()
+ :
+ voidCommit all Records with outstanding changes. To handle updates for changes,
subscribe to the Store's update event, an... 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
-Ext.data.Record.COMMIT. | Store | | destroy()
- :
- void | Store | | each( Function fn , [Object scope ] )
- :
+Ext.data.Record.COMMIT. | Store | | destroy()
+ :
+ void | Store | | each( Function fn , [Object scope ] )
+ :
voidCalls the specified function for each of the Records in the cache. Calls the specified function for each of the Records in the cache. Parameters:fn : FunctionThe function to call. The Record is passed as the first parameter.
Returning false aborts and exits the iteration. scope : Object(optional) The scope ( this reference) in which the function is executed.
-Defaults to the current Record in the iteration. Returns: | Store | | enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling
-this.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
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
-access the required target more quickly.
- Example: Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
-});
| Observable | | filter( String field , String/RegExp value , [Boolean anyMatch ], [Boolean caseSensitive ] )
- :
- voidFilter the records by a specified property. Filter the records by a specified property. Parameters:field : StringA field on your records value : String/RegExpEither a string that the field should begin with, or a RegExp to test
-against the field. anyMatch : Boolean(optional) true to match any part not just the beginning caseSensitive : Boolean(optional) true for case sensitive comparison Returns: | Store | | filterBy( Function fn , [Object scope ] )
- :
- voidFilter by a function. The specified function will be called for each
+Defaults to the current Record in the iteration. Returns: | Store | | enableBubble( String/Array events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.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
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+ Example: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
| Observable | | filter( String|Array field , String/RegExp value , [Boolean anyMatch ], [Boolean caseSensitive ], Boolean exactMatch )
+ :
+ voidFilter the records by a specified property. Alternatively, pass an array of filter
+options to filter by more than one... Filter the records by a specified property. Alternatively, pass an array of filter
+options to filter by more than one property.
+Single filter example:
+store.filter('name', 'Ed', true, true); //finds all records containing the substring 'Ed'
+Multiple filter example:
+ store.filter([
+{
+property : 'name',
+value : 'Ed',
+anyMatch : true, //optional, defaults to true
+caseSensitive: true //optional, defaults to true
+},
+//filter functions can also be passed
+{
+fn : function(record) {
+return record.get('age') == 24
+},
+scope: this
+}
+]);
Parameters:field : String|ArrayA field on your records, or an array containing multiple filter options value : String/RegExpEither a string that the field should begin with, or a RegExp to test
+against the field. anyMatch : Boolean(optional) true to match any part not just the beginning caseSensitive : Boolean(optional) true for case sensitive comparison exactMatch : BooleanTrue to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true. Returns: | Store | | filterBy( Function fn , [Object scope ] )
+ :
+ voidFilter by a function. The specified function will be called for each
Record in this Store. If the function returns tr... Filter by a function. The specified function will be called for each
Record in this Store. If the function returns true the Record is included,
otherwise it is filtered out. | Store | | find( String fieldName , String/RegExp value , [Number startIndex ], [Boolean anyMatch ], [Boolean caseSensitive ] )
- :
+scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to this Store. Returns: | Store | | find( String fieldName , String/RegExp value , [Number startIndex ], [Boolean anyMatch ], [Boolean caseSensitive ] )
+ :
NumberFinds the index of the first matching Record in this store by a specific field value. Finds the index of the first matching Record in this store by a specific field value. Parameters:fieldName : StringThe name of the Record field to test. value : String/RegExpEither a string that the field value
-should begin with, or a RegExp to test against the field. startIndex : Number(optional) The index to start searching at anyMatch : Boolean(optional) True to match any part of the string, not just the beginning caseSensitive : Boolean(optional) True for case sensitive comparison Returns:Number The matched index or -1
| Store | | findBy( Function fn , [Object scope ], [Number startIndex ] )
- :
- NumberFind the index of the first matching Record in this Store by a function.
+should begin with, or a RegExp to test against the field. startIndex : Number(optional) The index to start searching at anyMatch : Boolean(optional) True to match any part of the string, not just the beginning caseSensitive : Boolean(optional) True for case sensitive comparison Returns:Number The matched index or -1
| Store | | findBy( Function fn , [Object scope ], [Number startIndex ] )
+ :
+ NumberFind the index of the first matching Record in this Store by a function.
If the function returns true it is considere... Find the index of the first matching Record in this Store by a function.
If the function returns true it is considered a match. Parameters:Returns:Number The matched index or -1
| Store | | findExact( String fieldName , Mixed value , [Number startIndex ] )
- :
- NumberFinds the index of the first matching Record in this store by a specific field value. Finds the index of the first matching Record in this store by a specific field value. Parameters:fieldName : StringThe name of the Record field to test. value : MixedThe value to match the field against. startIndex : Number(optional) The index to start searching at Returns:Number The matched index or -1
| Store | | fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+ scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to this Store. startIndex : Number(optional) The index to start searching at Returns:Number The matched index or -1
| Store | | findExact( String fieldName , Mixed value , [Number startIndex ] )
+ :
+ NumberFinds the index of the first matching Record in this store by a specific field value. Finds the index of the first matching Record in this store by a specific field value. Parameters:fieldName : StringThe name of the Record field to test. value : MixedThe value to match the field against. startIndex : Number(optional) The index to start searching at Returns:Number The matched index or -1
| Store | | fireEvent( String eventName , Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... | Observable | | getAt( Number index )
- :
- Ext.data.RecordGet the Record at the specified index. Get the Record at the specified index. | Store | | getById( String id )
- :
- Ext.data.RecordGet the Record with the specified id. Get the Record with the specified id. | Store | | getCount()
- :
- NumberGets the number of cached records.
+by calling enableBubble. | Observable | | getAt( Number index )
+ :
+ Ext.data.RecordGet the Record at the specified index. Get the Record at the specified index. | Store | | getById( String id )
+ :
+ Ext.data.RecordGet the Record with the specified id. Get the Record with the specified id. | Store | | getCount()
+ :
+ NumberGets the number of cached records.
If using paging, this may not be the total size of the dataset. If the data object... 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 dataset size. Note: see the Important note in load. | Store | | getModifiedRecords()
- :
- Ext.data.Record[]Gets all records modified since the last commit. Modified records are
+the dataset size. Note: see the Important note in load. | Store | | getModifiedRecords()
+ :
+ Ext.data.Record[]Gets all records modified since the last commit. Modified records are
persisted across load operations (e.g., during... | Store | | getRange( [Number startIndex ], [Number endIndex ] )
- :
- Ext.data.Record[]Returns a range of Records between specified indices. Returns a range of Records between specified indices. Parameters:Returns:Ext.data.Record[] An array of Records
| Store | | getSortState()
- :
- ObjectReturns an object describing the current sort state of this Store. Returns an object describing the current sort state of this Store. Parameters:Returns:Object The sort state of the Store. An object with two properties:<ul>
-<li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
-<li><b>direction : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
-</ul>
-See <tt>{@link #sortInfo}</tt> for additional details.
| Store | | getTotalCount()
- :
- Number | Store | | getRange( [Number startIndex ], [Number endIndex ] )
+ :
+ Ext.data.Record[]Returns a range of Records between specified indices. Returns a range of Records between specified indices. Parameters:Returns:Ext.data.Record[] An array of Records
| Store | | getSortState()
+ :
+ ObjectReturns an object describing the current sort state of this Store. Returns an object describing the current sort state of this Store. Parameters:Returns:Object The sort state of the Store. An object with two properties:<ul>
+<li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
+<li><b>direction : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
+</ul>
+See <tt>{@link #sortInfo}</tt> for additional details.
| Store | | getTotalCount()
+ :
+ NumberGets the total number of records in the dataset as returned by the server.
If using paging, for this to be accurate, ... 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. For remote data sources, the value for this property
(totalProperty for JsonReader,
totalRecords for XmlReader) shall be returned by a query on the server.
-Note: see the Important note in load. | Store | | hasListener( String eventName )
- :
- BooleanChecks 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 | Observable | | indexOf( Ext.data.Record record )
- :
- NumberGet the index within the cache of the passed Record. Get the index within the cache of the passed Record. | Store | | indexOfId( String id )
- :
- NumberGet 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. | Store | | insert( Number index , Ext.data.Record[] records )
- :
- voidInserts Records into the Store at the given index and fires the add event.
+ Note: see the Important note in load. | Store | | hasListener( String eventName )
+ :
+ BooleanChecks 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 | Observable | | indexOf( Ext.data.Record record )
+ :
+ NumberGet the index within the cache of the passed Record. Get the index within the cache of the passed Record. | Store | | indexOfId( String id )
+ :
+ NumberGet 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. | Store | | insert( Number index , Ext.data.Record[] records )
+ :
+ voidInserts Records into the Store at the given index and fires the add event.
See also add and addSorted. Inserts Records into the Store at the given index and fires the add event.
-See also add and addSorted . | Store | | isFiltered()
- :
- BooleanReturns true if this store is currently filtered Returns true if this store is currently filtered | Store | | load( Object options )
- :
- BooleanLoads the Record cache from the configured proxy using the configured reader.
-Notes:<div class="mdetail-params">
+See also add and addSorted . | Store | | isFiltered()
+ :
+ BooleanReturns true if this store is currently filtered Returns true if this store is currently filtered | Store | | load( Object options )
+ :
+ BooleanLoads the Record cache from the configured proxy using the configured reader.
+Notes:<div class="mdetail-params">
Impo... Loads the Record cache from the configured proxy using the configured reader.
Notes:
- Important: loading is asynchronous! This call will return before the new data has been
@@ -492,10 +514,10 @@ have been loaded. The callback is called after the load event is fired, and is p
to the Store object)
add : BooleanIndicator to append loaded records rather than
replace the current cache. Note: see note for loadData
- Returns: | Store | | loadData( Object data , [Boolean append ] )
- :
- voidLoads data from a passed data block and fires the load event. A Reader
+ Returns: | Store | | loadData( Object data , [Boolean append ] )
+ :
+ voidLoads data from a passed data block and fires the load event. A Reader
which understands the format of the data must ... Loads data from a passed data block and fires the load event. A Reader
which understands the format of the data must have been configured in the constructor. Parameters:data : ObjectThe 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
@@ -503,30 +525,36 @@ that Reader'
the existing cache.
Note: that Records in a Store are keyed by their id, so added Records
with ids which are already present in the Store will replace existing Records. Only Records with
-new, unique ids will be added. Returns: | Store | | on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+new, unique ids will be added.Returns: | Store | | multiSort( Array sorters , String direction )
+ :
+ voidSorts the contents of this store by multiple field/direction sorters. This is called internally by sort
+and would not... Sorts the contents of this store by multiple field/direction sorters. This is called internally by sort
+and would not usually be called manually.
+Multi sorting only currently applies to local datasets - multiple sort data is not currently sent to a proxy
+if remoteSort is used. | Store | | on( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable | | query( String field , String/RegExp value , [Boolean anyMatch ], [Boolean caseSensitive ] )
- :
+If omitted, defaults to the object which fired the event.options : Object(optional) An object containing handler configuration. Returns: | Observable | | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable | | query( String field , String/RegExp value , [Boolean anyMatch ], [Boolean caseSensitive ] )
+ :
MixedCollectionQuery the records by a specified property. Query the records by a specified property. Parameters:field : StringA field on your records value : String/RegExpEither a string that the field
-should begin with, or a RegExp to test against the field. anyMatch : Boolean(optional) True to match any part not just the beginning caseSensitive : Boolean(optional) True for case sensitive comparison Returns: | Store | | queryBy( Function fn , [Object scope ] )
- :
- MixedCollectionQuery the cached records in this Store using a filtering function. The specified function
+should begin with, or a RegExp to test against the field. anyMatch : Boolean(optional) True to match any part not just the beginning caseSensitive : Boolean(optional) True for case sensitive comparison Returns: | Store | | queryBy( Function fn , [Object scope ] )
+ :
+ MixedCollectionQuery the cached records in this Store using a filtering function. The specified function
will be called with each re... Query the cached records in this Store using a filtering function. The specified function
will be called with each record in this Store. If the function returns true the record is
included in the results. | Store | | rejectChanges()
- :
- voidReject outstanding changes on all modified records. | Store | | relayEvents( Object o , Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | reload( Object options )
- :
- voidReloads the Record cache from the configured Proxy using the configured
+ scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to this Store. Returns: | Store | | rejectChanges()
+ :
+ voidReject outstanding changes on all modified records. | Store | | relayEvents( Object o , Array events )
+ :
+ voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | reload( Object options )
+ :
+ voidReloads the Record cache from the configured Proxy using the configured
Reader and the options from the last load ope... Reloads the Record cache from the configured Proxy using the configured
Reader and the options from the last load operation
performed.
@@ -539,23 +567,23 @@ used).
Ext.apply(lastOptions.params, {
myNewParam: true
});
-myStore.reload(lastOptions); Returns: | Store | | remove( Ext.data.Record/Ext.data.Record[] record )
- :
- voidRemove Records from the Store and fires the remove event. Remove Records from the Store and fires the remove event. | Store | | removeAll( Boolean silent )
- :
- voidRemove all Records from the Store and fires the clear event. Remove all Records from the Store and fires the clear event. | Store | | removeAt( Number index )
- :
- voidRemove a Record from the Store at the specified index. Fires the remove event. Remove a Record from the Store at the specified index. Fires the remove event. | Store | | removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable | | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+myStore.reload(lastOptions); Returns: | Store | | remove( Ext.data.Record/Ext.data.Record[] record )
+ :
+ voidRemove Records from the Store and fires the remove event. Remove Records from the Store and fires the remove event. | Store | | removeAll( Boolean silent )
+ :
+ voidRemove all Records from the Store and fires the clear event. Remove all Records from the Store and fires the clear event. | Store | | removeAt( Number index )
+ :
+ voidRemove a Record from the Store at the specified index. Fires the remove event. Remove a Record from the Store at the specified index. Fires the remove event. | Store | | removeListener( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable | | resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable | | save()
- :
- NumberSaves all pending changes to the store. If the commensurate Ext.data.Api.actions action is not configured, then
+events fired during event suspension will be sent to any listeners now. | Observable | | save()
+ :
+ NumberSaves all pending changes to the store. If the commensurate Ext.data.Api.actions action is not configured, then
the ... Saves all pending changes to the store. If the commensurate Ext.data.Api.actions action is not configured, then
the configured url will be used.
@@ -564,75 +592,97 @@ change url
removed records Ext.data.Api.actions.destroy
phantom records Ext.data.Api.actions.create
modified records Ext.data.Api.actions.update
- | Store | | setBaseParam( String name , Mixed value )
- :
- voidSet the value for a property name in this store's baseParams. Usage:myStore.setBaseParam('foo', {bar:3}); Set the value for a property name in this store's baseParams. Usage: myStore.setBaseParam('foo', {bar:3});
| Store | | setDefaultSort( String fieldName , [String dir ] )
- :
- voidSets 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:fieldName : StringThe name of the field to sort by. dir : String(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') Returns: | Store | | sort( String fieldName , [String dir ] )
- :
- void | Store | | setBaseParam( String name , Mixed value )
+ :
+ voidSet the value for a property name in this store's baseParams. Usage:myStore.setBaseParam('foo', {bar:3}); Set the value for a property name in this store's baseParams. Usage: myStore.setBaseParam('foo', {bar:3});
| Store | | setDefaultSort( String fieldName , [String dir ] )
+ :
+ voidSets 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:fieldName : StringThe name of the field to sort by. dir : String(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') Returns: | Store | | singleSort( String fieldName , [String dir ] )
+ :
+ voidSorts the store contents by a single field and direction. This is called internally by sort and would
+not usually be ... Sorts the store contents by a single field and direction. This is called internally by sort and would
+not usually be called manually Parameters:fieldName : StringThe name of the field to sort by. dir : String(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') Returns: | Store | | sort( String/Array fieldName , [String dir ] )
+ :
+ voidSort the Records.
If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local... 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. See also remoteSort and paramNames. Parameters:fieldName : StringThe name of the field to sort by. dir : String(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') Returns: | Store | | sum( String property , [Number start ], [Number end ] )
- :
- NumberSums the value of property for each record between start
+sorting is used, the cache is sorted internally. See also remoteSort and paramNames.
+This function accepts two call signatures - pass in a field name as the first argument to sort on a single
+field, or pass in an array of sort configuration objects to sort by multiple fields.
+Single sort example:
+store.sort('name', 'ASC');
+Multi sort example:
+store.sort([
+{
+field : 'name',
+direction: 'ASC'
+},
+{
+field : 'salary',
+direction: 'DESC'
+}
+], 'ASC');
+In this second form, the sort configs are applied in order, with later sorters sorting within earlier sorters' results.
+For example, if two records with the same name are present they will also be sorted by salary if given the sort configs
+above. Any number of sort configs can be added. Parameters:fieldName : String/ArrayThe name of the field to sort by, or an array of ordered sort configs dir : String(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to 'ASC') Returns: | Store | | sum( String property , [Number start ], [Number end ] )
+ :
+ NumberSums 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. | Store | | suspendEvents( Boolean queueSuspended )
- :
+and end and returns the result. | Store | | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events; Returns: | Observable | | un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | Observable |
Public Events|
| add :
- ( Store this , Ext.data.Record[] records , Number index )
- Fires when Records have been added to the Store Fires when Records have been added to the Store Listeners will be called with the following arguments: | Store | | beforeload :
- ( Store this , Object options )
- Fires before a request is made for a new data object. If the beforeload handler returns
+after the resumeEvents call instead of discarding all suspended events; Returns: | Observable | | un( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) | Observable |
Public Events|
| add :
+ ( Store this , Ext.data.Record[] records , Number index )
+ Fires when Records have been added to the Store Fires when Records have been added to the Store Listeners will be called with the following arguments: | Store | | beforeload :
+ ( Store this , Object options )
+ Fires before a request is made for a new data object. If the beforeload handler returns
false the load action will b... Fires before a request is made for a new data object. If the beforeload handler returns
- false the load action will be canceled. Listeners will be called with the following arguments:this : Storeoptions : ObjectThe loading options that were specified (see load for details)
| Store | | beforesave :
- ( Ext.data.Store store , Object data )
+false the load action will be canceled.Listeners will be called with the following arguments:this : Storeoptions : ObjectThe loading options that were specified (see load for details)
| Store | | beforesave :
+ ( Ext.data.Store store , Object data )
Fires before a save action is called. A save encompasses destroying records, updating records and creating records. Fires before a save action is called. A save encompasses destroying records, updating records and creating records. Listeners will be called with the following arguments: | Store | | beforewrite :
- ( Ext.data.Store store , String action , Record/Array[Record] rs , Object options , Object arg )
- Listeners will be called with the following arguments: | Store | | clear :
- ( Store this , Record[] The )
- Fires when the data cache has been cleared. Fires when the data cache has been cleared. Listeners will be called with the following arguments: | Store | | datachanged :
- ( Store this )
- Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
+with an array of records for each action. | Store | | beforewrite :
+ ( Ext.data.Store store , String action , Record/Record[] rs , Object options , Object arg )
+ Listeners will be called with the following arguments: | Store | | clear :
+ ( Store this , Record[] records )
+ Fires when the data cache has been cleared. Fires when the data cache has been cleared. Listeners will be called with the following arguments: | Store | | datachanged :
+ ( Store this )
+ Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
widget that i... Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
-widget that is using this Store as a Record cache should refresh its view. Listeners will be called with the following arguments: | Store | | exception :
- ( misc misc )
- Fires if an exception occurs in the Proxy during a remote request.
+widget that is using this Store as a Record cache should refresh its view. Listeners will be called with the following arguments: | Store | | exception :
+ ( misc misc )
+ Fires if an exception occurs in the Proxy during a remote request.
This event is relayed through the corresponding Ex... Fires if an exception occurs in the Proxy during a remote request.
This event is relayed through the corresponding Ext.data.DataProxy.
See Ext.data.DataProxy.exception
for additional details. Listeners will be called with the following arguments: | Store | | load :
- ( Store this , Ext.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. Listeners will be called with the following arguments: | Store | | loadexception :
- ( misc misc )
- This event is deprecated in favor of the catch-all exception
-event instead.
+for description. | Store | | load :
+ ( Store this , Ext.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. Listeners will be called with the following arguments: | Store | | loadexception :
+ ( misc misc )
+ This event is deprecated in favor of the catch-all exception
+event instead.
This event is relayed through the corresp... | Store | | metachange :
- ( Store this , Object meta )
- Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders. Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders. Listeners will be called with the following arguments:this : Storemeta : ObjectThe JSON metadata
| Store | | remove :
- ( Store this , Ext.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 Listeners will be called with the following arguments: | Store | | save :
- ( Ext.data.Store store , Number batch , Object data )
+for description. | Store | | metachange :
+ ( Store this , Object meta )
+ Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders. Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders. Listeners will be called with the following arguments:this : Storemeta : ObjectThe JSON metadata
| Store | | remove :
+ ( Store this , Ext.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 Listeners will be called with the following arguments: | Store | | save :
+ ( Ext.data.Store store , Number batch , Object data )
Fires after a save is completed. A save encompasses destroying records, updating records and creating records. Fires after a save is completed. A save encompasses destroying records, updating records and creating records. Listeners will be called with the following arguments:store : Ext.data.Storebatch : NumberThe identifier for the batch that was saved. data : ObjectAn object containing the data that is to be saved. The object will contain a key for each appropriate action,
-with an array of records for each action.
| Store | | update :
- ( Store this , Ext.data.Record record , String operation )
+with an array of records for each action. | Store | | update :
+ ( Store this , Ext.data.Record record , String operation )
Fires when a Record has been updated Fires when a Record has been updated Listeners will be called with the following arguments: | Store | | write :
- ( Ext.data.Store store , String action , Object result , Ext.Direct.Transaction res , Record/Record[] rs )
- Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
+ Ext.data.Record.COMMIT | Store | | write :
+ ( Ext.data.Store store , String action , Object result , Ext.Direct.Transaction res , Record/Record[] rs )
+ Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
Success of the action is determined in the... Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
Success of the action is determined in the result['successProperty'] property ( NOTE for RESTful stores,
a simple 20x response is sufficient for the actions "destroy" and "update". The "create" action should should return 200 along with a database pk). Listeners will be called with the following arguments:store : Ext.data.Storeaction : String[Ext.data.Api.actions.create|update|destroy] result : ObjectThe 'data' picked-out out of the response for convenience. res : Ext.Direct.Transactionrs : Record/Record[]Store's records, the subject(s) of the write-action
| Store |
\ No newline at end of file
|