Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.data.ResultSet.js
1 Ext.data.JsonP.Ext_data_ResultSet({
2   "tagname": "class",
3   "name": "Ext.data.ResultSet",
4   "doc": "<p>Simple wrapper class that represents a set of records returned by a Proxy.</p>\n\n",
5   "extends": "Object",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": "Ed Spencer",
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "count",
21       "member": "Ext.data.ResultSet",
22       "type": "Number",
23       "doc": "<p>The number of records in this ResultSet. Note that total may differ from this number</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
26       "linenr": 19,
27       "html_filename": "ResultSet.html",
28       "href": "ResultSet.html#Ext-data-ResultSet-cfg-count"
29     },
30     {
31       "tagname": "cfg",
32       "name": "loaded",
33       "member": "Ext.data.ResultSet",
34       "type": "Boolean",
35       "doc": "<p>True if the records have already been loaded. This is only meaningful when dealing with\nSQL-backed proxies</p>\n",
36       "private": false,
37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
38       "linenr": 12,
39       "html_filename": "ResultSet.html",
40       "href": "ResultSet.html#Ext-data-ResultSet-cfg-loaded"
41     },
42     {
43       "tagname": "cfg",
44       "name": "records",
45       "member": "Ext.data.ResultSet",
46       "type": "Array",
47       "doc": "<p>The array of record instances. Required</p>\n",
48       "private": false,
49       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
50       "linenr": 38,
51       "html_filename": "ResultSet.html",
52       "href": "ResultSet.html#Ext-data-ResultSet-cfg-records"
53     },
54     {
55       "tagname": "cfg",
56       "name": "success",
57       "member": "Ext.data.ResultSet",
58       "type": "Boolean",
59       "doc": "<p>True if the ResultSet loaded successfully, false if any errors were encountered</p>\n",
60       "private": false,
61       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
62       "linenr": 32,
63       "html_filename": "ResultSet.html",
64       "href": "ResultSet.html#Ext-data-ResultSet-cfg-success"
65     },
66     {
67       "tagname": "cfg",
68       "name": "total",
69       "member": "Ext.data.ResultSet",
70       "type": "Number",
71       "doc": "<p>The total number of records reported by the data source. This ResultSet may form a subset of\nthose records (see count)</p>\n",
72       "private": false,
73       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
74       "linenr": 25,
75       "html_filename": "ResultSet.html",
76       "href": "ResultSet.html#Ext-data-ResultSet-cfg-total"
77     }
78   ],
79   "method": [
80     {
81       "tagname": "method",
82       "name": "ResultSet",
83       "member": "Ext.data.ResultSet",
84       "doc": "<p>Creates the new ResultSet</p>\n",
85       "params": [
86
87       ],
88       "return": {
89         "type": "void",
90         "doc": "\n"
91       },
92       "private": false,
93       "static": false,
94       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
95       "linenr": 1,
96       "html_filename": "ResultSet.html",
97       "href": "ResultSet.html#Ext-data-ResultSet-method-constructor",
98       "shortDoc": "<p>Creates the new ResultSet</p>\n"
99     }
100   ],
101   "property": [
102     {
103       "tagname": "property",
104       "name": "totalRecords",
105       "member": "Ext.data.ResultSet",
106       "type": "Mixed",
107       "doc": "<p>DEPRECATED - will be removed in <a href=\"#/api/Ext\" rel=\"Ext\" class=\"docClass\">Ext</a> JS 5.0. This is just a copy of this.total - use that instead</p>\n",
108       "private": false,
109       "static": false,
110       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
111       "linenr": 45,
112       "html_filename": "ResultSet.html",
113       "href": "ResultSet.html#Ext-data-ResultSet-property-totalRecords"
114     }
115   ],
116   "event": [
117
118   ],
119   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/ResultSet.js",
120   "linenr": 1,
121   "html_filename": "ResultSet.html",
122   "href": "ResultSet.html#Ext-data-ResultSet",
123   "cssVar": [
124
125   ],
126   "cssMixin": [
127
128   ],
129   "component": false,
130   "superclasses": [
131
132   ],
133   "subclasses": [
134
135   ],
136   "mixedInto": [
137
138   ],
139   "allMixins": [
140
141   ]
142 });