X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..HEAD:/docs/source/ResultSet.html diff --git a/docs/source/ResultSet.html b/docs/source/ResultSet.html index 9d202172..a9cde799 100644 --- a/docs/source/ResultSet.html +++ b/docs/source/ResultSet.html @@ -1,56 +1,75 @@ -Sencha Documentation Project
/**
- * @author Ed Spencer
- * @class Ext.data.ResultSet
- * @extends Object
- * 
- * <p>Simple wrapper class that represents a set of records returned by a Proxy.</p>
- * 
- * @constructor
- * Creates the new ResultSet
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
+ * @author Ed Spencer
+ *
+ * Simple wrapper class that represents a set of records returned by a Proxy.
  */
 Ext.define('Ext.data.ResultSet', {
-    /**
+    /**
      * @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,
-    
-    /**
+
+    /**
      * @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,
-    
-    /**
+
+    /**
      * @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,
-    
-    /**
+
+    /**
      * @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,
-    
-    /**
-     * @cfg {Array} records The array of record instances. Required
+
+    /**
+     * @cfg {Ext.data.Model[]} records (required)
+     * The array of record instances.
      */
 
+    /**
+     * Creates the resultSet
+     * @param {Object} [config] Config object.
+     */
     constructor: function(config) {
         Ext.apply(this, config);
-        
-        /**
-         * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.total - use that instead
-         * @property totalRecords
-         * @type Mixed
+
+        /**
+         * @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;
         }
     }
-});
\ No newline at end of file +});
+ +