Upgrade to ExtJS 4.0.7 - Released 10/19/2011

[extjs.git] / src / direct / Provider.js

diff --git a/src/direct/Provider.js b/src/direct/Provider.js
index 9d8a181..c3f078d 100644 (file)
--- a/src/direct/Provider.js
+++ b/src/direct/Provider.js
@@ -1,93 +1,92 @@
-/*!
- * Ext JS Library 3.2.0
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 Sencha Inc
+
+Contact:  http://www.sencha.com/contact
+
+GNU General Public License Usage
+This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.  Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
 /**
  * @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>
+ *
+ * <p>For example Ext JS implements the following subclasses:</p>
  * <pre><code>
 Provider
 |
-+---{@link Ext.direct.JsonProvider JsonProvider} 
++---{@link Ext.direct.JsonProvider JsonProvider}
     |
-    +---{@link Ext.direct.PollingProvider PollingProvider}   
+    +---{@link Ext.direct.PollingProvider PollingProvider}
     |
-    +---{@link Ext.direct.RemotingProvider RemotingProvider}   
+    +---{@link Ext.direct.RemotingProvider RemotingProvider}
  * </code></pre>
  * @abstract
  */
-Ext.direct.Provider = Ext.extend(Ext.util.Observable, {    
-    /**
+Ext.define('Ext.direct.Provider', {
+
+    /* Begin Definitions */
+
+   alias: 'direct.provider',
+
+    mixins: {
+        observable: 'Ext.util.Observable'
+    },
+
+    /* End Definitions */
+
+   /**
      * @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');
+Ext.direct.Manager.addProvider({
+    type: 'polling',
+    url:  'php/poll.php',
+    id:   'poll-provider'
+});
+var p = {@link Ext.direct.Manager}.{@link Ext.direct.Manager#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(
+        var me = this;
+
+        Ext.apply(me, config);
+        me.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.
-             */            
+             * @param {Ext.direct.Event} e The 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);
+        me.mixins.observable.constructor.call(me, config);
     },
 
     /**
@@ -100,11 +99,14 @@ p.disconnect();
 
     /**
      * Abstract methods for subclasses to implement.
+     * @method
      */
     connect: Ext.emptyFn,
-    
+
     /**
      * Abstract methods for subclasses to implement.
+     * @method
      */
     disconnect: Ext.emptyFn
 });
+