Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / JsonStore.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js"><div id="cls-Ext.data.JsonStore"></div>/**
10  * @class Ext.data.JsonStore
11  * @extends Ext.data.Store
12  * <p>Small helper class to make creating {@link Ext.data.Store}s from JSON data easier.
13  * A JsonStore will be automatically configured with a {@link Ext.data.JsonReader}.</p>
14  * <p>A store configuration would be something like:<pre><code>
15 var store = new Ext.data.JsonStore({
16     // store configs
17     autoDestroy: true,
18     url: 'get-images.php',
19     storeId: 'myStore',
20     // reader configs
21     root: 'images',
22     idProperty: 'name',
23     fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}]
24 });
25  * </code></pre></p>
26  * <p>This store is configured to consume a returned object of the form:<pre><code>
27 {
28     images: [
29         {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)},
30         {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)}
31     ]
32 }
33  * </code></pre>
34  * An object literal of this form could also be used as the {@link #data} config option.</p>
35  * <p><b>*Note:</b> Although not listed here, this class accepts all of the configuration options of
36  * <b>{@link Ext.data.JsonReader JsonReader}</b>.</p>
37  * @constructor
38  * @param {Object} config
39  * @xtype jsonstore
40  */
41 Ext.data.JsonStore = Ext.extend(Ext.data.Store, {
42     <div id="cfg-Ext.data.JsonStore-reader"></div>/**
43      * @cfg {Ext.data.DataReader} reader @hide
44      */
45     constructor: function(config){
46         Ext.data.JsonStore.superclass.constructor.call(this, Ext.apply(config, {
47             reader: new Ext.data.JsonReader(config)
48         }));
49     }
50 });
51 Ext.reg('jsonstore', Ext.data.JsonStore);</pre>    \r
52 </body>\r
53 </html>