Upgrade to ExtJS 4.0.0 - Released 04/26/2011

[extjs.git] / docs / source / ResultSet.html
diff --git a/docs/source/ResultSet.html b/docs/source/ResultSet.html

new file mode 100644 (file)

index 0000000..9d20217
--- /dev/null
+++ b/docs/source/ResultSet.html
@@ -0,0 +1,56 @@
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-data.ResultSet-method-constructor'><span id='Ext-data.ResultSet'>/**
+</span></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;
+ * 
+ * @constructor
+ * Creates the new ResultSet
+ */
+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
+     */
+    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
+     */
+    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)
+     */
+    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
+     */
+    success: false,
+    
+<span id='Ext-data.ResultSet-cfg-records'>    /**
+</span>     * @cfg {Array} records The array of record instances. Required
+     */
+
+    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
+         */
+        this.totalRecords = this.total;
+        
+        if (config.count === undefined) {
+            this.count = this.records.length;
+        }
+    }
+});</pre></pre></body></html>
+\ No newline at end of file