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

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