--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.data.Store</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.data.Store-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.data.Store-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.data.Store-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.data.Store-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+ <div class="inheritance res-block">
+ <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.Store
+
+ </pre>
+ </div>
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.data.Store
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_data_Store.js.html">Roo/data/Store.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">Store</td></tr>
+
+
+ <tr><td class="label">Subclasses:</td><td class="hd-info">
+ <a href="./Roo.data.JsonStore.html#constructor" roo:cls="Roo.data.JsonStore.html#constructor">Roo.data.JsonStore</a>, <a href="./Roo.data.SimpleStore.html#constructor" roo:cls="Roo.data.SimpleStore.html#constructor">Roo.data.SimpleStore</a>
+
+
+
+ </td></tr>
+
+
+
+ <tr><td class="label">Extends:</td><td class="hd-info">
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td></tr>
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ 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.
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.Store';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.data.Store.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.data.Store-configs"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
+
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-baseParams" name=".baseParams"></a>
+ <div class="fixedFont">
+ <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">An object containing properties which are to be sent as parameters<br/>on any HTTP request</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ An object containing properties which are to be sent as parameters<br/>on any HTTP request
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-data" name=".data"></a>
+ <div class="fixedFont">
+ <b class="itemname">data</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">Inline data to be loaded when the store is initialized.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ Inline data to be loaded when the store is initialized.
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-isLocal" name=".isLocal"></a>
+ <div class="fixedFont">
+ <b class="itemname">isLocal</b> : boolean
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
+ <div class="fixedFont">
+ <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ 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>
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-multiSort" name=".multiSort"></a>
+ <div class="fixedFont">
+ <b class="itemname">multiSort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">enable multi column sorting (sort is based on the order of columns, remote only at present)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ enable multi column sorting (sort is based on the order of columns, remote only at present)
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-proxy" name=".proxy"></a>
+ <div class="fixedFont">
+ <b class="itemname">proxy</b> : <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The Proxy object which provides access to a data object.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ The Proxy object which provides access to a data object.
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-pruneModifiedRecords" name=".pruneModifiedRecords"></a>
+ <div class="fixedFont">
+ <b class="itemname">pruneModifiedRecords</b> : boolean
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to clear all modified record information each time the store is<br/>loaded or when a record is removed.</div>
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-reader" name=".reader"></a>
+ <div class="fixedFont">
+ <b class="itemname">reader</b> : Roo.data.Reader
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-remoteSort" name=".remoteSort"></a>
+ <div class="fixedFont">
+ <b class="itemname">remoteSort</b> : boolean
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.data.Store-cfg-sortInfo" name=".sortInfo"></a>
+ <div class="fixedFont">
+ <b class="itemname">sortInfo</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"}</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ A config object in the format: {field: "fieldName", direction: "ASC|DESC"}
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.data.Store-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.data.Store-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data-method-Store" name=".Store"></a>
+ <div class="fixedFont">
+ <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">Store</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+
+ <div class="short">Create a new Roo.data.Store</div>
+
+
+ <div class="long">
+
+
+
+ Create a new Roo.data.Store
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>A config object containing the objects needed for the Store to access data,<br/>and read the data into Records.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-add" name=".add"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">add</b>
+
+ (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Add Records to the Store and fires the add event.</div>
+
+
+
+ <div class="long">
+
+ Add Records to the Store and fires the add event.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">addEvents</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Used to define events on this Observable</div>
+
+
+
+ <div class="long">
+
+ Used to define events on this Observable
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The object with the events defined</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">addListener</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Appends an event handler to this component</div>
+
+
+
+ <div class="long">
+
+ Appends an event handler to this component
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The method the event invokes</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-clearFilter" name=".clearFilter"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">clearFilter</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Revert to a view of the Record cache with no filtering applied.</div>
+
+
+
+ <div class="long">
+
+ Revert to a view of the Record cache with no filtering applied.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>If true the filter is cleared silently without notifying listeners</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-collect" name=".collect"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">collect</b>
+
+ (<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>)
+
+
+ :
+
+
+ <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Collects unique values for a particular dataIndex from this store.</div>
+
+
+
+ <div class="long">
+
+ Collects unique values for a particular dataIndex from this store.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
+
+ </dt>
+ <dd>The property to collect</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) Pass true to allow null, undefined or empty string values</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) Pass true to collect from all records, even ones which are filtered</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of the unique values</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-commitChanges" name=".commitChanges"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">commitChanges</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Commit all Records with outstanding changes.</div>
+
+
+
+ <div class="long">
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-each" name=".each"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">each</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Calls the specified function for each of the Records in the cache.</div>
+
+
+
+ <div class="long">
+
+ Calls the specified function for each of the Records in the cache.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
+
+ </dt>
+ <dd>The function to call. The Record is passed as the first parameter.<br/>Returning <em>false</em> aborts and exits the iteration.</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope in which to call the function (defaults to the Record).</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-filter" name=".filter"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">filter</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Filter the records by a specified property.</div>
+
+
+
+ <div class="long">
+
+ Filter the records by a specified property.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>field</b>
+
+ </dt>
+ <dd>A field on your records</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
+
+ </dt>
+ <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>True to match any part not just the beginning</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-filterBy" name=".filterBy"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">filterBy</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Filter by a function.</div>
+
+
+
+ <div class="long">
+
+ 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.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
+
+ </dt>
+ <dd>The function to be called, it will receive 2 args (record, id)</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope of the function (defaults to this)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">fireEvent</b>
+
+ (<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>)
+
+
+ :
+
+
+ <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
+
+
+
+ <div class="long">
+
+ Fires the specified event with the passed parameters (minus the event name).
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>Variable number of parameters are passed to handlers</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getAt" name=".getAt"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getAt</b>
+
+ (<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>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the Record at the specified index.</div>
+
+
+
+ <div class="long">
+
+ Get the Record at the specified index.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
+
+ </dt>
+ <dd>The index of the Record to find.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getById" name=".getById"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getById</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the Record with the specified id.</div>
+
+
+
+ <div class="long">
+
+ Get the Record with the specified id.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
+
+ </dt>
+ <dd>The id of the Record to find.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getCount" name=".getCount"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getCount</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the number of cached records.</div>
+
+
+
+ <div class="long">
+
+ 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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getModifiedRecords" name=".getModifiedRecords"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getModifiedRecords</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets all records modified since the last commit.</div>
+
+
+
+ <div class="long">
+
+ Gets all records modified since the last commit. Modified records are persisted across load operations<br/>(e.g., during paging).
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getRange" name=".getRange"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getRange</b>
+
+ (<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>)
+
+
+ :
+
+
+ <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns a range of Records between specified indices.</div>
+
+
+
+ <div class="long">
+
+ Returns a range of Records between specified indices.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startIndex</b>
+
+ </dt>
+ <dd>(optional) The starting index (defaults to 0)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endIndex</b>
+
+ </dt>
+ <dd>(optional) The ending index (defaults to the last Record in the Store)</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getSortState" name=".getSortState"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getSortState</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <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>
+
+
+
+ <div class="long">
+
+ 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>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-getTotalCount" name=".getTotalCount"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getTotalCount</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the total number of records in the dataset as returned by the server.</div>
+
+
+
+ <div class="long">
+
+ 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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">hasListener</b>
+
+ (<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:Boolean">Boolean</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Checks to see if this object has any listeners for a specified event</div>
+
+
+
+ <div class="long">
+
+ Checks to see if this object has any listeners for a specified event
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The name of the event to check for</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-indexOf" name=".indexOf"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">indexOf</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>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the index within the cache of the passed Record.</div>
+
+
+
+ <div class="long">
+
+ Get the index within the cache of the passed Record.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The Roo.data.Record object to to find.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-indexOfId" name=".indexOfId"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">indexOfId</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the index within the cache of the Record with the passed id.</div>
+
+
+
+ <div class="long">
+
+ Get the index within the cache of the Record with the passed id.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
+
+ </dt>
+ <dd>The id of the Record to find.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-insert" name=".insert"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">insert</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Inserts Records to the Store at the given index and fires the add event.</div>
+
+
+
+ <div class="long">
+
+ Inserts Records to the Store at the given index and fires the add event.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
+
+ </dt>
+ <dd>The start index at which to insert the passed Records.</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-load" name=".load"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">load</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Loads the Record cache from the configured Proxy using the configured Reader.</div>
+
+
+
+ <div class="long">
+
+ 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>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-loadData" name=".loadData"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">loadData</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Loads data from a passed data block.</div>
+
+
+
+ <div class="long">
+
+ Loads data from a passed data block. A Reader which understands the format of the data<br/>must have been configured in the constructor.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <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>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(Optional) True to append the new Records rather than replace the existing cache.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-on" name=".on"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">on</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
+
+
+
+ <div class="long">
+
+ Appends an event handler to this element (shorthand for addListener)
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The method the event invokes</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">purgeListeners</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes all listeners for this object</div>
+
+
+
+ <div class="long">
+
+ Removes all listeners for this object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-query" name=".query"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">query</b>
+
+ (<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>)
+
+
+ :
+
+
+ MixedCollection
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Query the records by a specified property.</div>
+
+
+
+ <div class="long">
+
+ Query the records by a specified property.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>field</b>
+
+ </dt>
+ <dd>A field on your records</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
+
+ </dt>
+ <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>True to match any part not just the beginning</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">MixedCollection</span> Returns an Roo.util.MixedCollection of the matched records</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-queryBy" name=".queryBy"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">queryBy</b>
+
+ (<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>)
+
+
+ :
+
+
+ MixedCollection
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Query by a function.</div>
+
+
+
+ <div class="long">
+
+ 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.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
+
+ </dt>
+ <dd>The function to be called, it will receive 2 args (record, id)</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope of the function (defaults to this)</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">MixedCollection</span> Returns an Roo.util.MixedCollection of the matched records</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-rejectChanges" name=".rejectChanges"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">rejectChanges</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Cancel outstanding changes on all changed records.</div>
+
+
+
+ <div class="long">
+
+ Cancel outstanding changes on all changed records.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-reload" name=".reload"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">reload</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <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>
+
+
+
+ <div class="long">
+
+ Reloads the Record cache from the configured Proxy using the configured Reader and<br/>the options from the last load operation performed.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-remove" name=".remove"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">remove</b>
+
+ (Ext.data.Record <B><i>record</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Remove a Record from the Store and fires the remove event.</div>
+
+
+
+ <div class="long">
+
+ Remove a Record from the Store and fires the remove event.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Ext.data.Record</span> <b>record</b>
+
+ </dt>
+ <dd>The Roo.data.Record object to remove from the cache.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-removeAll" name=".removeAll"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">removeAll</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Remove all Records from the Store and fires the clear event.</div>
+
+
+
+ <div class="long">
+
+ Remove all Records from the Store and fires the clear event.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">removeListener</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes a listener</div>
+
+
+
+ <div class="long">
+
+ Removes a listener
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The handler to remove</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope (this object) for the handler</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-setDefaultSort" name=".setDefaultSort"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setDefaultSort</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sets the default sort column and order to be used by the next load operation.</div>
+
+
+
+ <div class="long">
+
+ Sets the default sort column and order to be used by the next load operation.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>fieldName</b>
+
+ </dt>
+ <dd>The name of the field to sort by.</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dir</b>
+
+ </dt>
+ <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-sort" name=".sort"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">sort</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sort the Records.</div>
+
+
+
+ <div class="long">
+
+ 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.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>fieldName</b>
+
+ </dt>
+ <dd>The name of the field to sort by.</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dir</b>
+
+ </dt>
+ <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Store-method-sum" name=".sum"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">sum</b>
+
+ (<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>)
+
+
+ :
+
+
+ <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div>
+
+
+
+ <div class="long">
+
+ Sums the value of <i>property</i> for each record between start and end and returns the result.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>property</b>
+
+ </dt>
+ <dd>A field on your records</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>start</b>
+
+ </dt>
+ <dd>The record index to start at (defaults to 0)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>end</b>
+
+ </dt>
+ <dd>The last record index to include (defaults to length - 1)</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The sum</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Store
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-un" name=".un"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">un</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes a listener (shorthand for removeListener)</div>
+
+
+
+ <div class="long">
+
+ Removes a listener (shorthand for removeListener)
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The handler to remove</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>(optional) The scope (this object) for the handler</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.data.Store-events"></a>
+
+
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Events</caption>
+ <thead>
+ <tr>
+ <th class="sig-header" colspan="2">Event</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+ </thead>
+
+
+
+
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*add"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when Records have been added to the Store
+
+ </div>
+
+ <div class="long">
+
+ Fires when Records have been added to the Store
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The array of Records added</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
+
+ </dt>
+ <dd>The index at which the record(s) were added</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*beforeload"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires before a request is made for a new data object.
+
+ </div>
+
+ <div class="long">
+
+ Fires before a request is made for a new data object. If the beforeload handler returns false<br/>the load action will be canceled.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*beforeloadadd"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires after a new set of Records has been loaded.
+
+ </div>
+
+ <div class="long">
+
+ Fires after a new set of Records has been loaded.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The Records that were loaded</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*clear"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">clear</b> (Store <B><i>this</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when the data cache has been cleared.
+
+ </div>
+
+ <div class="long">
+
+ Fires when the data cache has been cleared.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*datachanged"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">datachanged</b> (Store <B><i>this</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <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.
+
+ </div>
+
+ <div class="long">
+
+ Fires when the data cache has changed, and a widget which is using this Store<br/>as a Record cache should refresh its view.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*load"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires after a new set of Records has been loaded, before they are added to the store.
+
+ </div>
+
+ <div class="long">
+
+ Fires after a new set of Records has been loaded, before they are added to the store.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The Records that were loaded</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*loadexception"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires if an exception occurs in the Proxy during loading.
+
+ </div>
+
+ <div class="long">
+
+ 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
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Proxy</span> <b></b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>from JsonData.reader() - success, totalRecords, records</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>options</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>from your request (normally this contains the Exception)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*metachange"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when this store's reader provides new metadata (fields).
+
+ </div>
+
+ <div class="long">
+
+ Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The JSON metadata</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*remove"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when a Record has been removed from the Store
+
+ </div>
+
+ <div class="long">
+
+ Fires when a Record has been removed from the Store
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The Record that was removed</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
+
+ </dt>
+ <dd>The index at which the record was removed</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.data.Store-event-*update"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when a Record has been updated
+
+ </div>
+
+ <div class="long">
+
+ Fires when a Record has been updated
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Store</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The Record that was updated</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>operation</b>
+
+ </dt>
+ <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>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.data.Store
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>
projects / roojs1 / blobdiff