Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / Provider.html
index 21a4384..c5f758f 100644 (file)
@@ -1,24 +1,9 @@
-<html>
-<head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
-  <title>The source code</title>
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
-</head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
-<div id="cls-Ext.direct.Provider"></div>/**
- * @class Ext.direct.Provider
- * @extends Ext.util.Observable
- * <p>Ext.direct.Provider is an abstract class meant to be extended.</p>
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-direct.Provider'>/**
+</span> * @class Ext.direct.Provider
+ * &lt;p&gt;Ext.direct.Provider is an abstract class meant to be extended.&lt;/p&gt;
  * 
- * <p>For example ExtJs implements the following subclasses:</p>
- * <pre><code>
+ * &lt;p&gt;For example ExtJs implements the following subclasses:&lt;/p&gt;
+ * &lt;pre&gt;&lt;code&gt;
 Provider
 |
 +---{@link Ext.direct.JsonProvider JsonProvider} 
@@ -26,96 +11,86 @@ Provider
     +---{@link Ext.direct.PollingProvider PollingProvider}   
     |
     +---{@link Ext.direct.RemotingProvider RemotingProvider}   
- * </code></pre>
+ * &lt;/code&gt;&lt;/pre&gt;
  * @abstract
  */
-Ext.direct.Provider = Ext.extend(Ext.util.Observable, {    
-    <div id="cfg-Ext.direct.Provider-id"></div>/**
-     * @cfg {String} id
+Ext.define('Ext.direct.Provider', {
+    
+    /* Begin Definitions */
+   
+   alias: 'direct.provider',
+   
+    mixins: {
+        observable: 'Ext.util.Observable'   
+    },
+   
+    /* End Definitions */
+   
+<span id='Ext-direct.Provider-cfg-id'>   /**
+</span>     * @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');
+     * &lt;pre&gt;&lt;code&gt;
+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>
+     * &lt;/code&gt;&lt;/pre&gt;
      */
-        
-    <div id="cfg-Ext.direct.Provider-priority"></div>/**
-     * @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,
-
-    <div id="cfg-Ext.direct.Provider-type"></div>/**
-     * @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(
-            <div id="event-Ext.direct.Provider-connect"></div>/**
-             * @event connect
+        var me = this;
+        
+        Ext.apply(me, config);
+        me.addEvents(
+<span id='Ext-direct.Provider-event-connect'>            /**
+</span>             * @event connect
              * Fires when the Provider connects to the server-side
              * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
              */            
             'connect',
-            <div id="event-Ext.direct.Provider-disconnect"></div>/**
-             * @event disconnect
+<span id='Ext-direct.Provider-event-disconnect'>            /**
+</span>             * @event disconnect
              * Fires when the Provider disconnects from the server-side
              * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
              */            
             'disconnect',
-            <div id="event-Ext.direct.Provider-data"></div>/**
-             * @event data
+<span id='Ext-direct.Provider-event-data'>            /**
+</span>             * @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 {event} e The Ext.Direct.Event type that occurred.
              */            
             'data',
-            <div id="event-Ext.direct.Provider-exception"></div>/**
-             * @event exception
+<span id='Ext-direct.Provider-event-exception'>            /**
+</span>             * @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);
     },
-
-    <div id="method-Ext.direct.Provider-isConnected"></div>/**
-     * Returns whether or not the server-side is currently connected.
+    
+<span id='Ext-direct.Provider-method-isConnected'>    /**
+</span>     * Returns whether or not the server-side is currently connected.
      * Abstract method for subclasses to implement.
      */
     isConnected: function(){
         return false;
     },
 
-    <div id="prop-Ext.direct.Provider-connect"></div>/**
-     * Abstract methods for subclasses to implement.
+<span id='Ext-direct.Provider-property-connect'>    /**
+</span>     * Abstract methods for subclasses to implement.
      */
     connect: Ext.emptyFn,
     
-    <div id="prop-Ext.direct.Provider-disconnect"></div>/**
-     * Abstract methods for subclasses to implement.
+<span id='Ext-direct.Provider-property-disconnect'>    /**
+</span>     * Abstract methods for subclasses to implement.
      */
     disconnect: Ext.emptyFn
 });
-</pre>    
-</body>
-</html>
\ No newline at end of file
+</pre></pre></body></html>
\ No newline at end of file