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