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