docs/source/ResultSet.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-data-ResultSet-method-constructor'><span id='Ext-data-ResultSet'>/**
  19 </span></span> * @author Ed Spencer
  20  * @class Ext.data.ResultSet
  21  * @extends Object
  22  *
  23  * &lt;p&gt;Simple wrapper class that represents a set of records returned by a Proxy.&lt;/p&gt;
  24  *
  25  * @constructor
  26  * Creates the new ResultSet
  27  */
  28 Ext.define('Ext.data.ResultSet', {
  29 <span id='Ext-data-ResultSet-cfg-loaded'>    /**
  30 </span>     * @cfg {Boolean} loaded
  31      * True if the records have already been loaded. This is only meaningful when dealing with
  32      * SQL-backed proxies
  33      */
  34     loaded: true,
  35
  36 <span id='Ext-data-ResultSet-cfg-count'>    /**
  37 </span>     * @cfg {Number} count
  38      * The number of records in this ResultSet. Note that total may differ from this number
  39      */
  40     count: 0,
  41
  42 <span id='Ext-data-ResultSet-cfg-total'>    /**
  43 </span>     * @cfg {Number} total
  44      * The total number of records reported by the data source. This ResultSet may form a subset of
  45      * those records (see count)
  46      */
  47     total: 0,
  48
  49 <span id='Ext-data-ResultSet-cfg-success'>    /**
  50 </span>     * @cfg {Boolean} success
  51      * True if the ResultSet loaded successfully, false if any errors were encountered
  52      */
  53     success: false,
  54
  55 <span id='Ext-data-ResultSet-cfg-records'>    /**
  56 </span>     * @cfg {Array} records The array of record instances. Required
  57      */
  58
  59     constructor: function(config) {
  60         Ext.apply(this, config);
  61
  62 <span id='Ext-data-ResultSet-property-totalRecords'>        /**
  63 </span>         * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.total - use that instead
  64          * @property totalRecords
  65          * @type Mixed
  66          */
  67         this.totalRecords = this.total;
  68
  69         if (config.count === undefined) {
  70             this.count = this.records.length;
  71         }
  72     }
  73 });</pre>
  74 </body>
  75 </html>