Fix #5654 - roojspacker - get it working as a doc tool...

[roojs1] / docs / symbols / Roo.state.CookieProvider.json

diff --git a/docs/symbols/Roo.state.CookieProvider.json b/docs/symbols/Roo.state.CookieProvider.json
new file mode 100644 (file)
index 0000000..98cd15b
--- /dev/null
+++ b/docs/symbols/Roo.state.CookieProvider.json
@@ -0,0 +1,231 @@
+{
+  "name" : "Roo.state.CookieProvider",
+  "augments" : [
+    "Roo.state.Provider"
+  ],
+  "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,
+  "memberOf" : "CookieProvider",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+    {
+      "name" : "config",
+      "type" : "Object",
+      "desc" : "The configuration object",
+      "isOptional" : false
+    }
+  ],
+  "returns" : [
+  ],
+  "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",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "secure",
+      "type" : "Boolean",
+      "desc" : "True if the site is using SSL (defaults to false)",
+      "memberOf" : "Roo.state.CookieProvider",
+      "values" : [
+      ]
+    },
+    {
+      "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",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "expires",
+      "type" : "Date",
+      "desc" : "The cookie expiration date (defaults to 7 days from now)",
+      "memberOf" : "Roo.state.CookieProvider",
+      "values" : [
+      ]
+    }
+  ],
+  "methods" : [
+    {
+      "name" : "clear",
+      "desc" : "Clears a value from the state",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "decodeValue",
+      "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "value",
+          "type" : "String",
+          "desc" : "The value to decode",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Mixed",
+          "desc" : "The decoded value"
+        }
+      ]
+    },
+    {
+      "name" : "get",
+      "desc" : "Returns the current value for a key",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        },
+        {
+          "name" : "defaultValue",
+          "type" : "Mixed",
+          "desc" : "A default value to return if the key's value is not found",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Mixed",
+          "desc" : "The state data"
+        }
+      ]
+    },
+    {
+      "name" : "set",
+      "desc" : "Sets the value for a key",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        },
+        {
+          "name" : "value",
+          "type" : "Mixed",
+          "desc" : "The value to set",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "encodeValue",
+      "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "value",
+          "type" : "Mixed",
+          "desc" : "The value to encode",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "String",
+          "desc" : "The encoded value"
+        }
+      ]
+    }
+  ],
+  "events" : [
+    {
+      "name" : "statechange",
+      "desc" : "Fires when a state change occurs.",
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Provider",
+          "desc" : "This state provider",
+          "isOptional" : false
+        },
+        {
+          "name" : "key",
+          "type" : "String",
+          "desc" : "The state key which was changed",
+          "isOptional" : false
+        },
+        {
+          "name" : "value",
+          "type" : "String",
+          "desc" : "The encoded value for the state",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ]
+}
\ No newline at end of file