major doc changes
[roojs1] / docs / symbols / Roo.state.CookieProvider.json
index 4211c5b..5f52211 100644 (file)
@@ -3,10 +3,15 @@
   "augments" : [
     "Roo.state.Provider"
   ],
+  "childClasses" : {  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "desc" : "The default Provider implementation which saves state via cookies.\n<br />Usage:\n <pre><code>\n   var cp = new Roo.state.CookieProvider({\n       path: \"/cgi-bin/\",\n       expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days\n       domain: \"roojs.com\"\n   })\n   Roo.state.Manager.setProvider(cp);\n </code></pre>",
   "isSingleton" : false,
   "isStatic" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
   "memberOf" : "CookieProvider",
   "example" : "",
   "deprecated" : "",
     }
   ],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [
     {
       "name" : "path",
       "type" : "String",
       "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
-      "memberOf" : "Roo.state.CookieProvider",
-      "optvals" : []
+      "memberOf" : "Roo.state.CookieProvider"
     },
     {
       "name" : "secure",
       "type" : "Boolean",
       "desc" : "True if the site is using SSL (defaults to false)",
-      "memberOf" : "Roo.state.CookieProvider",
-      "optvals" : []
+      "memberOf" : "Roo.state.CookieProvider"
     },
     {
       "name" : "domain",
       "type" : "String",
       "desc" : "The domain to save the cookie for.  Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')",
-      "memberOf" : "Roo.state.CookieProvider",
-      "optvals" : []
+      "memberOf" : "Roo.state.CookieProvider"
     },
     {
       "name" : "expires",
       "type" : "Date",
       "desc" : "The cookie expiration date (defaults to 7 days from now)",
-      "memberOf" : "Roo.state.CookieProvider",
-      "optvals" : []
+      "memberOf" : "Roo.state.CookieProvider"
     }
   ],
   "methods" : [
     {
       "name" : "clear",
+      "type" : "function",
       "desc" : "Clears a value from the state",
+      "sig" : "(name)",
+      "static" : false,
+      "memberOf" : "Roo.state.Provider",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.state.Provider",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "name",
     },
     {
       "name" : "decodeValue",
+      "type" : "function",
       "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "Roo.state.Provider",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.state.Provider",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
     },
     {
       "name" : "get",
+      "type" : "function",
       "desc" : "Returns the current value for a key",
+      "sig" : "(name, defaultValue)",
+      "static" : false,
+      "memberOf" : "Roo.state.Provider",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.state.Provider",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "name",
     },
     {
       "name" : "set",
+      "type" : "function",
       "desc" : "Sets the value for a key",
+      "sig" : "(name, value)",
+      "static" : false,
+      "memberOf" : "Roo.state.Provider",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.state.Provider",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "name",
     },
     {
       "name" : "encodeValue",
+      "type" : "function",
       "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "Roo.state.Provider",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.state.Provider",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
   "events" : [
     {
       "name" : "statechange",
+      "type" : "function",
       "desc" : "Fires when a state change occurs.",
+      "sig" : "function (_self, key, value)\n{\n\n}",
       "memberOf" : "Roo.state.Provider",
       "example" : "",
       "deprecated" : "",