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