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