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

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