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.Store</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.Store-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.Store-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.Store-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.Store-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.Store
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_data_Store.js.html">Roo/data/Store.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Store</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 The Store class encapsulates a client side cache of {<b>link</b> Roo.data.Record} objects which provide input data<br/>for widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.<br><br/><p><br/>A Store object uses an implementation of {<b>link</b> Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object<br/>has no knowledge of the format of the data returned by the Proxy.<br><br/><p><br/>A Store object uses its configured implementation of {<b>link</b> Roo.data.DataReader} to create {<b>link</b> Roo.data.Record}<br/>instances from the data object. These records are cached and made available through accessor functions.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.Store';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.data.Store.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.data.Store-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.data.Store-cfg-baseParams" name=".baseParams"></a>
132 <div class="fixedFont">
133 <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
139 <div class="short">An object containing properties which are to be sent as parameters<br/>on any HTTP request</div>
143 <div class="long">An object containing properties which are to be sent as parameters<br/>on any HTTP request</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.data.Store-cfg-data" name=".data"></a>
162 <div class="fixedFont">
163 <b class="itemname">data</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
169 <div class="short">Inline data to be loaded when the store is initialized.</div>
173 <div class="long">Inline data to be loaded when the store is initialized.</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.data.Store-cfg-isLocal" name=".isLocal"></a>
192 <div class="fixedFont">
193 <b class="itemname">isLocal</b> : boolean
199 <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>
203 <div class="long">flag if data is locally available (and can be always looked up<br/>without a remote query - used by combo/forms at present.</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.data.Store-cfg-proxy" name=".proxy"></a>
222 <div class="fixedFont">
223 <b class="itemname">proxy</b> : <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
229 <div class="short">The Proxy object which provides access to a data object.</div>
233 <div class="long">The Proxy object which provides access to a data object.</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.data.Store-cfg-pruneModifiedRecords" name=".pruneModifiedRecords"></a>
252 <div class="fixedFont">
253 <b class="itemname">pruneModifiedRecords</b> : boolean
259 <div class="short">True to clear all modified record information each time the store is<br/>loaded or when a record is removed.</div>
263 <div class="long">True to clear all modified record information each time the store is<br/>loaded or when a record is removed. (defaults to false).</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.data.Store-cfg-reader" name=".reader"></a>
282 <div class="fixedFont">
283 <b class="itemname">reader</b> : Roo.data.Reader
289 <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>
293 <div class="long">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>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.data.Store-cfg-remoteSort" name=".remoteSort"></a>
312 <div class="fixedFont">
313 <b class="itemname">remoteSort</b> : boolean
319 <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>
323 <div class="long">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>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.data.Store-cfg-sortInfo" name=".sortInfo"></a>
342 <div class="fixedFont">
343 <b class="itemname">sortInfo</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
349 <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"}</div>
353 <div class="long">A config object in the format: {field: "fieldName", direction: "ASC|DESC"}</div>
377 <!-- ============================== public properties ==================== -->
381 <a id="Roo.data.Store-props"></a>
387 <table cellspacing="0" class="member-table">
388 <caption class="Empty">Public Properties - Has None</caption>
394 <!-- ============================== methods summary / details ======================== -->
397 <a id="Roo.data.Store-methods"></a>
398 <!-- constructor?? -->
405 <!-- then dynamics first -->
412 <table cellspacing="0" class="member-table">
413 <caption>Public Methods</caption>
415 <th class="sig-header" colspan="2">Method</th>
416 <th class="msource-header">Defined By</th>
426 <tr class="method-row config-row-alt0 expandable notInherited">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.data-method-Store" name=".Store"></a>
432 <div class="fixedFont">
433 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">Store</b>
435 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
443 <div class="short">Create a new Roo.data.Store</div>
450 Create a new Roo.data.Store
453 <dl class="detailList">
454 <dt class="heading">Parameters:</dt>
457 <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>
460 <dd>A config object containing the objects needed for the Store to access data,<br/>and read the data into Records.</dd>
484 <tr class="method-row config-row-alt1 expandable notInherited">
485 <td class="micon"><a class="exi" href="#expand"> </a></td>
489 <a id="Roo.data.Store-method-add" name=".add"></a>
490 <div class="fixedFont">
491 <span class="attributes"></span><b class="itemname">add</b>
493 (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>)
500 <div class="short">Add Records to the Store and fires the add event.</div>
506 Add Records to the Store and fires the add event.
513 <dl class="detailList">
514 <dt class="heading">Parameters:</dt>
517 <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>
520 <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
546 <tr class="method-row config-row-alt0 expandable notInherited">
547 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.data.Store-method-clearFilter" name=".clearFilter"></a>
552 <div class="fixedFont">
553 <span class="attributes"></span><b class="itemname">clearFilter</b>
555 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
562 <div class="short">Revert to a view of the Record cache with no filtering applied.</div>
568 Revert to a view of the Record cache with no filtering applied.
575 <dl class="detailList">
576 <dt class="heading">Parameters:</dt>
579 <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>
582 <dd>If true the filter is cleared silently without notifying listeners</dd>
608 <tr class="method-row config-row-alt1 expandable notInherited">
609 <td class="micon"><a class="exi" href="#expand"> </a></td>
613 <a id="Roo.data.Store-method-collect" name=".collect"></a>
614 <div class="fixedFont">
615 <span class="attributes"></span><b class="itemname">collect</b>
617 (<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>)
623 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
632 <div class="short">Collects unique values for a particular dataIndex from this store.</div>
638 Collects unique values for a particular dataIndex from this store.
645 <dl class="detailList">
646 <dt class="heading">Parameters:</dt>
649 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
652 <dd>The property to collect</dd>
655 <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>
658 <dd>(optional) Pass true to allow null, undefined or empty string values</dd>
661 <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>
664 <dd>(optional) Pass true to collect from all records, even ones which are filtered</dd>
672 <dl class="detailList">
673 <dt class="heading">Returns:</dt>
675 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of the unique values</dd>
697 <tr class="method-row config-row-alt0 expandable notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
702 <a id="Roo.data.Store-method-commitChanges" name=".commitChanges"></a>
703 <div class="fixedFont">
704 <span class="attributes"></span><b class="itemname">commitChanges</b>
713 <div class="short">Commit all Records with outstanding changes.</div>
719 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.
748 <tr class="method-row config-row-alt1 expandable notInherited">
749 <td class="micon"><a class="exi" href="#expand"> </a></td>
753 <a id="Roo.data.Store-method-each" name=".each"></a>
754 <div class="fixedFont">
755 <span class="attributes"></span><b class="itemname">each</b>
757 (<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>)
764 <div class="short">Calls the specified function for each of the Records in the cache.</div>
770 Calls the specified function for each of the Records in the cache.
777 <dl class="detailList">
778 <dt class="heading">Parameters:</dt>
781 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
784 <dd>The function to call. The Record is passed as the first parameter.<br/>Returning <em>false</em> aborts and exits the iteration.</dd>
787 <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>
790 <dd>(optional) The scope in which to call the function (defaults to the Record).</dd>
816 <tr class="method-row config-row-alt0 expandable notInherited">
817 <td class="micon"><a class="exi" href="#expand"> </a></td>
821 <a id="Roo.data.Store-method-filter" name=".filter"></a>
822 <div class="fixedFont">
823 <span class="attributes"></span><b class="itemname">filter</b>
825 (<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>)
832 <div class="short">Filter the records by a specified property.</div>
838 Filter the records by a specified property.
845 <dl class="detailList">
846 <dt class="heading">Parameters:</dt>
849 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>field</b>
852 <dd>A field on your records</dd>
855 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
858 <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
861 <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>
864 <dd>True to match any part not just the beginning</dd>
890 <tr class="method-row config-row-alt1 expandable notInherited">
891 <td class="micon"><a class="exi" href="#expand"> </a></td>
895 <a id="Roo.data.Store-method-filterBy" name=".filterBy"></a>
896 <div class="fixedFont">
897 <span class="attributes"></span><b class="itemname">filterBy</b>
899 (<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>)
906 <div class="short">Filter by a function.</div>
912 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.
919 <dl class="detailList">
920 <dt class="heading">Parameters:</dt>
923 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
926 <dd>The function to be called, it will receive 2 args (record, id)</dd>
929 <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>
932 <dd>(optional) The scope of the function (defaults to this)</dd>
958 <tr class="method-row config-row-alt0 expandable notInherited">
959 <td class="micon"><a class="exi" href="#expand"> </a></td>
963 <a id="Roo.data.Store-method-getAt" name=".getAt"></a>
964 <div class="fixedFont">
965 <span class="attributes"></span><b class="itemname">getAt</b>
967 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
973 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
982 <div class="short">Get the Record at the specified index.</div>
988 Get the Record at the specified index.
995 <dl class="detailList">
996 <dt class="heading">Parameters:</dt>
999 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1002 <dd>The index of the Record to find.</dd>
1010 <dl class="detailList">
1011 <dt class="heading">Returns:</dt>
1013 <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>
1027 <td class="msource">
1035 <tr class="method-row config-row-alt1 expandable notInherited">
1036 <td class="micon"><a class="exi" href="#expand"> </a></td>
1040 <a id="Roo.data.Store-method-getById" name=".getById"></a>
1041 <div class="fixedFont">
1042 <span class="attributes"></span><b class="itemname">getById</b>
1044 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1050 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
1059 <div class="short">Get the Record with the specified id.</div>
1065 Get the Record with the specified id.
1072 <dl class="detailList">
1073 <dt class="heading">Parameters:</dt>
1076 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1079 <dd>The id of the Record to find.</dd>
1087 <dl class="detailList">
1088 <dt class="heading">Returns:</dt>
1090 <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>
1104 <td class="msource">
1112 <tr class="method-row config-row-alt0 expandable notInherited">
1113 <td class="micon"><a class="exi" href="#expand"> </a></td>
1117 <a id="Roo.data.Store-method-getCount" name=".getCount"></a>
1118 <div class="fixedFont">
1119 <span class="attributes"></span><b class="itemname">getCount</b>
1128 <div class="short">Gets the number of cached records.</div>
1134 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>
1155 <td class="msource">
1163 <tr class="method-row config-row-alt1 expandable notInherited">
1164 <td class="micon"><a class="exi" href="#expand"> </a></td>
1168 <a id="Roo.data.Store-method-getModifiedRecords" name=".getModifiedRecords"></a>
1169 <div class="fixedFont">
1170 <span class="attributes"></span><b class="itemname">getModifiedRecords</b>
1178 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
1187 <div class="short">Gets all records modified since the last commit.</div>
1193 Gets all records modified since the last commit. Modified records are persisted across load operations<br/>(e.g., during paging).
1204 <dl class="detailList">
1205 <dt class="heading">Returns:</dt>
1207 <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>
1221 <td class="msource">
1229 <tr class="method-row config-row-alt0 expandable notInherited">
1230 <td class="micon"><a class="exi" href="#expand"> </a></td>
1234 <a id="Roo.data.Store-method-getRange" name=".getRange"></a>
1235 <div class="fixedFont">
1236 <span class="attributes"></span><b class="itemname">getRange</b>
1238 (<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>)
1244 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
1253 <div class="short">Returns a range of Records between specified indices.</div>
1259 Returns a range of Records between specified indices.
1266 <dl class="detailList">
1267 <dt class="heading">Parameters:</dt>
1270 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startIndex</b>
1273 <dd>(optional) The starting index (defaults to 0)</dd>
1276 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endIndex</b>
1279 <dd>(optional) The ending index (defaults to the last Record in the Store)</dd>
1287 <dl class="detailList">
1288 <dt class="heading">Returns:</dt>
1290 <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>
1304 <td class="msource">
1312 <tr class="method-row config-row-alt1 expandable notInherited">
1313 <td class="micon"><a class="exi" href="#expand"> </a></td>
1317 <a id="Roo.data.Store-method-getSortState" name=".getSortState"></a>
1318 <div class="fixedFont">
1319 <span class="attributes"></span><b class="itemname">getSortState</b>
1328 <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>
1334 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>
1355 <td class="msource">
1363 <tr class="method-row config-row-alt0 expandable notInherited">
1364 <td class="micon"><a class="exi" href="#expand"> </a></td>
1368 <a id="Roo.data.Store-method-getTotalCount" name=".getTotalCount"></a>
1369 <div class="fixedFont">
1370 <span class="attributes"></span><b class="itemname">getTotalCount</b>
1379 <div class="short">Gets the total number of records in the dataset as returned by the server.</div>
1385 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>
1406 <td class="msource">
1414 <tr class="method-row config-row-alt1 expandable notInherited">
1415 <td class="micon"><a class="exi" href="#expand"> </a></td>
1419 <a id="Roo.data.Store-method-indexOf" name=".indexOf"></a>
1420 <div class="fixedFont">
1421 <span class="attributes"></span><b class="itemname">indexOf</b>
1423 (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>)
1429 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1438 <div class="short">Get the index within the cache of the passed Record.</div>
1444 Get the index within the cache of the passed Record.
1451 <dl class="detailList">
1452 <dt class="heading">Parameters:</dt>
1455 <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>
1458 <dd>The Roo.data.Record object to to find.</dd>
1466 <dl class="detailList">
1467 <dt class="heading">Returns:</dt>
1469 <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>
1483 <td class="msource">
1491 <tr class="method-row config-row-alt0 expandable notInherited">
1492 <td class="micon"><a class="exi" href="#expand"> </a></td>
1496 <a id="Roo.data.Store-method-indexOfId" name=".indexOfId"></a>
1497 <div class="fixedFont">
1498 <span class="attributes"></span><b class="itemname">indexOfId</b>
1500 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1506 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1515 <div class="short">Get the index within the cache of the Record with the passed id.</div>
1521 Get the index within the cache of the Record with the passed id.
1528 <dl class="detailList">
1529 <dt class="heading">Parameters:</dt>
1532 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1535 <dd>The id of the Record to find.</dd>
1543 <dl class="detailList">
1544 <dt class="heading">Returns:</dt>
1546 <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>
1560 <td class="msource">
1568 <tr class="method-row config-row-alt1 expandable notInherited">
1569 <td class="micon"><a class="exi" href="#expand"> </a></td>
1573 <a id="Roo.data.Store-method-insert" name=".insert"></a>
1574 <div class="fixedFont">
1575 <span class="attributes"></span><b class="itemname">insert</b>
1577 (<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>)
1584 <div class="short">Inserts Records to the Store at the given index and fires the add event.</div>
1590 Inserts Records to the Store at the given index and fires the add event.
1597 <dl class="detailList">
1598 <dt class="heading">Parameters:</dt>
1601 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1604 <dd>The start index at which to insert the passed Records.</dd>
1607 <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>
1610 <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
1628 <td class="msource">
1636 <tr class="method-row config-row-alt0 expandable notInherited">
1637 <td class="micon"><a class="exi" href="#expand"> </a></td>
1641 <a id="Roo.data.Store-method-load" name=".load"></a>
1642 <div class="fixedFont">
1643 <span class="attributes"></span><b class="itemname">load</b>
1645 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1652 <div class="short">Loads the Record cache from the configured Proxy using the configured Reader.</div>
1658 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>
1665 <dl class="detailList">
1666 <dt class="heading">Parameters:</dt>
1669 <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>
1672 <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>
1690 <td class="msource">
1698 <tr class="method-row config-row-alt1 expandable notInherited">
1699 <td class="micon"><a class="exi" href="#expand"> </a></td>
1703 <a id="Roo.data.Store-method-loadData" name=".loadData"></a>
1704 <div class="fixedFont">
1705 <span class="attributes"></span><b class="itemname">loadData</b>
1707 (<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>)
1714 <div class="short">Loads data from a passed data block.</div>
1720 Loads data from a passed data block. A Reader which understands the format of the data<br/>must have been configured in the constructor.
1727 <dl class="detailList">
1728 <dt class="heading">Parameters:</dt>
1731 <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>
1734 <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>
1737 <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>
1740 <dd>(Optional) True to append the new Records rather than replace the existing cache.</dd>
1758 <td class="msource">
1766 <tr class="method-row config-row-alt0 expandable notInherited">
1767 <td class="micon"><a class="exi" href="#expand"> </a></td>
1771 <a id="Roo.data.Store-method-query" name=".query"></a>
1772 <div class="fixedFont">
1773 <span class="attributes"></span><b class="itemname">query</b>
1775 (<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>)
1790 <div class="short">Query the records by a specified property.</div>
1796 Query the records by a specified property.
1803 <dl class="detailList">
1804 <dt class="heading">Parameters:</dt>
1807 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>field</b>
1810 <dd>A field on your records</dd>
1813 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
1816 <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
1819 <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>
1822 <dd>True to match any part not just the beginning</dd>
1830 <dl class="detailList">
1831 <dt class="heading">Returns:</dt>
1833 <dd><span class="fixedFont">MixedCollection</span> Returns an Roo.util.MixedCollection of the matched records</dd>
1847 <td class="msource">
1855 <tr class="method-row config-row-alt1 expandable notInherited">
1856 <td class="micon"><a class="exi" href="#expand"> </a></td>
1860 <a id="Roo.data.Store-method-queryBy" name=".queryBy"></a>
1861 <div class="fixedFont">
1862 <span class="attributes"></span><b class="itemname">queryBy</b>
1864 (<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>)
1879 <div class="short">Query by a function.</div>
1885 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.
1892 <dl class="detailList">
1893 <dt class="heading">Parameters:</dt>
1896 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1899 <dd>The function to be called, it will receive 2 args (record, id)</dd>
1902 <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>
1905 <dd>(optional) The scope of the function (defaults to this)</dd>
1913 <dl class="detailList">
1914 <dt class="heading">Returns:</dt>
1916 <dd><span class="fixedFont">MixedCollection</span> Returns an Roo.util.MixedCollection of the matched records</dd>
1930 <td class="msource">
1938 <tr class="method-row config-row-alt0 expandable notInherited">
1939 <td class="micon"><a class="exi" href="#expand"> </a></td>
1943 <a id="Roo.data.Store-method-rejectChanges" name=".rejectChanges"></a>
1944 <div class="fixedFont">
1945 <span class="attributes"></span><b class="itemname">rejectChanges</b>
1954 <div class="short">Cancel outstanding changes on all changed records.</div>
1960 Cancel outstanding changes on all changed records.
1981 <td class="msource">
1989 <tr class="method-row config-row-alt1 expandable notInherited">
1990 <td class="micon"><a class="exi" href="#expand"> </a></td>
1994 <a id="Roo.data.Store-method-reload" name=".reload"></a>
1995 <div class="fixedFont">
1996 <span class="attributes"></span><b class="itemname">reload</b>
1998 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2005 <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>
2011 Reloads the Record cache from the configured Proxy using the configured Reader and<br/>the options from the last load operation performed.
2018 <dl class="detailList">
2019 <dt class="heading">Parameters:</dt>
2022 <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>
2025 <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>
2043 <td class="msource">
2051 <tr class="method-row config-row-alt0 expandable notInherited">
2052 <td class="micon"><a class="exi" href="#expand"> </a></td>
2056 <a id="Roo.data.Store-method-remove" name=".remove"></a>
2057 <div class="fixedFont">
2058 <span class="attributes"></span><b class="itemname">remove</b>
2060 (Ext.data.Record <B><i>record</i></B>)
2067 <div class="short">Remove a Record from the Store and fires the remove event.</div>
2073 Remove a Record from the Store and fires the remove event.
2080 <dl class="detailList">
2081 <dt class="heading">Parameters:</dt>
2084 <span class="fixedFont">Ext.data.Record</span> <b>record</b>
2087 <dd>The Roo.data.Record object to remove from the cache.</dd>
2105 <td class="msource">
2113 <tr class="method-row config-row-alt1 expandable notInherited">
2114 <td class="micon"><a class="exi" href="#expand"> </a></td>
2118 <a id="Roo.data.Store-method-removeAll" name=".removeAll"></a>
2119 <div class="fixedFont">
2120 <span class="attributes"></span><b class="itemname">removeAll</b>
2129 <div class="short">Remove all Records from the Store and fires the clear event.</div>
2135 Remove all Records from the Store and fires the clear event.
2156 <td class="msource">
2164 <tr class="method-row config-row-alt0 expandable notInherited">
2165 <td class="micon"><a class="exi" href="#expand"> </a></td>
2169 <a id="Roo.data.Store-method-setDefaultSort" name=".setDefaultSort"></a>
2170 <div class="fixedFont">
2171 <span class="attributes"></span><b class="itemname">setDefaultSort</b>
2173 (<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>)
2180 <div class="short">Sets the default sort column and order to be used by the next load operation.</div>
2186 Sets the default sort column and order to be used by the next load operation.
2193 <dl class="detailList">
2194 <dt class="heading">Parameters:</dt>
2197 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>fieldName</b>
2200 <dd>The name of the field to sort by.</dd>
2203 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dir</b>
2206 <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
2224 <td class="msource">
2232 <tr class="method-row config-row-alt1 expandable notInherited">
2233 <td class="micon"><a class="exi" href="#expand"> </a></td>
2237 <a id="Roo.data.Store-method-sort" name=".sort"></a>
2238 <div class="fixedFont">
2239 <span class="attributes"></span><b class="itemname">sort</b>
2241 (<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>)
2248 <div class="short">Sort the Records.</div>
2254 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.
2261 <dl class="detailList">
2262 <dt class="heading">Parameters:</dt>
2265 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>fieldName</b>
2268 <dd>The name of the field to sort by.</dd>
2271 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dir</b>
2274 <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
2292 <td class="msource">
2300 <tr class="method-row config-row-alt0 expandable notInherited">
2301 <td class="micon"><a class="exi" href="#expand"> </a></td>
2305 <a id="Roo.data.Store-method-sum" name=".sum"></a>
2306 <div class="fixedFont">
2307 <span class="attributes"></span><b class="itemname">sum</b>
2309 (<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>)
2315 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
2324 <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div>
2330 Sums the value of <i>property</i> for each record between start and end and returns the result.
2337 <dl class="detailList">
2338 <dt class="heading">Parameters:</dt>
2341 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>property</b>
2344 <dd>A field on your records</dd>
2347 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>start</b>
2350 <dd>The record index to start at (defaults to 0)</dd>
2353 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>end</b>
2356 <dd>The last record index to include (defaults to length - 1)</dd>
2364 <dl class="detailList">
2365 <dt class="heading">Returns:</dt>
2367 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The sum</dd>
2381 <td class="msource">
2392 <!-- ============================== events summary / details ======================== -->
2395 <a id="Roo.data.Store-events"></a>
2404 <table cellspacing="0" class="member-table">
2405 <caption>Events</caption>
2408 <th class="sig-header" colspan="2">Event</th>
2409 <th class="msource-header">Defined By</th>
2418 <tr class="method-row expandable config-row-alt0 notInherited">
2419 <td class="micon"><a class="exi" href="#expand"> </a></td>
2422 <a id="Roo.data.Store-event-*add"></a>
2424 <div class="fixedFont">
2425 <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>)
2431 <div class="short">Fires when Records have been added to the Store
2437 Fires when Records have been added to the Store
2443 <dl class="detailList">
2444 <dt class="heading">Parameters:</dt>
2447 <span class="fixedFont">Store</span> <b>this</b>
2453 <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>
2456 <dd>The array of Records added</dd>
2459 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2462 <dd>The index at which the record(s) were added</dd>
2480 <td class="msource">
2485 <tr class="method-row expandable config-row-alt1 notInherited">
2486 <td class="micon"><a class="exi" href="#expand"> </a></td>
2489 <a id="Roo.data.Store-event-*beforeload"></a>
2491 <div class="fixedFont">
2492 <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>)
2498 <div class="short">Fires before a request is made for a new data object.
2504 Fires before a request is made for a new data object. If the beforeload handler returns false<br/>the load action will be canceled.
2510 <dl class="detailList">
2511 <dt class="heading">Parameters:</dt>
2514 <span class="fixedFont">Store</span> <b>this</b>
2520 <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>
2523 <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
2541 <td class="msource">
2546 <tr class="method-row expandable config-row-alt0 notInherited">
2547 <td class="micon"><a class="exi" href="#expand"> </a></td>
2550 <a id="Roo.data.Store-event-*clear"></a>
2552 <div class="fixedFont">
2553 <b class="itemname">clear</b> (Store <B><i>this</i></B>)
2559 <div class="short">Fires when the data cache has been cleared.
2565 Fires when the data cache has been cleared.
2571 <dl class="detailList">
2572 <dt class="heading">Parameters:</dt>
2575 <span class="fixedFont">Store</span> <b>this</b>
2596 <td class="msource">
2601 <tr class="method-row expandable config-row-alt1 notInherited">
2602 <td class="micon"><a class="exi" href="#expand"> </a></td>
2605 <a id="Roo.data.Store-event-*datachanged"></a>
2607 <div class="fixedFont">
2608 <b class="itemname">datachanged</b> (Store <B><i>this</i></B>)
2614 <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.
2620 Fires when the data cache has changed, and a widget which is using this Store<br/>as a Record cache should refresh its view.
2626 <dl class="detailList">
2627 <dt class="heading">Parameters:</dt>
2630 <span class="fixedFont">Store</span> <b>this</b>
2651 <td class="msource">
2656 <tr class="method-row expandable config-row-alt0 notInherited">
2657 <td class="micon"><a class="exi" href="#expand"> </a></td>
2660 <a id="Roo.data.Store-event-*load"></a>
2662 <div class="fixedFont">
2663 <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>)
2669 <div class="short">Fires after a new set of Records has been loaded.
2675 Fires after a new set of Records has been loaded.
2681 <dl class="detailList">
2682 <dt class="heading">Parameters:</dt>
2685 <span class="fixedFont">Store</span> <b>this</b>
2691 <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>
2694 <dd>The Records that were loaded</dd>
2697 <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>
2700 <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
2718 <td class="msource">
2723 <tr class="method-row expandable config-row-alt1 notInherited">
2724 <td class="micon"><a class="exi" href="#expand"> </a></td>
2727 <a id="Roo.data.Store-event-*loadexception"></a>
2729 <div class="fixedFont">
2730 <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>)
2736 <div class="short">Fires if an exception occurs in the Proxy during loading.
2742 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
2748 <dl class="detailList">
2749 <dt class="heading">Parameters:</dt>
2752 <span class="fixedFont">Proxy</span> <b></b>
2758 <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>
2761 <dd>from JsonData.reader() - success, totalRecords, records</dd>
2764 <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>
2770 <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>
2773 <dd>from your request (normally this contains the Exception)</dd>
2791 <td class="msource">
2796 <tr class="method-row expandable config-row-alt0 notInherited">
2797 <td class="micon"><a class="exi" href="#expand"> </a></td>
2800 <a id="Roo.data.Store-event-*metachange"></a>
2802 <div class="fixedFont">
2803 <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>)
2809 <div class="short">Fires when this store's reader provides new metadata (fields).
2815 Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.
2821 <dl class="detailList">
2822 <dt class="heading">Parameters:</dt>
2825 <span class="fixedFont">Store</span> <b>this</b>
2831 <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>
2834 <dd>The JSON metadata</dd>
2852 <td class="msource">
2857 <tr class="method-row expandable config-row-alt1 notInherited">
2858 <td class="micon"><a class="exi" href="#expand"> </a></td>
2861 <a id="Roo.data.Store-event-*remove"></a>
2863 <div class="fixedFont">
2864 <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>)
2870 <div class="short">Fires when a Record has been removed from the Store
2876 Fires when a Record has been removed from the Store
2882 <dl class="detailList">
2883 <dt class="heading">Parameters:</dt>
2886 <span class="fixedFont">Store</span> <b>this</b>
2892 <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>
2895 <dd>The Record that was removed</dd>
2898 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2901 <dd>The index at which the record was removed</dd>
2919 <td class="msource">
2924 <tr class="method-row expandable config-row-alt0 notInherited">
2925 <td class="micon"><a class="exi" href="#expand"> </a></td>
2928 <a id="Roo.data.Store-event-*update"></a>
2930 <div class="fixedFont">
2931 <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>)
2937 <div class="short">Fires when a Record has been updated
2943 Fires when a Record has been updated
2949 <dl class="detailList">
2950 <dt class="heading">Parameters:</dt>
2953 <span class="fixedFont">Store</span> <b>this</b>
2959 <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>
2962 <dd>The Record that was updated</dd>
2965 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>operation</b>
2968 <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>
2986 <td class="msource">
2998 <!-- ============================== footer ================================= -->
2999 <div class="fineprint" style="clear:both">
3001 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 19:32:50 GMT+0800 (HKT)
3003 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob