Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / Provider.html
index d420c80..b7e7780 100644 (file)
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.state.Provider"></div>/**
- * @class Ext.state.Provider
- * Abstract base class for state provider implementations. This class provides methods
- * for encoding and decoding <b>typed</b> variables including dates and defines the
- * Provider interface.
+<html>
+<head>
+  <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.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
  */
-Ext.state.Provider = function(){
-    <div id="event-Ext.state.Provider-statechange"></div>/**
-     * @event statechange
-     * Fires when a state change occurs.
-     * @param {Provider} this This state provider
-     * @param {String} key The state key which was changed
-     * @param {String} value The encoded value for the state
-     */
-    this.addEvents("statechange");
-    this.state = {};
-    Ext.state.Provider.superclass.constructor.call(this);
-};
-Ext.extend(Ext.state.Provider, Ext.util.Observable, {
-    <div id="method-Ext.state.Provider-get"></div>/**
-     * Returns the current value for a key
-     * @param {String} name The key name
-     * @param {Mixed} defaultValue A default value to return if the key's value is not found
-     * @return {Mixed} The state data
-     */
-    get : function(name, defaultValue){
-        return typeof this.state[name] == "undefined" ?
-            defaultValue : this.state[name];
-    },
-
-    <div id="method-Ext.state.Provider-clear"></div>/**
-     * Clears a value from the state
-     * @param {String} name The key name
-     */
-    clear : function(name){
-        delete this.state[name];
-        this.fireEvent("statechange", this, name, null);
-    },
-
-    <div id="method-Ext.state.Provider-set"></div>/**
-     * Sets the value for a key
-     * @param {String} name The key name
-     * @param {Mixed} value The value to set
-     */
-    set : function(name, value){
-        this.state[name] = value;
-        this.fireEvent("statechange", this, name, value);
-    },
-
-    <div id="method-Ext.state.Provider-decodeValue"></div>/**
-     * Decodes a string previously encoded with {@link #encodeValue}.
-     * @param {String} value The value to decode
-     * @return {Mixed} The decoded value
-     */
-    decodeValue : function(cookie){
-        var re = /^(a|n|d|b|s|o)\:(.*)$/;
-        var matches = re.exec(unescape(cookie));
-        if(!matches || !matches[1]) return; // non state cookie
-        var type = matches[1];
-        var v = matches[2];
-        switch(type){
-            case "n":
-                return parseFloat(v);
-            case "d":
-                return new Date(Date.parse(v));
-            case "b":
-                return (v == "1");
-            case "a":
-                var all = [];
-                var values = v.split("^");
-                for(var i = 0, len = values.length; i < len; i++){
-                    all.push(this.decodeValue(values[i]));
-                }
-                return all;
-           case "o":
-                var all = {};
-                var values = v.split("^");
-                for(var i = 0, len = values.length; i < len; i++){
-                    var kv = values[i].split("=");
-                    all[kv[0]] = this.decodeValue(kv[1]);
-                }
-                return all;
-           default:
-                return v;
-        }
-    },
-
-    <div id="method-Ext.state.Provider-encodeValue"></div>/**
-     * Encodes a value including type information.  Decode with {@link #decodeValue}.
-     * @param {Mixed} value The value to encode
-     * @return {String} The encoded value
-     */
-    encodeValue : function(v){
-        var enc;
-        if(typeof v == "number"){
-            enc = "n:" + v;
-        }else if(typeof v == "boolean"){
-            enc = "b:" + (v ? "1" : "0");
-        }else if(Ext.isDate(v)){
-            enc = "d:" + v.toGMTString();
-        }else if(Ext.isArray(v)){
-            var flat = "";
-            for(var i = 0, len = v.length; i < len; i++){
-                flat += this.encodeValue(v[i]);
-                if(i != len-1) flat += "^";
-            }
-            enc = "a:" + flat;
-        }else if(typeof v == "object"){
-            var flat = "";
-            for(var key in v){
-                if(typeof v[key] != "function" && v[key] !== undefined){
-                    flat += key + "=" + this.encodeValue(v[key]) + "^";
-                }
-            }
-            enc = "o:" + flat.substring(0, flat.length-1);
-        }else{
-            enc = "s:" + v;
-        }
-        return escape(enc);
-    }
-});
-</pre>    \r
-</body>\r
+<div id="cls-Ext.direct.Provider"></div>/**\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
+    <div id="cfg-Ext.direct.Provider-id"></div>/**\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
+    <div id="cfg-Ext.direct.Provider-priority"></div>/**\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
+    <div id="cfg-Ext.direct.Provider-type"></div>/**\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
+            <div id="event-Ext.direct.Provider-connect"></div>/**\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
+            <div id="event-Ext.direct.Provider-disconnect"></div>/**\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
+            <div id="event-Ext.direct.Provider-data"></div>/**\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
+            <div id="event-Ext.direct.Provider-exception"></div>/**\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
+    <div id="method-Ext.direct.Provider-isConnected"></div>/**\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
+    <div id="prop-Ext.direct.Provider-connect"></div>/**\r
+     * Abstract methods for subclasses to implement.\r
+     */\r
+    connect: Ext.emptyFn,\r
+    \r
+    <div id="prop-Ext.direct.Provider-disconnect"></div>/**\r
+     * Abstract methods for subclasses to implement.\r
+     */\r
+    disconnect: Ext.emptyFn\r
+});\r
+</pre>
+</body>
 </html>
\ No newline at end of file