X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/b37ceabb82336ee82757cd32efe353cfab8ec267..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/Provider.html diff --git a/docs/source/Provider.html b/docs/source/Provider.html index c5a0e836..26973749 100644 --- a/docs/source/Provider.html +++ b/docs/source/Provider.html @@ -1,121 +1,117 @@ + - + The source code - - + + + + - -
/*!
- * Ext JS Library 3.2.2
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-
/** - * @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:

- *

+
+  
/**
+ * @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.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, { -
/** - * @cfg {String} id +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: - *

-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');
+     * <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> */ - -
/** - * @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:
    - *
  • polling : {@link Ext.direct.PollingProvider PollingProvider}
  • - *
  • remoting : {@link Ext.direct.RemotingProvider RemotingProvider}
  • - *
- */ - - // private constructor : function(config){ - Ext.apply(this, config); - this.addEvents( -
/** - * @event connect + 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 + /** + * @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 + /** + * @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 + /** + * @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); }, -
/** - * Returns whether or not the server-side is currently connected. + /** + * 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. + /** + * Abstract methods for subclasses to implement. + * @method */ connect: Ext.emptyFn, - -
/** - * Abstract methods for subclasses to implement. + + /** + * Abstract methods for subclasses to implement. + * @method */ disconnect: Ext.emptyFn }); -
+
- \ No newline at end of file +