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

   1 {
   2   "name" : "Roo.state.Provider",
   3   "augments" : [],
   4   "childClasses" : {
   5     "Roo.state.Provider" : [
   6       "Roo.state.CookieProvider"
   7     ]
   8   },
   9   "tree_children" : [],
  10   "tree_parent" : [],
  11   "desc" : "Abstract base class for state provider implementations. This class provides methods\nfor encoding and decoding <b>typed</b> variables including dates and defines the \nProvider interface.",
  12   "isSingleton" : false,
  13   "isStatic" : true,
  14   "isBuiltin" : false,
  15   "isAbstract" : false,
  16   "isBuilderTop" : false,
  17   "memberOf" : "Provider",
  18   "example" : "",
  19   "deprecated" : "",
  20   "since" : "",
  21   "see" : "",
  22   "params" : [],
  23   "returns" : [],
  24   "throws" : "",
  25   "requires" : "",
  26   "config" : [],
  27   "methods" : [
  28     {
  29       "name" : "clear",
  30       "type" : "function",
  31       "desc" : "Clears a value from the state",
  32       "sig" : "(name)",
  33       "static" : false,
  34       "memberOf" : "",
  35       "isStatic" : false,
  36       "isConstructor" : false,
  37       "isPrivate" : false,
  38       "example" : "",
  39       "deprecated" : "",
  40       "since" : "",
  41       "see" : "",
  42       "exceptions" : "",
  43       "requires" : "",
  44       "params" : [
  45         {
  46           "name" : "name",
  47           "type" : "String",
  48           "desc" : "The key name",
  49           "isOptional" : false
  50         }
  51       ],
  52       "returns" : []
  53     },
  54     {
  55       "name" : "decodeValue",
  56       "type" : "function",
  57       "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
  58       "sig" : "(value)",
  59       "static" : false,
  60       "memberOf" : "",
  61       "isStatic" : false,
  62       "isConstructor" : false,
  63       "isPrivate" : false,
  64       "example" : "",
  65       "deprecated" : "",
  66       "since" : "",
  67       "see" : "",
  68       "exceptions" : "",
  69       "requires" : "",
  70       "params" : [
  71         {
  72           "name" : "value",
  73           "type" : "String",
  74           "desc" : "The value to decode",
  75           "isOptional" : false
  76         }
  77       ],
  78       "returns" : [
  79         {
  80           "name" : "",
  81           "type" : "Mixed",
  82           "desc" : "The decoded value"
  83         }
  84       ]
  85     },
  86     {
  87       "name" : "get",
  88       "type" : "function",
  89       "desc" : "Returns the current value for a key",
  90       "sig" : "(name, defaultValue)",
  91       "static" : false,
  92       "memberOf" : "",
  93       "isStatic" : false,
  94       "isConstructor" : false,
  95       "isPrivate" : false,
  96       "example" : "",
  97       "deprecated" : "",
  98       "since" : "",
  99       "see" : "",
 100       "exceptions" : "",
 101       "requires" : "",
 102       "params" : [
 103         {
 104           "name" : "name",
 105           "type" : "String",
 106           "desc" : "The key name",
 107           "isOptional" : false
 108         },
 109         {
 110           "name" : "defaultValue",
 111           "type" : "Mixed",
 112           "desc" : "A default value to return if the key's value is not found",
 113           "isOptional" : false
 114         }
 115       ],
 116       "returns" : [
 117         {
 118           "name" : "",
 119           "type" : "Mixed",
 120           "desc" : "The state data"
 121         }
 122       ]
 123     },
 124     {
 125       "name" : "set",
 126       "type" : "function",
 127       "desc" : "Sets the value for a key",
 128       "sig" : "(name, value)",
 129       "static" : false,
 130       "memberOf" : "",
 131       "isStatic" : false,
 132       "isConstructor" : false,
 133       "isPrivate" : false,
 134       "example" : "",
 135       "deprecated" : "",
 136       "since" : "",
 137       "see" : "",
 138       "exceptions" : "",
 139       "requires" : "",
 140       "params" : [
 141         {
 142           "name" : "name",
 143           "type" : "String",
 144           "desc" : "The key name",
 145           "isOptional" : false
 146         },
 147         {
 148           "name" : "value",
 149           "type" : "Mixed",
 150           "desc" : "The value to set",
 151           "isOptional" : false
 152         }
 153       ],
 154       "returns" : []
 155     },
 156     {
 157       "name" : "encodeValue",
 158       "type" : "function",
 159       "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
 160       "sig" : "(value)",
 161       "static" : false,
 162       "memberOf" : "",
 163       "isStatic" : false,
 164       "isConstructor" : false,
 165       "isPrivate" : false,
 166       "example" : "",
 167       "deprecated" : "",
 168       "since" : "",
 169       "see" : "",
 170       "exceptions" : "",
 171       "requires" : "",
 172       "params" : [
 173         {
 174           "name" : "value",
 175           "type" : "Mixed",
 176           "desc" : "The value to encode",
 177           "isOptional" : false
 178         }
 179       ],
 180       "returns" : [
 181         {
 182           "name" : "",
 183           "type" : "String",
 184           "desc" : "The encoded value"
 185         }
 186       ]
 187     }
 188   ],
 189   "events" : [
 190     {
 191       "name" : "statechange",
 192       "type" : "function",
 193       "desc" : "Fires when a state change occurs.",
 194       "sig" : "function (_self, key, value)\n{\n\n}",
 195       "memberOf" : "",
 196       "example" : "",
 197       "deprecated" : "",
 198       "since" : "",
 199       "see" : "",
 200       "params" : [
 201         {
 202           "name" : "this",
 203           "type" : "Provider",
 204           "desc" : "This state provider",
 205           "isOptional" : false
 206         },
 207         {
 208           "name" : "key",
 209           "type" : "String",
 210           "desc" : "The state key which was changed",
 211           "isOptional" : false
 212         },
 213         {
 214           "name" : "value",
 215           "type" : "String",
 216           "desc" : "The encoded value for the state",
 217           "isOptional" : false
 218         }
 219       ],
 220       "returns" : []
 221     }
 222   ]
 223 }