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