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