Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / src / direct / Provider.js
index 342e993..453595a 100644 (file)
 /*!
 /*!
- * Ext JS Library 3.0.0
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
  */
  */
-/**\r
- * @class Ext.direct.Provider\r
- * @extends Ext.util.Observable\r
- * <p>Ext.direct.Provider is an abstract class meant to be extended.</p>\r
- * \r
- * <p>For example ExtJs implements the following subclasses:</p>\r
- * <pre><code>\r
-Provider\r
-|\r
-+---{@link Ext.direct.JsonProvider JsonProvider} \r
-    |\r
-    +---{@link Ext.direct.PollingProvider PollingProvider}   \r
-    |\r
-    +---{@link Ext.direct.RemotingProvider RemotingProvider}   \r
- * </code></pre>\r
- * @abstract\r
- */\r
-Ext.direct.Provider = Ext.extend(Ext.util.Observable, {    \r
-    /**\r
-     * @cfg {String} id\r
-     * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}).\r
-     * You should assign an id if you need to be able to access the provider later and you do\r
-     * not have an object reference available, for example:\r
-     * <pre><code>\r
-Ext.Direct.addProvider(\r
-    {\r
-        type: 'polling',\r
-        url:  'php/poll.php',\r
-        id:   'poll-provider'\r
-    }\r
-);\r
-     \r
-var p = {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#getProvider getProvider}('poll-provider');\r
-p.disconnect();\r
-     * </code></pre>\r
-     */\r
-        \r
-    /**\r
-     * @cfg {Number} priority\r
-     * Priority of the request. Lower is higher priority, <tt>0</tt> means "duplex" (always on).\r
-     * All Providers default to <tt>1</tt> except for PollingProvider which defaults to <tt>3</tt>.\r
-     */    \r
-    priority: 1,\r
-\r
-    /**\r
-     * @cfg {String} type\r
-     * <b>Required</b>, <tt>undefined</tt> by default.  The <tt>type</tt> of provider specified\r
-     * to {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#addProvider addProvider} to create a\r
-     * new Provider. Acceptable values by default are:<div class="mdetail-params"><ul>\r
-     * <li><b><tt>polling</tt></b> : {@link Ext.direct.PollingProvider PollingProvider}</li>\r
-     * <li><b><tt>remoting</tt></b> : {@link Ext.direct.RemotingProvider RemotingProvider}</li>\r
-     * </ul></div>\r
-     */    \r
\r
-    // private\r
-    constructor : function(config){\r
-        Ext.apply(this, config);\r
-        this.addEvents(\r
-            /**\r
-             * @event connect\r
-             * Fires when the Provider connects to the server-side\r
-             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.\r
-             */            \r
-            'connect',\r
-            /**\r
-             * @event disconnect\r
-             * Fires when the Provider disconnects from the server-side\r
-             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.\r
-             */            \r
-            'disconnect',\r
-            /**\r
-             * @event data\r
-             * Fires when the Provider receives data from the server-side\r
-             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.\r
-             * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.\r
-             */            \r
-            'data',\r
-            /**\r
-             * @event exception\r
-             * Fires when the Provider receives an exception from the server-side\r
-             */                        \r
-            'exception'\r
-        );\r
-        Ext.direct.Provider.superclass.constructor.call(this, config);\r
-    },\r
-\r
-    /**\r
-     * Returns whether or not the server-side is currently connected.\r
-     * Abstract method for subclasses to implement.\r
-     */\r
-    isConnected: function(){\r
-        return false;\r
-    },\r
-\r
-    /**\r
-     * Abstract methods for subclasses to implement.\r
-     */\r
-    connect: Ext.emptyFn,\r
-    \r
-    /**\r
-     * Abstract methods for subclasses to implement.\r
-     */\r
-    disconnect: Ext.emptyFn\r
-});\r
+/**
+ * @class Ext.direct.Provider
+ * @extends Ext.util.Observable
+ * <p>Ext.direct.Provider is an abstract class meant to be extended.</p>
+ * 
+ * <p>For example ExtJs implements the following subclasses:</p>
+ * <pre><code>
+Provider
+|
++---{@link Ext.direct.JsonProvider JsonProvider} 
+    |
+    +---{@link Ext.direct.PollingProvider PollingProvider}   
+    |
+    +---{@link Ext.direct.RemotingProvider RemotingProvider}   
+ * </code></pre>
+ * @abstract
+ */
+Ext.direct.Provider = Ext.extend(Ext.util.Observable, {    
+    /**
+     * @cfg {String} id
+     * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}).
+     * You should assign an id if you need to be able to access the provider later and you do
+     * not have an object reference available, for example:
+     * <pre><code>
+Ext.Direct.addProvider(
+    {
+        type: 'polling',
+        url:  'php/poll.php',
+        id:   'poll-provider'
+    }
+);
+     
+var p = {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#getProvider getProvider}('poll-provider');
+p.disconnect();
+     * </code></pre>
+     */
+        
+    /**
+     * @cfg {Number} priority
+     * Priority of the request. Lower is higher priority, <tt>0</tt> means "duplex" (always on).
+     * All Providers default to <tt>1</tt> except for PollingProvider which defaults to <tt>3</tt>.
+     */    
+    priority: 1,
+
+    /**
+     * @cfg {String} type
+     * <b>Required</b>, <tt>undefined</tt> by default.  The <tt>type</tt> of provider specified
+     * to {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#addProvider addProvider} to create a
+     * new Provider. Acceptable values by default are:<div class="mdetail-params"><ul>
+     * <li><b><tt>polling</tt></b> : {@link Ext.direct.PollingProvider PollingProvider}</li>
+     * <li><b><tt>remoting</tt></b> : {@link Ext.direct.RemotingProvider RemotingProvider}</li>
+     * </ul></div>
+     */    
+    // private
+    constructor : function(config){
+        Ext.apply(this, config);
+        this.addEvents(
+            /**
+             * @event connect
+             * Fires when the Provider connects to the server-side
+             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
+             */            
+            'connect',
+            /**
+             * @event disconnect
+             * Fires when the Provider disconnects from the server-side
+             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
+             */            
+            'disconnect',
+            /**
+             * @event data
+             * Fires when the Provider receives data from the server-side
+             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
+             * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
+             */            
+            'data',
+            /**
+             * @event exception
+             * Fires when the Provider receives an exception from the server-side
+             */                        
+            'exception'
+        );
+        Ext.direct.Provider.superclass.constructor.call(this, config);
+    },
+
+    /**
+     * Returns whether or not the server-side is currently connected.
+     * Abstract method for subclasses to implement.
+     */
+    isConnected: function(){
+        return false;
+    },
+
+    /**
+     * Abstract methods for subclasses to implement.
+     */
+    connect: Ext.emptyFn,
+    
+    /**
+     * Abstract methods for subclasses to implement.
+     */
+    disconnect: Ext.emptyFn
+});