Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / Provider.html
index c5bccb1..9309db5 100644 (file)
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \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.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>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-state-Provider'>/**
+</span> * @class Ext.state.Provider
+ * &lt;p&gt;Abstract base class for state provider implementations. The provider is responsible
+ * for setting values  and extracting values to/from the underlying storage source. The 
+ * storage source can vary and the details should be implemented in a subclass. For example
+ * a provider could use a server side database or the browser localstorage where supported.&lt;/p&gt;
+ *
+ * &lt;p&gt;This class provides methods for encoding and decoding &lt;b&gt;typed&lt;/b&gt; variables including 
+ * dates and defines the Provider interface. By default these methods put the value and the
+ * type information into a delimited string that can be stored. These should be overridden in 
+ * a subclass if you want to change the format of the encoded value and subsequent decoding.&lt;/p&gt;
+ */
+Ext.define('Ext.state.Provider', {
+    mixins: {
+        observable: 'Ext.util.Observable'
+    },
+    
+<span id='Ext-state-Provider-cfg-prefix'>    /**
+</span>     * @cfg {String} prefix A string to prefix to items stored in the underlying state store. 
+     * Defaults to &lt;tt&gt;'ext-'&lt;/tt&gt;
+     */
+    prefix: 'ext-',
+    
+    constructor : function(config){
+        config = config || {};
+        var me = this;
+        Ext.apply(me, config);
+<span id='Ext-state-Provider-event-statechange'>        /**
+</span>         * @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
+         */
+        me.addEvents(&quot;statechange&quot;);
+        me.state = {};
+        me.mixins.observable.constructor.call(me);
+    },
+    
+<span id='Ext-state-Provider-method-get'>    /**
+</span>     * 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] == &quot;undefined&quot; ?
+            defaultValue : this.state[name];
+    },
+
+<span id='Ext-state-Provider-method-clear'>    /**
+</span>     * Clears a value from the state
+     * @param {String} name The key name
+     */
+    clear : function(name){
+        var me = this;
+        delete me.state[name];
+        me.fireEvent(&quot;statechange&quot;, me, name, null);
+    },
+
+<span id='Ext-state-Provider-method-set'>    /**
+</span>     * Sets the value for a key
+     * @param {String} name The key name
+     * @param {Mixed} value The value to set
+     */
+    set : function(name, value){
+        var me = this;
+        me.state[name] = value;
+        me.fireEvent(&quot;statechange&quot;, me, name, value);
+    },
+
+<span id='Ext-state-Provider-method-decodeValue'>    /**
+</span>     * Decodes a string previously encoded with {@link #encodeValue}.
+     * @param {String} value The value to decode
+     * @return {Mixed} The decoded value
+     */
+    decodeValue : function(value){
+
+        // a -&gt; Array
+        // n -&gt; Number
+        // d -&gt; Date
+        // b -&gt; Boolean
+        // s -&gt; String
+        // o -&gt; Object
+        // -&gt; Empty (null)
+
+        var me = this,
+            re = /^(a|n|d|b|s|o|e)\:(.*)$/,
+            matches = re.exec(unescape(value)),
+            all,
+            type,
+            value,
+            keyValue;
+            
+        if(!matches || !matches[1]){
+            return; // non state
+        }
+        
+        type = matches[1];
+        value = matches[2];
+        switch (type) {
+            case 'e':
+                return null;
+            case 'n':
+                return parseFloat(value);
+            case 'd':
+                return new Date(Date.parse(value));
+            case 'b':
+                return (value == '1');
+            case 'a':
+                all = [];
+                if(value != ''){
+                    Ext.each(value.split('^'), function(val){
+                        all.push(me.decodeValue(val));
+                    }, me);
+                }
+                return all;
+           case 'o':
+                all = {};
+                if(value != ''){
+                    Ext.each(value.split('^'), function(val){
+                        keyValue = val.split('=');
+                        all[keyValue[0]] = me.decodeValue(keyValue[1]);
+                    }, me);
+                }
+                return all;
+           default:
+                return value;
+        }
+    },
+
+<span id='Ext-state-Provider-method-encodeValue'>    /**
+</span>     * Encodes a value including type information.  Decode with {@link #decodeValue}.
+     * @param {Mixed} value The value to encode
+     * @return {String} The encoded value
+     */
+    encodeValue : function(value){
+        var flat = '',
+            i = 0,
+            enc,
+            len,
+            key;
+            
+        if (value == null) {
+            return 'e:1';    
+        } else if(typeof value == 'number') {
+            enc = 'n:' + value;
+        } else if(typeof value == 'boolean') {
+            enc = 'b:' + (value ? '1' : '0');
+        } else if(Ext.isDate(value)) {
+            enc = 'd:' + value.toGMTString();
+        } else if(Ext.isArray(value)) {
+            for (len = value.length; i &lt; len; i++) {
+                flat += this.encodeValue(value[i]);
+                if (i != len - 1) {
+                    flat += '^';
+                }
+            }
+            enc = 'a:' + flat;
+        } else if (typeof value == 'object') {
+            for (key in value) {
+                if (typeof value[key] != 'function' &amp;&amp; value[key] !== undefined) {
+                    flat += key + '=' + this.encodeValue(value[key]) + '^';
+                }
+            }
+            enc = 'o:' + flat.substring(0, flat.length-1);
+        } else {
+            enc = 's:' + value;
+        }
+        return escape(enc);
+    }
+});</pre>
+</body>
+</html>