git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / CookieProvider.html
diff --git a/docs/source/CookieProvider.html b/docs/source/CookieProvider.html
index dc6bee1..4b16d24 100644 (file)
--- a/docs/source/CookieProvider.html
+++ b/docs/source/CookieProvider.html
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
 <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>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
@@ -15,41 +15,60 @@
   </script>
 </head>
 <body onload="prettyPrint(); highlight();">
   </script>
 </head>
 <body onload="prettyPrint(); highlight();">
-  <pre class="prettyprint lang-js"><span id='Ext-state-CookieProvider-method-constructor'><span id='Ext-state-CookieProvider-cfg-secure'><span id='Ext-state-CookieProvider-cfg-domain'><span id='Ext-state-CookieProvider-cfg-expires'><span id='Ext-state-CookieProvider-cfg-path'><span id='Ext-state-CookieProvider'>/**
-</span></span></span></span></span></span> * @class Ext.state.CookieProvider
- * @extends Ext.state.Provider
- * A Provider implementation which saves and retrieves state via cookies.
- * The CookieProvider supports the usual cookie options, such as:
- * &lt;ul&gt;
- * &lt;li&gt;{@link #path}&lt;/li&gt;
- * &lt;li&gt;{@link #expires}&lt;/li&gt;
- * &lt;li&gt;{@link #domain}&lt;/li&gt;
- * &lt;li&gt;{@link #secure}&lt;/li&gt;
- * &lt;/ul&gt;
- &lt;pre&gt;&lt;code&gt;
-   var cp = new Ext.state.CookieProvider({
-       path: &quot;/cgi-bin/&quot;,
-       expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
-       domain: &quot;sencha.com&quot;
-   });
-   Ext.state.Manager.setProvider(cp);
- &lt;/code&gt;&lt;/pre&gt;
- 
- 
- * @cfg {String} path The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)
- * @cfg {Date} expires The cookie expiration date (defaults to 7 days from now)
- * @cfg {String} domain The domain to save the cookie for.  Note that you cannot specify a different domain than
- * your page is on, but you can specify a sub-domain, or simply the domain itself like 'sencha.com' to include
- * all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same
- * domain the page is running on including the 'www' like 'www.sencha.com')
- * @cfg {Boolean} secure True if the site is using SSL (defaults to false)
+  <pre class="prettyprint lang-js"><span id='Ext-state-CookieProvider-method-constructor'><span id='Ext-state-CookieProvider'>/**
+</span></span> * A Provider implementation which saves and retrieves state via cookies. The CookieProvider supports the usual cookie
+ * options, such as:
+ *
+ * - {@link #path}
+ * - {@link #expires}
+ * - {@link #domain}
+ * - {@link #secure}
+ *
+ * Example:
+ *
+ *     Ext.create('Ext.state.CookieProvider', {
+ *         path: &quot;/cgi-bin/&quot;,
+ *         expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
+ *         domain: &quot;sencha.com&quot;
+ *     });
+ *
+ *     Ext.state.Manager.setProvider(cp);
+ *
  * @constructor
  * @constructor
- * Create a new CookieProvider
- * @param {Object} config The configuration object
+ * Creates a new CookieProvider.
+ * @param {Object} config (optional) Config object.
+ * @return {Object}
  */
 Ext.define('Ext.state.CookieProvider', {
     extend: 'Ext.state.Provider',
 
  */
 Ext.define('Ext.state.CookieProvider', {
     extend: 'Ext.state.Provider',
 
+<span id='Ext-state-CookieProvider-cfg-path'>    /**
+</span>     * @cfg {String} path
+     * The path for which the cookie is active. Defaults to root '/' which makes it active for all pages in the site.
+     */
+
+<span id='Ext-state-CookieProvider-cfg-expires'>    /**
+</span>     * @cfg {Date} expires
+     * The cookie expiration date. Defaults to 7 days from now.
+     */
+
+<span id='Ext-state-CookieProvider-cfg-domain'>    /**
+</span>     * @cfg {String} domain
+     * The domain to save the cookie for. Note that you cannot specify a different domain than your page is on, but you can
+     * specify a sub-domain, or simply the domain itself like 'sencha.com' to include all sub-domains if you need to access
+     * cookies across different sub-domains. Defaults to null which uses the same domain the page is running on including
+     * the 'www' like 'www.sencha.com'.
+     */
+
+<span id='Ext-state-CookieProvider-cfg-secure'>    /**
+</span>     * @cfg {Boolean} [secure=false]
+     * True if the site is using SSL
+     */
+
+<span id='Ext-state-CookieProvider-method-constructor'>    /**
+</span>     * Creates a new CookieProvider.
+     * @param {Object} [config] Config object.
+     */
     constructor : function(config){
         var me = this;
         me.path = &quot;/&quot;;
     constructor : function(config){
         var me = this;
         me.path = &quot;/&quot;;
@@ -59,11 +78,11 @@ Ext.define('Ext.state.CookieProvider', {
         me.callParent(arguments);
         me.state = me.readCookies();
     },
         me.callParent(arguments);
         me.state = me.readCookies();
     },
-    
+
     // private
     set : function(name, value){
         var me = this;
     // private
     set : function(name, value){
         var me = this;
-        
+
         if(typeof value == &quot;undefined&quot; || value === null){
             me.clear(name);
             return;
         if(typeof value == &quot;undefined&quot; || value === null){
             me.clear(name);
             return;
@@ -88,7 +107,7 @@ Ext.define('Ext.state.CookieProvider', {
             matches,
             name,
             value;
             matches,
             name,
             value;
-            
+
         while((matches = re.exec(c)) != null){
             name = matches[1];
             value = matches[2];
         while((matches = re.exec(c)) != null){
             name = matches[1];
             value = matches[2];
@@ -102,7 +121,7 @@ Ext.define('Ext.state.CookieProvider', {
     // private
     setCookie : function(name, value){
         var me = this;
     // private
     setCookie : function(name, value){
         var me = this;
-        
+
         document.cookie = me.prefix + name + &quot;=&quot; + me.encodeValue(value) +
            ((me.expires == null) ? &quot;&quot; : (&quot;; expires=&quot; + me.expires.toGMTString())) +
            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
         document.cookie = me.prefix + name + &quot;=&quot; + me.encodeValue(value) +
            ((me.expires == null) ? &quot;&quot; : (&quot;; expires=&quot; + me.expires.toGMTString())) +
            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
@@ -113,7 +132,7 @@ Ext.define('Ext.state.CookieProvider', {
     // private
     clearCookie : function(name){
         var me = this;
     // private
     clearCookie : function(name){
         var me = this;
-        
+
         document.cookie = me.prefix + name + &quot;=null; expires=Thu, 01-Jan-70 00:00:01 GMT&quot; +
            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
            ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
         document.cookie = me.prefix + name + &quot;=null; expires=Thu, 01-Jan-70 00:00:01 GMT&quot; +
            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
            ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.