Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / DirectStore.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-DirectStore'>/**
19 </span> * Small helper class to create an {@link Ext.data.Store} configured with an {@link Ext.data.proxy.Direct}
20  * and {@link Ext.data.reader.Json} to make interacting with an {@link Ext.direct.Manager} server-side
21  * {@link Ext.direct.Provider Provider} easier. To create a different proxy/reader combination create a basic
22  * {@link Ext.data.Store} configured as needed.
23  *
24  * **Note:** Although they are not listed, this class inherits all of the config options of:
25  *
26  * - **{@link Ext.data.Store Store}**
27  *
28  * - **{@link Ext.data.reader.Json JsonReader}**
29  *
30  *   - **{@link Ext.data.reader.Json#root root}**
31  *   - **{@link Ext.data.reader.Json#idProperty idProperty}**
32  *   - **{@link Ext.data.reader.Json#totalProperty totalProperty}**
33  *
34  * - **{@link Ext.data.proxy.Direct DirectProxy}**
35  *
36  *   - **{@link Ext.data.proxy.Direct#directFn directFn}**
37  *   - **{@link Ext.data.proxy.Direct#paramOrder paramOrder}**
38  *   - **{@link Ext.data.proxy.Direct#paramsAsHash paramsAsHash}**
39  *
40  */
41 Ext.define('Ext.data.DirectStore', {
42     /* Begin Definitions */
43     
44     extend: 'Ext.data.Store',
45     
46     alias: 'store.direct',
47     
48     requires: ['Ext.data.proxy.Direct'],
49    
50     /* End Definitions */
51
52     constructor : function(config){
53         config = Ext.apply({}, config);
54         if (!config.proxy) {
55             var proxy = {
56                 type: 'direct',
57                 reader: {
58                     type: 'json'
59                 }
60             };
61             Ext.copyTo(proxy, config, 'paramOrder,paramsAsHash,directFn,api,simpleSortMode');
62             Ext.copyTo(proxy.reader, config, 'totalProperty,root,idProperty');
63             config.proxy = proxy;
64         }
65         this.callParent([config]);
66     }    
67 });
68 </pre>
69 </body>
70 </html>