Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / Provider.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.direct.Provider"></div>/**\r
15  * @class Ext.direct.Provider\r
16  * @extends Ext.util.Observable\r
17  * <p>Ext.direct.Provider is an abstract class meant to be extended.</p>\r
18  * \r
19  * <p>For example ExtJs implements the following subclasses:</p>\r
20  * <pre><code>\r
21 Provider\r
22 |\r
23 +---{@link Ext.direct.JsonProvider JsonProvider} \r
24     |\r
25     +---{@link Ext.direct.PollingProvider PollingProvider}   \r
26     |\r
27     +---{@link Ext.direct.RemotingProvider RemotingProvider}   \r
28  * </code></pre>\r
29  * @abstract\r
30  */\r
31 Ext.direct.Provider = Ext.extend(Ext.util.Observable, {    \r
32     <div id="cfg-Ext.direct.Provider-id"></div>/**\r
33      * @cfg {String} id\r
34      * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}).\r
35      * You should assign an id if you need to be able to access the provider later and you do\r
36      * not have an object reference available, for example:\r
37      * <pre><code>\r
38 Ext.Direct.addProvider(\r
39     {\r
40         type: 'polling',\r
41         url:  'php/poll.php',\r
42         id:   'poll-provider'\r
43     }\r
44 );\r
45      \r
46 var p = {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#getProvider getProvider}('poll-provider');\r
47 p.disconnect();\r
48      * </code></pre>\r
49      */\r
50         \r
51     <div id="cfg-Ext.direct.Provider-priority"></div>/**\r
52      * @cfg {Number} priority\r
53      * Priority of the request. Lower is higher priority, <tt>0</tt> means "duplex" (always on).\r
54      * All Providers default to <tt>1</tt> except for PollingProvider which defaults to <tt>3</tt>.\r
55      */    \r
56     priority: 1,\r
57 \r
58     <div id="cfg-Ext.direct.Provider-type"></div>/**\r
59      * @cfg {String} type\r
60      * <b>Required</b>, <tt>undefined</tt> by default.  The <tt>type</tt> of provider specified\r
61      * to {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#addProvider addProvider} to create a\r
62      * new Provider. Acceptable values by default are:<div class="mdetail-params"><ul>\r
63      * <li><b><tt>polling</tt></b> : {@link Ext.direct.PollingProvider PollingProvider}</li>\r
64      * <li><b><tt>remoting</tt></b> : {@link Ext.direct.RemotingProvider RemotingProvider}</li>\r
65      * </ul></div>\r
66      */    \r
67  \r
68     // private\r
69     constructor : function(config){\r
70         Ext.apply(this, config);\r
71         this.addEvents(\r
72             <div id="event-Ext.direct.Provider-connect"></div>/**\r
73              * @event connect\r
74              * Fires when the Provider connects to the server-side\r
75              * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.\r
76              */            \r
77             'connect',\r
78             <div id="event-Ext.direct.Provider-disconnect"></div>/**\r
79              * @event disconnect\r
80              * Fires when the Provider disconnects from the server-side\r
81              * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.\r
82              */            \r
83             'disconnect',\r
84             <div id="event-Ext.direct.Provider-data"></div>/**\r
85              * @event data\r
86              * Fires when the Provider receives data from the server-side\r
87              * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.\r
88              * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.\r
89              */            \r
90             'data',\r
91             <div id="event-Ext.direct.Provider-exception"></div>/**\r
92              * @event exception\r
93              * Fires when the Provider receives an exception from the server-side\r
94              */                        \r
95             'exception'\r
96         );\r
97         Ext.direct.Provider.superclass.constructor.call(this, config);\r
98     },\r
99 \r
100     <div id="method-Ext.direct.Provider-isConnected"></div>/**\r
101      * Returns whether or not the server-side is currently connected.\r
102      * Abstract method for subclasses to implement.\r
103      */\r
104     isConnected: function(){\r
105         return false;\r
106     },\r
107 \r
108     <div id="prop-Ext.direct.Provider-connect"></div>/**\r
109      * Abstract methods for subclasses to implement.\r
110      */\r
111     connect: Ext.emptyFn,\r
112     \r
113     <div id="prop-Ext.direct.Provider-disconnect"></div>/**\r
114      * Abstract methods for subclasses to implement.\r
115      */\r
116     disconnect: Ext.emptyFn\r
117 });\r
118 </pre>
119 </body>
120 </html>