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

   1 {
   2   "name" : "Roo.state.CookieProvider",
   3   "augments" : [
   4     "Roo.state.Provider"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "The default Provider implementation which saves state via cookies.\n<br />Usage:\n <pre><code>\n   var cp = new Roo.state.CookieProvider({\n       path: \"/cgi-bin/\",\n       expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days\n       domain: \"roojs.com\"\n   })\n   Roo.state.Manager.setProvider(cp);\n </code></pre>",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "CookieProvider",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [
  21     {
  22       "name" : "config",
  23       "type" : "Object",
  24       "desc" : "The configuration object",
  25       "isOptional" : false
  26     }
  27   ],
  28   "returns" : [],
  29   "throws" : "",
  30   "requires" : "",
  31   "config" : [
  32     {
  33       "name" : "path",
  34       "type" : "String",
  35       "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
  36       "memberOf" : "Roo.state.CookieProvider"
  37     },
  38     {
  39       "name" : "secure",
  40       "type" : "Boolean",
  41       "desc" : "True if the site is using SSL (defaults to false)",
  42       "memberOf" : "Roo.state.CookieProvider"
  43     },
  44     {
  45       "name" : "domain",
  46       "type" : "String",
  47       "desc" : "The domain to save the cookie for.  Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')",
  48       "memberOf" : "Roo.state.CookieProvider"
  49     },
  50     {
  51       "name" : "expires",
  52       "type" : "Date",
  53       "desc" : "The cookie expiration date (defaults to 7 days from now)",
  54       "memberOf" : "Roo.state.CookieProvider"
  55     }
  56   ],
  57   "methods" : [
  58     {
  59       "name" : "clear",
  60       "type" : "function",
  61       "desc" : "Clears a value from the state",
  62       "sig" : "(name)",
  63       "static" : false,
  64       "memberOf" : "Roo.state.Provider",
  65       "isStatic" : false,
  66       "isConstructor" : false,
  67       "isPrivate" : false,
  68       "example" : "",
  69       "deprecated" : "",
  70       "since" : "",
  71       "see" : "",
  72       "exceptions" : "",
  73       "requires" : "",
  74       "params" : [
  75         {
  76           "name" : "name",
  77           "type" : "String",
  78           "desc" : "The key name",
  79           "isOptional" : false
  80         }
  81       ],
  82       "returns" : []
  83     },
  84     {
  85       "name" : "decodeValue",
  86       "type" : "function",
  87       "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
  88       "sig" : "(value)",
  89       "static" : false,
  90       "memberOf" : "Roo.state.Provider",
  91       "isStatic" : false,
  92       "isConstructor" : false,
  93       "isPrivate" : false,
  94       "example" : "",
  95       "deprecated" : "",
  96       "since" : "",
  97       "see" : "",
  98       "exceptions" : "",
  99       "requires" : "",
 100       "params" : [
 101         {
 102           "name" : "value",
 103           "type" : "String",
 104           "desc" : "The value to decode",
 105           "isOptional" : false
 106         }
 107       ],
 108       "returns" : [
 109         {
 110           "name" : "",
 111           "type" : "Mixed",
 112           "desc" : "The decoded value"
 113         }
 114       ]
 115     },
 116     {
 117       "name" : "get",
 118       "type" : "function",
 119       "desc" : "Returns the current value for a key",
 120       "sig" : "(name, defaultValue)",
 121       "static" : false,
 122       "memberOf" : "Roo.state.Provider",
 123       "isStatic" : false,
 124       "isConstructor" : false,
 125       "isPrivate" : false,
 126       "example" : "",
 127       "deprecated" : "",
 128       "since" : "",
 129       "see" : "",
 130       "exceptions" : "",
 131       "requires" : "",
 132       "params" : [
 133         {
 134           "name" : "name",
 135           "type" : "String",
 136           "desc" : "The key name",
 137           "isOptional" : false
 138         },
 139         {
 140           "name" : "defaultValue",
 141           "type" : "Mixed",
 142           "desc" : "A default value to return if the key's value is not found",
 143           "isOptional" : false
 144         }
 145       ],
 146       "returns" : [
 147         {
 148           "name" : "",
 149           "type" : "Mixed",
 150           "desc" : "The state data"
 151         }
 152       ]
 153     },
 154     {
 155       "name" : "set",
 156       "type" : "function",
 157       "desc" : "Sets the value for a key",
 158       "sig" : "(name, value)",
 159       "static" : false,
 160       "memberOf" : "Roo.state.Provider",
 161       "isStatic" : false,
 162       "isConstructor" : false,
 163       "isPrivate" : false,
 164       "example" : "",
 165       "deprecated" : "",
 166       "since" : "",
 167       "see" : "",
 168       "exceptions" : "",
 169       "requires" : "",
 170       "params" : [
 171         {
 172           "name" : "name",
 173           "type" : "String",
 174           "desc" : "The key name",
 175           "isOptional" : false
 176         },
 177         {
 178           "name" : "value",
 179           "type" : "Mixed",
 180           "desc" : "The value to set",
 181           "isOptional" : false
 182         }
 183       ],
 184       "returns" : []
 185     },
 186     {
 187       "name" : "encodeValue",
 188       "type" : "function",
 189       "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
 190       "sig" : "(value)",
 191       "static" : false,
 192       "memberOf" : "Roo.state.Provider",
 193       "isStatic" : false,
 194       "isConstructor" : false,
 195       "isPrivate" : false,
 196       "example" : "",
 197       "deprecated" : "",
 198       "since" : "",
 199       "see" : "",
 200       "exceptions" : "",
 201       "requires" : "",
 202       "params" : [
 203         {
 204           "name" : "value",
 205           "type" : "Mixed",
 206           "desc" : "The value to encode",
 207           "isOptional" : false
 208         }
 209       ],
 210       "returns" : [
 211         {
 212           "name" : "",
 213           "type" : "String",
 214           "desc" : "The encoded value"
 215         }
 216       ]
 217     }
 218   ],
 219   "events" : [
 220     {
 221       "name" : "statechange",
 222       "type" : "function",
 223       "desc" : "Fires when a state change occurs.",
 224       "sig" : "function (_self, key, value)\n{\n\n}",
 225       "memberOf" : "Roo.state.Provider",
 226       "example" : "",
 227       "deprecated" : "",
 228       "since" : "",
 229       "see" : "",
 230       "params" : [
 231         {
 232           "name" : "this",
 233           "type" : "Provider",
 234           "desc" : "This state provider",
 235           "isOptional" : false
 236         },
 237         {
 238           "name" : "key",
 239           "type" : "String",
 240           "desc" : "The state key which was changed",
 241           "isOptional" : false
 242         },
 243         {
 244           "name" : "value",
 245           "type" : "String",
 246           "desc" : "The encoded value for the state",
 247           "isOptional" : false
 248         }
 249       ],
 250       "returns" : []
 251     }
 252   ]
 253 }