X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6e39d509471fe9b4e2660e0d1631b350d0c66f40..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/Provider.html diff --git a/docs/source/Provider.html b/docs/source/Provider.html index c5bccb17..26973749 100644 --- a/docs/source/Provider.html +++ b/docs/source/Provider.html @@ -1,115 +1,117 @@ - - - - The source code - - - - - 
/**
- * @class Ext.direct.Provider
- * @extends Ext.util.Observable
- * 
Ext.direct.Provider is an abstract class meant to be extended.

- * 
- * 
For example ExtJs implements the following subclasses:

- * 

-Provider
-|
-+---{@link Ext.direct.JsonProvider JsonProvider} 
-    |
-    +---{@link Ext.direct.PollingProvider PollingProvider}   
-    |
-    +---{@link Ext.direct.RemotingProvider RemotingProvider}   
- * 

- * @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:
-     * 

-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();
-     * 

-     */
-        
-    
/**
-     * @cfg {Number} priority
-     * Priority of the request. Lower is higher priority, 0 means "duplex" (always on).
-     * All Providers default to 1 except for PollingProvider which defaults to 3.
-     */    
-    priority: 1,
-
-    
/**
-     * @cfg {String} type
-     * Required, undefined by default.  The type of provider specified
-     * to {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#addProvider addProvider} to create a
-     * new Provider. Acceptable values by default are:

-     */    
- 
-    // 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
-});
-
- - \ No newline at end of file + + + + + The source code + + + + + + + 
/**
+ * @class Ext.direct.Provider
+ * <p>Ext.direct.Provider is an abstract class meant to be extended.</p>
+ *
+ * <p>For example Ext JS 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.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.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>
+     */
+
+    constructor : function(config){
+        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 {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'
+        );
+        me.mixins.observable.constructor.call(me, 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.
+     * @method
+     */
+    connect: Ext.emptyFn,
+
+    /**
+     * Abstract methods for subclasses to implement.
+     * @method
+     */
+    disconnect: Ext.emptyFn
+});
+
+ +