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