Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / JsonPStore.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><span id='Ext-data-JsonPStore-method-constructor'><span id='Ext-data-JsonPStore'>/**
19 </span></span> * @class Ext.data.JsonPStore
20  * @extends Ext.data.Store
21  * @ignore
22  * @private
23  * &lt;p&gt;&lt;b&gt;NOTE:&lt;/b&gt; This class is in need of migration to the new API.&lt;/p&gt;
24  * &lt;p&gt;Small helper class to make creating {@link Ext.data.Store}s from different domain JSON data easier.
25  * A JsonPStore will be automatically configured with a {@link Ext.data.reader.Json} and a {@link Ext.data.proxy.JsonP JsonPProxy}.&lt;/p&gt;
26  * &lt;p&gt;A store configuration would be something like:&lt;pre&gt;&lt;code&gt;
27 var store = new Ext.data.JsonPStore({
28     // store configs
29     autoDestroy: true,
30     storeId: 'myStore',
31
32     // proxy configs
33     url: 'get-images.php',
34
35     // reader configs
36     root: 'images',
37     idProperty: 'name',
38     fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}]
39 });
40  * &lt;/code&gt;&lt;/pre&gt;&lt;/p&gt;
41  * &lt;p&gt;This store is configured to consume a returned object of the form:&lt;pre&gt;&lt;code&gt;
42 stcCallback({
43     images: [
44         {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)},
45         {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)}
46     ]
47 })
48  * &lt;/code&gt;&lt;/pre&gt;
49  * &lt;p&gt;Where stcCallback is the callback name passed in the request to the remote domain. See {@link Ext.data.proxy.JsonP JsonPProxy}
50  * for details of how this works.&lt;/p&gt;
51  * An object literal of this form could also be used as the {@link #data} config option.&lt;/p&gt;
52  * &lt;p&gt;&lt;b&gt;*Note:&lt;/b&gt; Although not listed here, this class accepts all of the configuration options of
53  * &lt;b&gt;{@link Ext.data.reader.Json JsonReader}&lt;/b&gt; and &lt;b&gt;{@link Ext.data.proxy.JsonP JsonPProxy}&lt;/b&gt;.&lt;/p&gt;
54  * @constructor
55  * @param {Object} config
56  * @xtype jsonpstore
57  */
58 Ext.define('Ext.data.JsonPStore', {
59     extend: 'Ext.data.Store',
60     alias : 'store.jsonp',
61
62 <span id='Ext-data-JsonPStore-cfg-reader'>    /**
63 </span>     * @cfg {Ext.data.DataReader} reader @hide
64      */
65     constructor: function(config) {
66         this.callParent(Ext.apply(config, {
67             reader: Ext.create('Ext.data.reader.Json', config),
68             proxy : Ext.create('Ext.data.proxy.JsonP', config)
69         }));
70     }
71 });
72 </pre>
73 </body>
74 </html>