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

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