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