1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.data.JsonStore</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.data.JsonStore-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.JsonStore-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.JsonStore-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.JsonStore-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.JsonStore
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
58 Class Roo.data.JsonStore
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_data_JsonStore.js.html">Roo/data/JsonStore.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">JsonStore</td></tr>
75 <tr><td class="label">Extends:</td><td class="hd-info">
76 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
84 <!-- ============================== class summary ========================== -->
85 <div class="description">
90 <!-- ============================== Class comment block... ========================== -->
92 <div class="comments">
93 <b>Class Comments / Notes</B> =>
94 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.JsonStore';">[Add Your comment/notes about this class]</u>
96 <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
97 src="/blog.php/GtkDjsComments/Roo.data.JsonStore.html"></iframe>
102 <!-- ============================== config options ========================== -->
107 <div class="hr"></div>
108 <a id="Roo.data.JsonStore-configs"></a>
114 <table cellspacing="0" class="member-table">
115 <caption>Config Options (Usually are also Properties)</caption>
119 <th class="sig-header" colspan="2">Options</th>
121 <th class="msource-header">Defined By</th>
128 <tr class="config-row expandable config-row-alt0">
129 <td class="micon"><a class="exi" href="#expand"> </a></td>
132 <a id="Roo.data.Store-cfg-baseParams" name=".baseParams"></a>
133 <div class="fixedFont">
134 <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
140 <div class="short">An object containing properties which are to be sent as parameters<br/>on any HTTP request</div>
145 An object containing properties which are to be sent as parameters<br/>on any HTTP request
155 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
161 <tr class="config-row expandable config-row-alt1">
162 <td class="micon"><a class="exi" href="#expand"> </a></td>
165 <a id="Roo.data.Store-cfg-data" name=".data"></a>
166 <div class="fixedFont">
167 <b class="itemname">data</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
173 <div class="short">Inline data to be loaded when the store is initialized.</div>
178 Inline data to be loaded when the store is initialized.
188 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.data.JsonStore-cfg-fields" name=".fields"></a>
199 <div class="fixedFont">
200 <b class="itemname">fields</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
206 <div class="short">An array of field definition objects, or field name strings.</div>
211 An array of field definition objects, or field name strings.
227 <tr class="config-row expandable config-row-alt1">
228 <td class="micon"><a class="exi" href="#expand"> </a></td>
231 <a id="Roo.data.Store-cfg-isLocal" name=".isLocal"></a>
232 <div class="fixedFont">
233 <b class="itemname">isLocal</b> : boolean
239 <div class="short">flag if data is locally available (and can be always looked up<br/>without a remote query - used by combo/forms at present.</div>
244 flag if data is locally available (and can be always looked up<br/>without a remote query - used by combo/forms at present.
254 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
260 <tr class="config-row expandable config-row-alt0">
261 <td class="micon"><a class="exi" href="#expand"> </a></td>
264 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
265 <div class="fixedFont">
266 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
272 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
277 list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
287 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
293 <tr class="config-row expandable config-row-alt1">
294 <td class="micon"><a class="exi" href="#expand"> </a></td>
297 <a id="Roo.data.Store-cfg-multiSort" name=".multiSort"></a>
298 <div class="fixedFont">
299 <b class="itemname">multiSort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
305 <div class="short">enable multi column sorting (sort is based on the order of columns, remote only at present)</div>
310 enable multi column sorting (sort is based on the order of columns, remote only at present)
320 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
326 <tr class="config-row expandable config-row-alt0">
327 <td class="micon"><a class="exi" href="#expand"> </a></td>
330 <a id="Roo.data.Store-cfg-proxy" name=".proxy"></a>
331 <div class="fixedFont">
332 <b class="itemname">proxy</b> : <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
338 <div class="short">The Proxy object which provides access to a data object.</div>
343 The Proxy object which provides access to a data object.
353 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
359 <tr class="config-row expandable config-row-alt1">
360 <td class="micon"><a class="exi" href="#expand"> </a></td>
363 <a id="Roo.data.Store-cfg-pruneModifiedRecords" name=".pruneModifiedRecords"></a>
364 <div class="fixedFont">
365 <b class="itemname">pruneModifiedRecords</b> : boolean
371 <div class="short">True to clear all modified record information each time the store is<br/>loaded or when a record is removed.</div>
376 True to clear all modified record information each time the store is<br/>loaded or when a record is removed. (defaults to false).
386 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
392 <tr class="config-row expandable config-row-alt0">
393 <td class="micon"><a class="exi" href="#expand"> </a></td>
396 <a id="Roo.data.Store-cfg-reader" name=".reader"></a>
397 <div class="fixedFont">
398 <b class="itemname">reader</b> : Roo.data.Reader
404 <div class="short">The Reader object which processes the data object and returns<br/>an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.</div>
409 The Reader object which processes the data object and returns<br/>an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.
419 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
425 <tr class="config-row expandable config-row-alt1">
426 <td class="micon"><a class="exi" href="#expand"> </a></td>
429 <a id="Roo.data.Store-cfg-remoteSort" name=".remoteSort"></a>
430 <div class="fixedFont">
431 <b class="itemname">remoteSort</b> : boolean
437 <div class="short">True if sorting is to be handled by requesting the Proxy to provide a refreshed<br/>version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).</div>
442 True if sorting is to be handled by requesting the Proxy to provide a refreshed<br/>version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).
452 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
458 <tr class="config-row expandable config-row-alt0">
459 <td class="micon"><a class="exi" href="#expand"> </a></td>
462 <a id="Roo.data.Store-cfg-sortInfo" name=".sortInfo"></a>
463 <div class="fixedFont">
464 <b class="itemname">sortInfo</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
470 <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"}</div>
475 A config object in the format: {field: "fieldName", direction: "ASC|DESC"}
485 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
501 <!-- ============================== public properties ==================== -->
505 <a id="Roo.data.JsonStore-props"></a>
511 <table cellspacing="0" class="member-table">
512 <caption class="Empty">Public Properties - Has None</caption>
518 <!-- ============================== methods summary / details ======================== -->
521 <a id="Roo.data.JsonStore-methods"></a>
522 <!-- constructor?? -->
529 <!-- then dynamics first -->
536 <table cellspacing="0" class="member-table">
537 <caption>Public Methods</caption>
539 <th class="sig-header" colspan="2">Method</th>
540 <th class="msource-header">Defined By</th>
550 <tr class="method-row config-row-alt0 expandable notInherited">
551 <td class="micon"><a class="exi" href="#expand"> </a></td>
555 <a id="Roo.data-method-JsonStore" name=".JsonStore"></a>
556 <div class="fixedFont">
557 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">JsonStore</b>
559 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
567 <div class="short">Create a new Roo.data.JsonStore</div>
574 Create a new Roo.data.JsonStore
577 <dl class="detailList">
578 <dt class="heading">Parameters:</dt>
581 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
608 <tr class="method-row config-row-alt1 expandable">
609 <td class="micon"><a class="exi" href="#expand"> </a></td>
613 <a id="Roo.data.Store-method-add" name=".add"></a>
614 <div class="fixedFont">
615 <span class="attributes"></span><b class="itemname">add</b>
617 (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>)
624 <div class="short">Add Records to the Store and fires the add event.</div>
630 Add Records to the Store and fires the add event.
637 <dl class="detailList">
638 <dt class="heading">Parameters:</dt>
641 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
644 <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
664 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
670 <tr class="method-row config-row-alt0 expandable">
671 <td class="micon"><a class="exi" href="#expand"> </a></td>
675 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
676 <div class="fixedFont">
677 <span class="attributes"></span><b class="itemname">addEvents</b>
679 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
686 <div class="short">Used to define events on this Observable</div>
692 Used to define events on this Observable
699 <dl class="detailList">
700 <dt class="heading">Parameters:</dt>
703 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
706 <dd>The object with the events defined</dd>
726 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
732 <tr class="method-row config-row-alt1 expandable">
733 <td class="micon"><a class="exi" href="#expand"> </a></td>
737 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
738 <div class="fixedFont">
739 <span class="attributes"></span><b class="itemname">addListener</b>
741 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
748 <div class="short">Appends an event handler to this component</div>
754 Appends an event handler to this component
761 <dl class="detailList">
762 <dt class="heading">Parameters:</dt>
765 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
768 <dd>The type of event to listen for</dd>
771 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
774 <dd>The method the event invokes</dd>
777 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
780 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
783 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
786 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
806 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
812 <tr class="method-row config-row-alt0 expandable">
813 <td class="micon"><a class="exi" href="#expand"> </a></td>
817 <a id="Roo.data.Store-method-clearFilter" name=".clearFilter"></a>
818 <div class="fixedFont">
819 <span class="attributes"></span><b class="itemname">clearFilter</b>
821 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
828 <div class="short">Revert to a view of the Record cache with no filtering applied.</div>
834 Revert to a view of the Record cache with no filtering applied.
841 <dl class="detailList">
842 <dt class="heading">Parameters:</dt>
845 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>suppressEvent</b>
848 <dd>If true the filter is cleared silently without notifying listeners</dd>
868 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
874 <tr class="method-row config-row-alt1 expandable">
875 <td class="micon"><a class="exi" href="#expand"> </a></td>
879 <a id="Roo.data.Store-method-collect" name=".collect"></a>
880 <div class="fixedFont">
881 <span class="attributes"></span><b class="itemname">collect</b>
883 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>allowNull</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>bypassFilter</i></B>)
889 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
898 <div class="short">Collects unique values for a particular dataIndex from this store.</div>
904 Collects unique values for a particular dataIndex from this store.
911 <dl class="detailList">
912 <dt class="heading">Parameters:</dt>
915 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
918 <dd>The property to collect</dd>
921 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>allowNull</b>
924 <dd>(optional) Pass true to allow null, undefined or empty string values</dd>
927 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>bypassFilter</b>
930 <dd>(optional) Pass true to collect from all records, even ones which are filtered</dd>
938 <dl class="detailList">
939 <dt class="heading">Returns:</dt>
941 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of the unique values</dd>
957 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
963 <tr class="method-row config-row-alt0 expandable">
964 <td class="micon"><a class="exi" href="#expand"> </a></td>
968 <a id="Roo.data.Store-method-commitChanges" name=".commitChanges"></a>
969 <div class="fixedFont">
970 <span class="attributes"></span><b class="itemname">commitChanges</b>
979 <div class="short">Commit all Records with outstanding changes.</div>
985 Commit all Records with outstanding changes. To handle updates for changes, subscribe to the<br/>Store's "update" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.
1006 <td class="msource">
1008 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1014 <tr class="method-row config-row-alt1 expandable">
1015 <td class="micon"><a class="exi" href="#expand"> </a></td>
1019 <a id="Roo.data.Store-method-each" name=".each"></a>
1020 <div class="fixedFont">
1021 <span class="attributes"></span><b class="itemname">each</b>
1023 (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1030 <div class="short">Calls the specified function for each of the Records in the cache.</div>
1036 Calls the specified function for each of the Records in the cache.
1043 <dl class="detailList">
1044 <dt class="heading">Parameters:</dt>
1047 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1050 <dd>The function to call. The Record is passed as the first parameter.<br/>Returning <em>false</em> aborts and exits the iteration.</dd>
1053 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1056 <dd>(optional) The scope in which to call the function (defaults to the Record).</dd>
1074 <td class="msource">
1076 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1082 <tr class="method-row config-row-alt0 expandable">
1083 <td class="micon"><a class="exi" href="#expand"> </a></td>
1087 <a id="Roo.data.Store-method-filter" name=".filter"></a>
1088 <div class="fixedFont">
1089 <span class="attributes"></span><b class="itemname">filter</b>
1091 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>field</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anyMatch</i></B>)
1098 <div class="short">Filter the records by a specified property.</div>
1104 Filter the records by a specified property.
1111 <dl class="detailList">
1112 <dt class="heading">Parameters:</dt>
1115 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>field</b>
1118 <dd>A field on your records</dd>
1121 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
1124 <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
1127 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>anyMatch</b>
1130 <dd>True to match any part not just the beginning</dd>
1148 <td class="msource">
1150 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1156 <tr class="method-row config-row-alt1 expandable">
1157 <td class="micon"><a class="exi" href="#expand"> </a></td>
1161 <a id="Roo.data.Store-method-filterBy" name=".filterBy"></a>
1162 <div class="fixedFont">
1163 <span class="attributes"></span><b class="itemname">filterBy</b>
1165 (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1172 <div class="short">Filter by a function.</div>
1178 Filter by a function. The specified function will be called with each<br/>record in this data source. If the function returns true the record is included,<br/>otherwise it is filtered.
1185 <dl class="detailList">
1186 <dt class="heading">Parameters:</dt>
1189 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1192 <dd>The function to be called, it will receive 2 args (record, id)</dd>
1195 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1198 <dd>(optional) The scope of the function (defaults to this)</dd>
1216 <td class="msource">
1218 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1224 <tr class="method-row config-row-alt0 expandable">
1225 <td class="micon"><a class="exi" href="#expand"> </a></td>
1229 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1230 <div class="fixedFont">
1231 <span class="attributes"></span><b class="itemname">fireEvent</b>
1233 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1239 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1248 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1254 Fires the specified event with the passed parameters (minus the event name).
1261 <dl class="detailList">
1262 <dt class="heading">Parameters:</dt>
1265 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1271 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1274 <dd>Variable number of parameters are passed to handlers</dd>
1282 <dl class="detailList">
1283 <dt class="heading">Returns:</dt>
1285 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1299 <td class="msource">
1301 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1307 <tr class="method-row config-row-alt1 expandable">
1308 <td class="micon"><a class="exi" href="#expand"> </a></td>
1312 <a id="Roo.data.Store-method-getAt" name=".getAt"></a>
1313 <div class="fixedFont">
1314 <span class="attributes"></span><b class="itemname">getAt</b>
1316 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1322 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
1331 <div class="short">Get the Record at the specified index.</div>
1337 Get the Record at the specified index.
1344 <dl class="detailList">
1345 <dt class="heading">Parameters:</dt>
1348 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1351 <dd>The index of the Record to find.</dd>
1359 <dl class="detailList">
1360 <dt class="heading">Returns:</dt>
1362 <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> The Record at the passed index. Returns undefined if not found.</dd>
1376 <td class="msource">
1378 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1384 <tr class="method-row config-row-alt0 expandable">
1385 <td class="micon"><a class="exi" href="#expand"> </a></td>
1389 <a id="Roo.data.Store-method-getById" name=".getById"></a>
1390 <div class="fixedFont">
1391 <span class="attributes"></span><b class="itemname">getById</b>
1393 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1399 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
1408 <div class="short">Get the Record with the specified id.</div>
1414 Get the Record with the specified id.
1421 <dl class="detailList">
1422 <dt class="heading">Parameters:</dt>
1425 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1428 <dd>The id of the Record to find.</dd>
1436 <dl class="detailList">
1437 <dt class="heading">Returns:</dt>
1439 <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> The Record with the passed id. Returns undefined if not found.</dd>
1453 <td class="msource">
1455 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1461 <tr class="method-row config-row-alt1 expandable">
1462 <td class="micon"><a class="exi" href="#expand"> </a></td>
1466 <a id="Roo.data.Store-method-getCount" name=".getCount"></a>
1467 <div class="fixedFont">
1468 <span class="attributes"></span><b class="itemname">getCount</b>
1477 <div class="short">Gets the number of cached records.</div>
1483 Gets the number of cached records.<br/><p><br/><em>If using paging, this may not be the total size of the dataset. If the data object<br/>used by the Reader contains the dataset size, then the getTotalCount() function returns<br/>the data set size</em>
1504 <td class="msource">
1506 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1512 <tr class="method-row config-row-alt0 expandable">
1513 <td class="micon"><a class="exi" href="#expand"> </a></td>
1517 <a id="Roo.data.Store-method-getModifiedRecords" name=".getModifiedRecords"></a>
1518 <div class="fixedFont">
1519 <span class="attributes"></span><b class="itemname">getModifiedRecords</b>
1527 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
1536 <div class="short">Gets all records modified since the last commit.</div>
1542 Gets all records modified since the last commit. Modified records are persisted across load operations<br/>(e.g., during paging).
1553 <dl class="detailList">
1554 <dt class="heading">Returns:</dt>
1556 <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> An array of Records containing outstanding modifications.</dd>
1570 <td class="msource">
1572 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1578 <tr class="method-row config-row-alt1 expandable">
1579 <td class="micon"><a class="exi" href="#expand"> </a></td>
1583 <a id="Roo.data.Store-method-getRange" name=".getRange"></a>
1584 <div class="fixedFont">
1585 <span class="attributes"></span><b class="itemname">getRange</b>
1587 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endIndex</i></B>)
1593 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
1602 <div class="short">Returns a range of Records between specified indices.</div>
1608 Returns a range of Records between specified indices.
1615 <dl class="detailList">
1616 <dt class="heading">Parameters:</dt>
1619 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startIndex</b>
1622 <dd>(optional) The starting index (defaults to 0)</dd>
1625 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endIndex</b>
1628 <dd>(optional) The ending index (defaults to the last Record in the Store)</dd>
1636 <dl class="detailList">
1637 <dt class="heading">Returns:</dt>
1639 <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> An array of Records</dd>
1653 <td class="msource">
1655 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1661 <tr class="method-row config-row-alt0 expandable">
1662 <td class="micon"><a class="exi" href="#expand"> </a></td>
1666 <a id="Roo.data.Store-method-getSortState" name=".getSortState"></a>
1667 <div class="fixedFont">
1668 <span class="attributes"></span><b class="itemname">getSortState</b>
1677 <div class="short">Returns the sort state of the Store as an object with two properties:<br/><pre><code><br/> field {String} The name of the field by which the Records are sorted<br/> direction {String} The sort order, "ASC" or "DESC"<br/></code></pre></div>
1683 Returns the sort state of the Store as an object with two properties:<br/><pre><code><br/> field {String} The name of the field by which the Records are sorted<br/> direction {String} The sort order, "ASC" or "DESC"<br/></code></pre>
1704 <td class="msource">
1706 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1712 <tr class="method-row config-row-alt1 expandable">
1713 <td class="micon"><a class="exi" href="#expand"> </a></td>
1717 <a id="Roo.data.Store-method-getTotalCount" name=".getTotalCount"></a>
1718 <div class="fixedFont">
1719 <span class="attributes"></span><b class="itemname">getTotalCount</b>
1728 <div class="short">Gets the total number of records in the dataset as returned by the server.</div>
1734 Gets the total number of records in the dataset as returned by the server.<br/><p><br/><em>If using paging, for this to be accurate, the data object used by the Reader must contain<br/>the dataset size</em>
1755 <td class="msource">
1757 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1763 <tr class="method-row config-row-alt0 expandable">
1764 <td class="micon"><a class="exi" href="#expand"> </a></td>
1768 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1769 <div class="fixedFont">
1770 <span class="attributes"></span><b class="itemname">hasListener</b>
1772 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1778 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1787 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1793 Checks to see if this object has any listeners for a specified event
1800 <dl class="detailList">
1801 <dt class="heading">Parameters:</dt>
1804 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1807 <dd>The name of the event to check for</dd>
1815 <dl class="detailList">
1816 <dt class="heading">Returns:</dt>
1818 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1832 <td class="msource">
1834 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1840 <tr class="method-row config-row-alt1 expandable">
1841 <td class="micon"><a class="exi" href="#expand"> </a></td>
1845 <a id="Roo.data.Store-method-indexOf" name=".indexOf"></a>
1846 <div class="fixedFont">
1847 <span class="attributes"></span><b class="itemname">indexOf</b>
1849 (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>)
1855 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1864 <div class="short">Get the index within the cache of the passed Record.</div>
1870 Get the index within the cache of the passed Record.
1877 <dl class="detailList">
1878 <dt class="heading">Parameters:</dt>
1881 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
1884 <dd>The Roo.data.Record object to to find.</dd>
1892 <dl class="detailList">
1893 <dt class="heading">Returns:</dt>
1895 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The index of the passed Record. Returns -1 if not found.</dd>
1909 <td class="msource">
1911 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1917 <tr class="method-row config-row-alt0 expandable">
1918 <td class="micon"><a class="exi" href="#expand"> </a></td>
1922 <a id="Roo.data.Store-method-indexOfId" name=".indexOfId"></a>
1923 <div class="fixedFont">
1924 <span class="attributes"></span><b class="itemname">indexOfId</b>
1926 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1932 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1941 <div class="short">Get the index within the cache of the Record with the passed id.</div>
1947 Get the index within the cache of the Record with the passed id.
1954 <dl class="detailList">
1955 <dt class="heading">Parameters:</dt>
1958 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1961 <dd>The id of the Record to find.</dd>
1969 <dl class="detailList">
1970 <dt class="heading">Returns:</dt>
1972 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The index of the Record. Returns -1 if not found.</dd>
1986 <td class="msource">
1988 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1994 <tr class="method-row config-row-alt1 expandable">
1995 <td class="micon"><a class="exi" href="#expand"> </a></td>
1999 <a id="Roo.data.Store-method-insert" name=".insert"></a>
2000 <div class="fixedFont">
2001 <span class="attributes"></span><b class="itemname">insert</b>
2003 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>)
2010 <div class="short">Inserts Records to the Store at the given index and fires the add event.</div>
2016 Inserts Records to the Store at the given index and fires the add event.
2023 <dl class="detailList">
2024 <dt class="heading">Parameters:</dt>
2027 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2030 <dd>The start index at which to insert the passed Records.</dd>
2033 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
2036 <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
2054 <td class="msource">
2056 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2062 <tr class="method-row config-row-alt0 expandable">
2063 <td class="micon"><a class="exi" href="#expand"> </a></td>
2067 <a id="Roo.data.Store-method-load" name=".load"></a>
2068 <div class="fixedFont">
2069 <span class="attributes"></span><b class="itemname">load</b>
2071 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2078 <div class="short">Loads the Record cache from the configured Proxy using the configured Reader.</div>
2084 Loads the Record cache from the configured Proxy using the configured Reader.<br/><p><br/>If using remote paging, then the first load call must specify the <em>start</em><br/>and <em>limit</em> properties in the options.params property to establish the initial<br/>position within the dataset, and the number of Records to cache on each read from the Proxy.<br/><p><br/><strong>It is important to note that for remote data sources, loading is asynchronous,<br/>and this call will return before the new data has been loaded. Perform any post-processing<br/>in a callback function, or in a "load" event handler.</strong><br/><p>
2091 <dl class="detailList">
2092 <dt class="heading">Parameters:</dt>
2095 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
2098 <dd>An object containing properties which control loading options:<ul><br/><li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li><br/><li>callback {Function} A function to be called after the Records have been loaded. The callback is<br/>passed the following arguments:<ul><br/><li>r : Roo.data.Record[]</li><br/><li>options: Options object from the load call</li><br/><li>success: Boolean success indicator</li></ul></li><br/><li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li><br/><li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li><br/></ul></dd>
2116 <td class="msource">
2118 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2124 <tr class="method-row config-row-alt1 expandable">
2125 <td class="micon"><a class="exi" href="#expand"> </a></td>
2129 <a id="Roo.data.Store-method-loadData" name=".loadData"></a>
2130 <div class="fixedFont">
2131 <span class="attributes"></span><b class="itemname">loadData</b>
2133 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>append</i></B>)
2140 <div class="short">Loads data from a passed data block.</div>
2146 Loads data from a passed data block. A Reader which understands the format of the data<br/>must have been configured in the constructor.
2153 <dl class="detailList">
2154 <dt class="heading">Parameters:</dt>
2157 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
2160 <dd>The data block from which to read the Records. The format of the data expected<br/>is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.</dd>
2163 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>append</b>
2166 <dd>(Optional) True to append the new Records rather than replace the existing cache.</dd>
2184 <td class="msource">
2186 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2192 <tr class="method-row config-row-alt0 expandable">
2193 <td class="micon"><a class="exi" href="#expand"> </a></td>
2197 <a id="Roo.util.Observable-method-on" name=".on"></a>
2198 <div class="fixedFont">
2199 <span class="attributes"></span><b class="itemname">on</b>
2201 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2208 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2214 Appends an event handler to this element (shorthand for addListener)
2221 <dl class="detailList">
2222 <dt class="heading">Parameters:</dt>
2225 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2228 <dd>The type of event to listen for</dd>
2231 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2234 <dd>The method the event invokes</dd>
2237 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2240 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2243 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
2264 <td class="msource">
2266 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2272 <tr class="method-row config-row-alt1 expandable">
2273 <td class="micon"><a class="exi" href="#expand"> </a></td>
2277 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2278 <div class="fixedFont">
2279 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2288 <div class="short">Removes all listeners for this object</div>
2294 Removes all listeners for this object
2315 <td class="msource">
2317 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2323 <tr class="method-row config-row-alt0 expandable">
2324 <td class="micon"><a class="exi" href="#expand"> </a></td>
2328 <a id="Roo.data.Store-method-query" name=".query"></a>
2329 <div class="fixedFont">
2330 <span class="attributes"></span><b class="itemname">query</b>
2332 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>field</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anyMatch</i></B>)
2347 <div class="short">Query the records by a specified property.</div>
2353 Query the records by a specified property.
2360 <dl class="detailList">
2361 <dt class="heading">Parameters:</dt>
2364 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>field</b>
2367 <dd>A field on your records</dd>
2370 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
2373 <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
2376 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>anyMatch</b>
2379 <dd>True to match any part not just the beginning</dd>
2387 <dl class="detailList">
2388 <dt class="heading">Returns:</dt>
2390 <dd><span class="fixedFont">MixedCollection</span> Returns an Roo.util.MixedCollection of the matched records</dd>
2404 <td class="msource">
2406 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2412 <tr class="method-row config-row-alt1 expandable">
2413 <td class="micon"><a class="exi" href="#expand"> </a></td>
2417 <a id="Roo.data.Store-method-queryBy" name=".queryBy"></a>
2418 <div class="fixedFont">
2419 <span class="attributes"></span><b class="itemname">queryBy</b>
2421 (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2436 <div class="short">Query by a function.</div>
2442 Query by a function. The specified function will be called with each<br/>record in this data source. If the function returns true the record is included<br/>in the results.
2449 <dl class="detailList">
2450 <dt class="heading">Parameters:</dt>
2453 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
2456 <dd>The function to be called, it will receive 2 args (record, id)</dd>
2459 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2462 <dd>(optional) The scope of the function (defaults to this)</dd>
2470 <dl class="detailList">
2471 <dt class="heading">Returns:</dt>
2473 <dd><span class="fixedFont">MixedCollection</span> Returns an Roo.util.MixedCollection of the matched records</dd>
2487 <td class="msource">
2489 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2495 <tr class="method-row config-row-alt0 expandable">
2496 <td class="micon"><a class="exi" href="#expand"> </a></td>
2500 <a id="Roo.data.Store-method-rejectChanges" name=".rejectChanges"></a>
2501 <div class="fixedFont">
2502 <span class="attributes"></span><b class="itemname">rejectChanges</b>
2511 <div class="short">Cancel outstanding changes on all changed records.</div>
2517 Cancel outstanding changes on all changed records.
2538 <td class="msource">
2540 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2546 <tr class="method-row config-row-alt1 expandable">
2547 <td class="micon"><a class="exi" href="#expand"> </a></td>
2551 <a id="Roo.data.Store-method-reload" name=".reload"></a>
2552 <div class="fixedFont">
2553 <span class="attributes"></span><b class="itemname">reload</b>
2555 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2562 <div class="short">Reloads the Record cache from the configured Proxy using the configured Reader and<br/>the options from the last load operation performed.</div>
2568 Reloads the Record cache from the configured Proxy using the configured Reader and<br/>the options from the last load operation performed.
2575 <dl class="detailList">
2576 <dt class="heading">Parameters:</dt>
2579 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
2582 <dd>(optional) An object containing properties which may override the options<br/>used in the last load operation. See {<b>link</b> <b>load</b>} for details (defaults to null, in which case<br/>the most recently used options are reused).</dd>
2600 <td class="msource">
2602 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2608 <tr class="method-row config-row-alt0 expandable">
2609 <td class="micon"><a class="exi" href="#expand"> </a></td>
2613 <a id="Roo.data.Store-method-remove" name=".remove"></a>
2614 <div class="fixedFont">
2615 <span class="attributes"></span><b class="itemname">remove</b>
2617 (Ext.data.Record <B><i>record</i></B>)
2624 <div class="short">Remove a Record from the Store and fires the remove event.</div>
2630 Remove a Record from the Store and fires the remove event.
2637 <dl class="detailList">
2638 <dt class="heading">Parameters:</dt>
2641 <span class="fixedFont">Ext.data.Record</span> <b>record</b>
2644 <dd>The Roo.data.Record object to remove from the cache.</dd>
2662 <td class="msource">
2664 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2670 <tr class="method-row config-row-alt1 expandable">
2671 <td class="micon"><a class="exi" href="#expand"> </a></td>
2675 <a id="Roo.data.Store-method-removeAll" name=".removeAll"></a>
2676 <div class="fixedFont">
2677 <span class="attributes"></span><b class="itemname">removeAll</b>
2686 <div class="short">Remove all Records from the Store and fires the clear event.</div>
2692 Remove all Records from the Store and fires the clear event.
2713 <td class="msource">
2715 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2721 <tr class="method-row config-row-alt0 expandable">
2722 <td class="micon"><a class="exi" href="#expand"> </a></td>
2726 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2727 <div class="fixedFont">
2728 <span class="attributes"></span><b class="itemname">removeListener</b>
2730 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2737 <div class="short">Removes a listener</div>
2750 <dl class="detailList">
2751 <dt class="heading">Parameters:</dt>
2754 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2757 <dd>The type of event to listen for</dd>
2760 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2763 <dd>The handler to remove</dd>
2766 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2769 <dd>(optional) The scope (this object) for the handler</dd>
2787 <td class="msource">
2789 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2795 <tr class="method-row config-row-alt1 expandable">
2796 <td class="micon"><a class="exi" href="#expand"> </a></td>
2800 <a id="Roo.data.Store-method-setDefaultSort" name=".setDefaultSort"></a>
2801 <div class="fixedFont">
2802 <span class="attributes"></span><b class="itemname">setDefaultSort</b>
2804 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>fieldName</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dir</i></B>)
2811 <div class="short">Sets the default sort column and order to be used by the next load operation.</div>
2817 Sets the default sort column and order to be used by the next load operation.
2824 <dl class="detailList">
2825 <dt class="heading">Parameters:</dt>
2828 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>fieldName</b>
2831 <dd>The name of the field to sort by.</dd>
2834 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dir</b>
2837 <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
2855 <td class="msource">
2857 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2863 <tr class="method-row config-row-alt0 expandable">
2864 <td class="micon"><a class="exi" href="#expand"> </a></td>
2868 <a id="Roo.data.Store-method-sort" name=".sort"></a>
2869 <div class="fixedFont">
2870 <span class="attributes"></span><b class="itemname">sort</b>
2872 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>fieldName</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dir</i></B>)
2879 <div class="short">Sort the Records.</div>
2885 Sort the Records.<br/>If remote sorting is used, the sort is performed on the server, and the cache is<br/>reloaded. If local sorting is used, the cache is sorted internally.
2892 <dl class="detailList">
2893 <dt class="heading">Parameters:</dt>
2896 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>fieldName</b>
2899 <dd>The name of the field to sort by.</dd>
2902 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dir</b>
2905 <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
2923 <td class="msource">
2925 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2931 <tr class="method-row config-row-alt1 expandable">
2932 <td class="micon"><a class="exi" href="#expand"> </a></td>
2936 <a id="Roo.data.Store-method-sum" name=".sum"></a>
2937 <div class="fixedFont">
2938 <span class="attributes"></span><b class="itemname">sum</b>
2940 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>property</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>start</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>end</i></B>)
2946 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
2955 <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div>
2961 Sums the value of <i>property</i> for each record between start and end and returns the result.
2968 <dl class="detailList">
2969 <dt class="heading">Parameters:</dt>
2972 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>property</b>
2975 <dd>A field on your records</dd>
2978 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>start</b>
2981 <dd>The record index to start at (defaults to 0)</dd>
2984 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>end</b>
2987 <dd>The last record index to include (defaults to length - 1)</dd>
2995 <dl class="detailList">
2996 <dt class="heading">Returns:</dt>
2998 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The sum</dd>
3012 <td class="msource">
3014 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3020 <tr class="method-row config-row-alt0 expandable">
3021 <td class="micon"><a class="exi" href="#expand"> </a></td>
3025 <a id="Roo.util.Observable-method-un" name=".un"></a>
3026 <div class="fixedFont">
3027 <span class="attributes"></span><b class="itemname">un</b>
3029 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3036 <div class="short">Removes a listener (shorthand for removeListener)</div>
3042 Removes a listener (shorthand for removeListener)
3049 <dl class="detailList">
3050 <dt class="heading">Parameters:</dt>
3053 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3056 <dd>The type of event to listen for</dd>
3059 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3062 <dd>The handler to remove</dd>
3065 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
3068 <dd>(optional) The scope (this object) for the handler</dd>
3086 <td class="msource">
3088 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3097 <!-- ============================== events summary / details ======================== -->
3100 <a id="Roo.data.JsonStore-events"></a>
3109 <table cellspacing="0" class="member-table">
3110 <caption>Events</caption>
3113 <th class="sig-header" colspan="2">Event</th>
3114 <th class="msource-header">Defined By</th>
3123 <tr class="method-row expandable config-row-alt0">
3124 <td class="micon"><a class="exi" href="#expand"> </a></td>
3127 <a id="Roo.data.Store-event-*add"></a>
3129 <div class="fixedFont">
3130 <b class="itemname">add</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
3136 <div class="short">Fires when Records have been added to the Store
3142 Fires when Records have been added to the Store
3148 <dl class="detailList">
3149 <dt class="heading">Parameters:</dt>
3152 <span class="fixedFont">Store</span> <b>this</b>
3158 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
3161 <dd>The array of Records added</dd>
3164 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
3167 <dd>The index at which the record(s) were added</dd>
3185 <td class="msource">
3186 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3190 <tr class="method-row expandable config-row-alt1">
3191 <td class="micon"><a class="exi" href="#expand"> </a></td>
3194 <a id="Roo.data.Store-event-*beforeload"></a>
3196 <div class="fixedFont">
3197 <b class="itemname">beforeload</b> (Store <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3203 <div class="short">Fires before a request is made for a new data object.
3209 Fires before a request is made for a new data object. If the beforeload handler returns false<br/>the load action will be canceled.
3215 <dl class="detailList">
3216 <dt class="heading">Parameters:</dt>
3219 <span class="fixedFont">Store</span> <b>this</b>
3225 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
3228 <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
3246 <td class="msource">
3247 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3251 <tr class="method-row expandable config-row-alt0">
3252 <td class="micon"><a class="exi" href="#expand"> </a></td>
3255 <a id="Roo.data.Store-event-*beforeloadadd"></a>
3257 <div class="fixedFont">
3258 <b class="itemname">beforeloadadd</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3264 <div class="short">Fires after a new set of Records has been loaded.
3270 Fires after a new set of Records has been loaded.
3276 <dl class="detailList">
3277 <dt class="heading">Parameters:</dt>
3280 <span class="fixedFont">Store</span> <b>this</b>
3286 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
3289 <dd>The Records that were loaded</dd>
3292 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
3295 <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
3313 <td class="msource">
3314 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3318 <tr class="method-row expandable config-row-alt1">
3319 <td class="micon"><a class="exi" href="#expand"> </a></td>
3322 <a id="Roo.data.Store-event-*clear"></a>
3324 <div class="fixedFont">
3325 <b class="itemname">clear</b> (Store <B><i>this</i></B>)
3331 <div class="short">Fires when the data cache has been cleared.
3337 Fires when the data cache has been cleared.
3343 <dl class="detailList">
3344 <dt class="heading">Parameters:</dt>
3347 <span class="fixedFont">Store</span> <b>this</b>
3368 <td class="msource">
3369 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3373 <tr class="method-row expandable config-row-alt0">
3374 <td class="micon"><a class="exi" href="#expand"> </a></td>
3377 <a id="Roo.data.Store-event-*datachanged"></a>
3379 <div class="fixedFont">
3380 <b class="itemname">datachanged</b> (Store <B><i>this</i></B>)
3386 <div class="short">Fires when the data cache has changed, and a widget which is using this Store<br/>as a Record cache should refresh its view.
3392 Fires when the data cache has changed, and a widget which is using this Store<br/>as a Record cache should refresh its view.
3398 <dl class="detailList">
3399 <dt class="heading">Parameters:</dt>
3402 <span class="fixedFont">Store</span> <b>this</b>
3423 <td class="msource">
3424 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3428 <tr class="method-row expandable config-row-alt1">
3429 <td class="micon"><a class="exi" href="#expand"> </a></td>
3432 <a id="Roo.data.Store-event-*load"></a>
3434 <div class="fixedFont">
3435 <b class="itemname">load</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3441 <div class="short">Fires after a new set of Records has been loaded, before they are added to the store.
3447 Fires after a new set of Records has been loaded, before they are added to the store.
3453 <dl class="detailList">
3454 <dt class="heading">Parameters:</dt>
3457 <span class="fixedFont">Store</span> <b>this</b>
3463 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
3466 <dd>The Records that were loaded</dd>
3469 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
3472 <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
3490 <td class="msource">
3491 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3495 <tr class="method-row expandable config-row-alt0">
3496 <td class="micon"><a class="exi" href="#expand"> </a></td>
3499 <a id="Roo.data.Store-event-*loadexception"></a>
3501 <div class="fixedFont">
3502 <b class="itemname">loadexception</b> (Proxy <B><i></i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>return</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>load</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>jsonData</i></B>)
3508 <div class="short">Fires if an exception occurs in the Proxy during loading.
3514 Fires if an exception occurs in the Proxy during loading.<br/>Called with the signature of the Proxy's "loadexception" event.<br/>If you return Json { data: [] , success: false, .... } then this will be thrown with the following args
3520 <dl class="detailList">
3521 <dt class="heading">Parameters:</dt>
3524 <span class="fixedFont">Proxy</span> <b></b>
3530 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>return</b>
3533 <dd>from JsonData.reader() - success, totalRecords, records</dd>
3536 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>load</b>
3542 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>jsonData</b>
3545 <dd>from your request (normally this contains the Exception)</dd>
3563 <td class="msource">
3564 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3568 <tr class="method-row expandable config-row-alt1">
3569 <td class="micon"><a class="exi" href="#expand"> </a></td>
3572 <a id="Roo.data.Store-event-*metachange"></a>
3574 <div class="fixedFont">
3575 <b class="itemname">metachange</b> (Store <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>meta</i></B>)
3581 <div class="short">Fires when this store's reader provides new metadata (fields).
3587 Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.
3593 <dl class="detailList">
3594 <dt class="heading">Parameters:</dt>
3597 <span class="fixedFont">Store</span> <b>this</b>
3603 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>meta</b>
3606 <dd>The JSON metadata</dd>
3624 <td class="msource">
3625 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3629 <tr class="method-row expandable config-row-alt0">
3630 <td class="micon"><a class="exi" href="#expand"> </a></td>
3633 <a id="Roo.data.Store-event-*remove"></a>
3635 <div class="fixedFont">
3636 <b class="itemname">remove</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
3642 <div class="short">Fires when a Record has been removed from the Store
3648 Fires when a Record has been removed from the Store
3654 <dl class="detailList">
3655 <dt class="heading">Parameters:</dt>
3658 <span class="fixedFont">Store</span> <b>this</b>
3664 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
3667 <dd>The Record that was removed</dd>
3670 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
3673 <dd>The index at which the record was removed</dd>
3691 <td class="msource">
3692 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3696 <tr class="method-row expandable config-row-alt1">
3697 <td class="micon"><a class="exi" href="#expand"> </a></td>
3700 <a id="Roo.data.Store-event-*update"></a>
3702 <div class="fixedFont">
3703 <b class="itemname">update</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>operation</i></B>)
3709 <div class="short">Fires when a Record has been updated
3715 Fires when a Record has been updated
3721 <dl class="detailList">
3722 <dt class="heading">Parameters:</dt>
3725 <span class="fixedFont">Store</span> <b>this</b>
3731 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
3734 <dd>The Record that was updated</dd>
3737 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>operation</b>
3740 <dd>The update operation being performed. Value may be one of:<br/><pre><code><br/> Roo.data.Record.EDIT<br/> Roo.data.Record.REJECT<br/> Roo.data.Record.COMMIT<br/></code></pre></dd>
3758 <td class="msource">
3759 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3770 <!-- ============================== footer ================================= -->
3771 <div class="fineprint" style="clear:both">
3773 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Nov 09 2015 15:26:56 GMT+0800 (HKT)
3775 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>