git.roojs.org Git - roojs1/blob - docs/symbols/Roo.state.Manager.json

   1 {
   2   "name" : "Roo.state.Manager",
   3   "augments" : [
   4   ],
   5   "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>",
   6   "isSingleton" : true,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "Manager",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [
  15   ],
  16   "returns" : [
  17   ],
  18   "config" : [
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "getProvider",
  23       "desc" : "Gets the currently configured state provider",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.state.Manager",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33       ],
  34       "returns" : [
  35         {
  36           "name" : "",
  37           "type" : "Provider",
  38           "desc" : "The state provider"
  39         }
  40       ]
  41     },
  42     {
  43       "name" : "clear",
  44       "desc" : "Clears a value from the state",
  45       "isStatic" : false,
  46       "isConstructor" : false,
  47       "isPrivate" : false,
  48       "memberOf" : "Roo.state.Manager",
  49       "example" : "",
  50       "deprecated" : "",
  51       "since" : "",
  52       "see" : "",
  53       "params" : [
  54         {
  55           "name" : "name",
  56           "type" : "String",
  57           "desc" : "The key name",
  58           "isOptional" : false
  59         }
  60       ],
  61       "returns" : [
  62       ]
  63     },
  64     {
  65       "name" : "get",
  66       "desc" : "Returns the current value for a key",
  67       "isStatic" : false,
  68       "isConstructor" : false,
  69       "isPrivate" : false,
  70       "memberOf" : "Roo.state.Manager",
  71       "example" : "",
  72       "deprecated" : "",
  73       "since" : "",
  74       "see" : "",
  75       "params" : [
  76         {
  77           "name" : "name",
  78           "type" : "String",
  79           "desc" : "The key name",
  80           "isOptional" : false
  81         },
  82         {
  83           "name" : "defaultValue",
  84           "type" : "Mixed",
  85           "desc" : "The default value to return if the key lookup does not match",
  86           "isOptional" : false
  87         }
  88       ],
  89       "returns" : [
  90         {
  91           "name" : "",
  92           "type" : "Mixed",
  93           "desc" : "The state data"
  94         }
  95       ]
  96     },
  97     {
  98       "name" : "set",
  99       "desc" : "Sets the value for a key",
 100       "isStatic" : false,
 101       "isConstructor" : false,
 102       "isPrivate" : false,
 103       "memberOf" : "Roo.state.Manager",
 104       "example" : "",
 105       "deprecated" : "",
 106       "since" : "",
 107       "see" : "",
 108       "params" : [
 109         {
 110           "name" : "name",
 111           "type" : "String",
 112           "desc" : "The key name",
 113           "isOptional" : false
 114         },
 115         {
 116           "name" : "value",
 117           "type" : "Mixed",
 118           "desc" : "The state data",
 119           "isOptional" : false
 120         }
 121       ],
 122       "returns" : [
 123       ]
 124     },
 125     {
 126       "name" : "setProvider",
 127       "desc" : "Configures the default state provider for your application",
 128       "isStatic" : false,
 129       "isConstructor" : false,
 130       "isPrivate" : false,
 131       "memberOf" : "Roo.state.Manager",
 132       "example" : "",
 133       "deprecated" : "",
 134       "since" : "",
 135       "see" : "",
 136       "params" : [
 137         {
 138           "name" : "stateProvider",
 139           "type" : "Provider",
 140           "desc" : "The state provider to set",
 141           "isOptional" : false
 142         }
 143       ],
 144       "returns" : [
 145       ]
 146     }
 147   ],
 148   "events" : [
 149   ]
 150 }