Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / ResultSet.html
index e857e64..a9cde79 100644 (file)
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><span id='Ext-data-ResultSet'>/**
 </span> * @author Ed Spencer
- * @class Ext.data.ResultSet
- * @extends Object
- * 
- * &lt;p&gt;Simple wrapper class that represents a set of records returned by a Proxy.&lt;/p&gt;
+ *
+ * Simple wrapper class that represents a set of records returned by a Proxy.
  */
 Ext.define('Ext.data.ResultSet', {
 <span id='Ext-data-ResultSet-cfg-loaded'>    /**
 </span>     * @cfg {Boolean} loaded
      * True if the records have already been loaded. This is only meaningful when dealing with
-     * SQL-backed proxies
+     * SQL-backed proxies.
      */
     loaded: true,
-    
+
 <span id='Ext-data-ResultSet-cfg-count'>    /**
 </span>     * @cfg {Number} count
-     * The number of records in this ResultSet. Note that total may differ from this number
+     * The number of records in this ResultSet. Note that total may differ from this number.
      */
     count: 0,
-    
+
 <span id='Ext-data-ResultSet-cfg-total'>    /**
 </span>     * @cfg {Number} total
      * The total number of records reported by the data source. This ResultSet may form a subset of
-     * those records (see count)
+     * those records (see {@link #count}).
      */
     total: 0,
-    
+
 <span id='Ext-data-ResultSet-cfg-success'>    /**
 </span>     * @cfg {Boolean} success
-     * True if the ResultSet loaded successfully, false if any errors were encountered
+     * True if the ResultSet loaded successfully, false if any errors were encountered.
      */
     success: false,
-    
+
 <span id='Ext-data-ResultSet-cfg-records'>    /**
-</span>     * @cfg {Array} records The array of record instances. Required
+</span>     * @cfg {Ext.data.Model[]} records (required)
+     * The array of record instances.
      */
 
 <span id='Ext-data-ResultSet-method-constructor'>    /**
 </span>     * Creates the resultSet
-     * @param {Object} config (optional) Config object.
+     * @param {Object} [config] Config object.
      */
     constructor: function(config) {
         Ext.apply(this, config);
-        
+
 <span id='Ext-data-ResultSet-property-totalRecords'>        /**
-</span>         * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.total - use that instead
-         * @property totalRecords
-         * @type Mixed
+</span>         * @property {Number} totalRecords
+         * Copy of this.total.
+         * @deprecated Will be removed in Ext JS 5.0. Use {@link #total} instead.
          */
         this.totalRecords = this.total;
-        
+
         if (config.count === undefined) {
             this.count = this.records.length;
         }