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

   1 {
   2   "name" : "Roo.state.Provider",
   3   "augments" : [
   4   ],
   5   "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.",
   6   "isSingleton" : false,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "Provider",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [
  15   ],
  16   "returns" : [
  17   ],
  18   "config" : [
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "clear",
  23       "desc" : "Clears a value from the state",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.state.Provider",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33         {
  34           "name" : "name",
  35           "type" : "String",
  36           "desc" : "The key name",
  37           "isOptional" : false
  38         }
  39       ],
  40       "returns" : [
  41       ]
  42     },
  43     {
  44       "name" : "decodeValue",
  45       "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
  46       "isStatic" : false,
  47       "isConstructor" : false,
  48       "isPrivate" : false,
  49       "memberOf" : "Roo.state.Provider",
  50       "example" : "",
  51       "deprecated" : "",
  52       "since" : "",
  53       "see" : "",
  54       "params" : [
  55         {
  56           "name" : "value",
  57           "type" : "String",
  58           "desc" : "The value to decode",
  59           "isOptional" : false
  60         }
  61       ],
  62       "returns" : [
  63         {
  64           "name" : "",
  65           "type" : "Mixed",
  66           "desc" : "The decoded value"
  67         }
  68       ]
  69     },
  70     {
  71       "name" : "get",
  72       "desc" : "Returns the current value for a key",
  73       "isStatic" : false,
  74       "isConstructor" : false,
  75       "isPrivate" : false,
  76       "memberOf" : "Roo.state.Provider",
  77       "example" : "",
  78       "deprecated" : "",
  79       "since" : "",
  80       "see" : "",
  81       "params" : [
  82         {
  83           "name" : "name",
  84           "type" : "String",
  85           "desc" : "The key name",
  86           "isOptional" : false
  87         },
  88         {
  89           "name" : "defaultValue",
  90           "type" : "Mixed",
  91           "desc" : "A default value to return if the key's value is not found",
  92           "isOptional" : false
  93         }
  94       ],
  95       "returns" : [
  96         {
  97           "name" : "",
  98           "type" : "Mixed",
  99           "desc" : "The state data"
 100         }
 101       ]
 102     },
 103     {
 104       "name" : "set",
 105       "desc" : "Sets the value for a key",
 106       "isStatic" : false,
 107       "isConstructor" : false,
 108       "isPrivate" : false,
 109       "memberOf" : "Roo.state.Provider",
 110       "example" : "",
 111       "deprecated" : "",
 112       "since" : "",
 113       "see" : "",
 114       "params" : [
 115         {
 116           "name" : "name",
 117           "type" : "String",
 118           "desc" : "The key name",
 119           "isOptional" : false
 120         },
 121         {
 122           "name" : "value",
 123           "type" : "Mixed",
 124           "desc" : "The value to set",
 125           "isOptional" : false
 126         }
 127       ],
 128       "returns" : [
 129       ]
 130     },
 131     {
 132       "name" : "encodeValue",
 133       "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
 134       "isStatic" : false,
 135       "isConstructor" : false,
 136       "isPrivate" : false,
 137       "memberOf" : "Roo.state.Provider",
 138       "example" : "",
 139       "deprecated" : "",
 140       "since" : "",
 141       "see" : "",
 142       "params" : [
 143         {
 144           "name" : "value",
 145           "type" : "Mixed",
 146           "desc" : "The value to encode",
 147           "isOptional" : false
 148         }
 149       ],
 150       "returns" : [
 151         {
 152           "name" : "",
 153           "type" : "String",
 154           "desc" : "The encoded value"
 155         }
 156       ]
 157     }
 158   ],
 159   "events" : [
 160     {
 161       "name" : "statechange",
 162       "desc" : "Fires when a state change occurs.",
 163       "memberOf" : "",
 164       "example" : "",
 165       "deprecated" : "",
 166       "since" : "",
 167       "see" : "",
 168       "params" : [
 169         {
 170           "name" : "this",
 171           "type" : "Provider",
 172           "desc" : "This state provider",
 173           "isOptional" : false
 174         },
 175         {
 176           "name" : "key",
 177           "type" : "String",
 178           "desc" : "The state key which was changed",
 179           "isOptional" : false
 180         },
 181         {
 182           "name" : "value",
 183           "type" : "String",
 184           "desc" : "The encoded value for the state",
 185           "isOptional" : false
 186         }
 187       ],
 188       "returns" : [
 189       ]
 190     }
 191   ]
 192 }