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

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