provide installation instructions
[extjs.git] / source / data / DataProxy.js
1 /*\r
2  * Ext JS Library 2.2.1\r
3  * Copyright(c) 2006-2009, Ext JS, LLC.\r
4  * licensing@extjs.com\r
5  * \r
6  * http://extjs.com/license\r
7  */\r
8 \r
9 /**\r
10  * @class Ext.data.DataProxy\r
11  * @extends Ext.util.Observable\r
12  * This class is an abstract base class for implementations which provide retrieval of\r
13  * unformatted data objects.<br>\r
14  * <p>\r
15  * DataProxy implementations are usually used in conjunction with an implementation of Ext.data.DataReader\r
16  * (of the appropriate type which knows how to parse the data object) to provide a block of\r
17  * {@link Ext.data.Records} to an {@link Ext.data.Store}.<br>\r
18  * <p>\r
19  * Custom implementations must implement the load method as described in\r
20  * {@link Ext.data.HttpProxy#load}.\r
21  */\r
22 Ext.data.DataProxy = function(){\r
23     this.addEvents(\r
24         /**\r
25          * @event beforeload\r
26          * Fires before a network request is made to retrieve a data object.\r
27          * @param {Object} this\r
28          * @param {Object} params The params object passed to the {@link #load} function\r
29          */\r
30         'beforeload',\r
31         /**\r
32          * @event load\r
33          * Fires before the load method's callback is called.\r
34          * @param {Object} this\r
35          * @param {Object} o The data object\r
36          * @param {Object} arg The callback's arg object passed to the {@link #load} function\r
37          */\r
38         'load'\r
39     );\r
40     Ext.data.DataProxy.superclass.constructor.call(this);\r
41 };\r
42 \r
43 Ext.extend(Ext.data.DataProxy, Ext.util.Observable);