Upgrade to ExtJS 4.0.7 - Released 10/19/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="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../resources/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'>/**
19 </span> * @class Ext.data.JsonPStore
20  * @extends Ext.data.Store
21  * @private
22  * &lt;p&gt;Small helper class to make creating {@link Ext.data.Store}s from different domain JSON data easier.
23  * A JsonPStore will be automatically configured with a {@link Ext.data.reader.Json} and a {@link Ext.data.proxy.JsonP JsonPProxy}.&lt;/p&gt;
24  * &lt;p&gt;A store configuration would be something like:&lt;pre&gt;&lt;code&gt;
25 var store = new Ext.data.JsonPStore({
26     // store configs
27     autoDestroy: true,
28     storeId: 'myStore',
29
30     // proxy configs
31     url: 'get-images.php',
32
33     // reader configs
34     root: 'images',
35     idProperty: 'name',
36     fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}]
37 });
38  * &lt;/code&gt;&lt;/pre&gt;&lt;/p&gt;
39  * &lt;p&gt;This store is configured to consume a returned object of the form:&lt;pre&gt;&lt;code&gt;
40 stcCallback({
41     images: [
42         {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)},
43         {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)}
44     ]
45 })
46  * &lt;/code&gt;&lt;/pre&gt;
47  * &lt;p&gt;Where stcCallback is the callback name passed in the request to the remote domain. See {@link Ext.data.proxy.JsonP JsonPProxy}
48  * for details of how this works.&lt;/p&gt;
49  * An object literal of this form could also be used as the {@link #data} config option.&lt;/p&gt;
50  * &lt;p&gt;&lt;b&gt;*Note:&lt;/b&gt; Although not listed here, this class accepts all of the configuration options of
51  * &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;
52  * @xtype jsonpstore
53  */
54 Ext.define('Ext.data.JsonPStore', {
55     extend: 'Ext.data.Store',
56     alias : 'store.jsonp',
57
58 <span id='Ext-data-JsonPStore-cfg-reader'>    /**
59 </span>     * @cfg {Ext.data.DataReader} reader @hide
60      */
61     constructor: function(config) {
62         this.callParent(Ext.apply(config, {
63             reader: Ext.create('Ext.data.reader.Json', config),
64             proxy : Ext.create('Ext.data.proxy.JsonP', config)
65         }));
66     }
67 });
68 </pre>
69 </body>
70 </html>