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

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

diff --git a/docs/symbols/Roo.state.Manager.json b/docs/symbols/Roo.state.Manager.json
new file mode 100644 (file)
index 0000000..d583edd
--- /dev/null
+++ b/docs/symbols/Roo.state.Manager.json
@@ -0,0 +1,150 @@
+{
+  "name" : "Roo.state.Manager",
+  "augments" : [
+  ],
+  "desc" : "This is the global state manager. By default all components that are \"state aware\" check this class\nfor state information if you don't pass them a custom state provider. In order for this class\nto be useful, it must be initialized with a provider when your application initializes.\n <pre><code>\n// in your initialization function\ninit : function(){\n   Roo.state.Manager.setProvider(new Roo.state.CookieProvider());\n   ...\n   // supposed you have a {@link Roo.BorderLayout}\n   var layout = new Roo.BorderLayout(...);\n   layout.restoreState();\n   // or a {Roo.BasicDialog}\n   var dialog = new Roo.BasicDialog(...);\n   dialog.restoreState();\n </code></pre>",
+  "isSingleton" : true,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "Manager",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+  ],
+  "returns" : [
+  ],
+  "config" : [
+  ],
+  "methods" : [
+    {
+      "name" : "getProvider",
+      "desc" : "Gets the currently configured state provider",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Manager",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Provider",
+          "desc" : "The state provider"
+        }
+      ]
+    },
+    {
+      "name" : "clear",
+      "desc" : "Clears a value from the state",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Manager",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "get",
+      "desc" : "Returns the current value for a key",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Manager",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        },
+        {
+          "name" : "defaultValue",
+          "type" : "Mixed",
+          "desc" : "The default value to return if the key lookup does not match",
+          "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.Manager",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        },
+        {
+          "name" : "value",
+          "type" : "Mixed",
+          "desc" : "The state data",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "setProvider",
+      "desc" : "Configures the default state provider for your application",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Manager",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "stateProvider",
+          "type" : "Provider",
+          "desc" : "The state provider to set",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file