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

   1 {
   2   "name" : "Roo.state.CookieProvider",
   3   "augments" : [
   4     "Roo.state.Provider"
   5   ],
   6   "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>",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11     {
  12       "name" : "path",
  13       "type" : "String",
  14       "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
  15       "memberOf" : "Roo.state.CookieProvider",
  16       "values" : [
  17       ]
  18     },
  19     {
  20       "name" : "secure",
  21       "type" : "Boolean",
  22       "desc" : "True if the site is using SSL (defaults to false)",
  23       "memberOf" : "Roo.state.CookieProvider",
  24       "values" : [
  25       ]
  26     },
  27     {
  28       "name" : "domain",
  29       "type" : "String",
  30       "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')",
  31       "memberOf" : "Roo.state.CookieProvider",
  32       "values" : [
  33       ]
  34     },
  35     {
  36       "name" : "expires",
  37       "type" : "Date",
  38       "desc" : "The cookie expiration date (defaults to 7 days from now)",
  39       "memberOf" : "Roo.state.CookieProvider",
  40       "values" : [
  41       ]
  42     }
  43   ],
  44   "methods" : [
  45     {
  46       "name" : "clear",
  47       "desc" : "Clears a value from the state",
  48       "isStatic" : false,
  49       "isConstructor" : false,
  50       "isPrivate" : false,
  51       "memberOf" : "Roo.state.Provider",
  52       "example" : "",
  53       "deprecated" : "",
  54       "since" : "",
  55       "see" : "",
  56       "params" : [
  57         {
  58           "name" : "name",
  59           "type" : "String",
  60           "desc" : "The key name",
  61           "isOptional" : false
  62         }
  63       ],
  64       "returns" : [
  65       ]
  66     },
  67     {
  68       "name" : "decodeValue",
  69       "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
  70       "isStatic" : false,
  71       "isConstructor" : false,
  72       "isPrivate" : false,
  73       "memberOf" : "Roo.state.Provider",
  74       "example" : "",
  75       "deprecated" : "",
  76       "since" : "",
  77       "see" : "",
  78       "params" : [
  79         {
  80           "name" : "value",
  81           "type" : "String",
  82           "desc" : "The value to decode",
  83           "isOptional" : false
  84         }
  85       ],
  86       "returns" : [
  87         {
  88           "name" : "",
  89           "type" : "Mixed",
  90           "desc" : "The decoded value"
  91         }
  92       ]
  93     },
  94     {
  95       "name" : "get",
  96       "desc" : "Returns the current 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" : "defaultValue",
 114           "type" : "Mixed",
 115           "desc" : "A default value to return if the key's value is not found",
 116           "isOptional" : false
 117         }
 118       ],
 119       "returns" : [
 120         {
 121           "name" : "",
 122           "type" : "Mixed",
 123           "desc" : "The state data"
 124         }
 125       ]
 126     },
 127     {
 128       "name" : "set",
 129       "desc" : "Sets the value for a key",
 130       "isStatic" : false,
 131       "isConstructor" : false,
 132       "isPrivate" : false,
 133       "memberOf" : "Roo.state.Provider",
 134       "example" : "",
 135       "deprecated" : "",
 136       "since" : "",
 137       "see" : "",
 138       "params" : [
 139         {
 140           "name" : "name",
 141           "type" : "String",
 142           "desc" : "The key name",
 143           "isOptional" : false
 144         },
 145         {
 146           "name" : "value",
 147           "type" : "Mixed",
 148           "desc" : "The value to set",
 149           "isOptional" : false
 150         }
 151       ],
 152       "returns" : [
 153       ]
 154     },
 155     {
 156       "name" : "encodeValue",
 157       "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
 158       "isStatic" : false,
 159       "isConstructor" : false,
 160       "isPrivate" : false,
 161       "memberOf" : "Roo.state.Provider",
 162       "example" : "",
 163       "deprecated" : "",
 164       "since" : "",
 165       "see" : "",
 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       "desc" : "Fires when a state change occurs.",
 187       "memberOf" : "Roo.state.Provider",
 188       "example" : "",
 189       "deprecated" : "",
 190       "since" : "",
 191       "see" : "",
 192       "params" : [
 193         {
 194           "name" : "this",
 195           "type" : "Provider",
 196           "desc" : "This state provider",
 197           "isOptional" : false
 198         },
 199         {
 200           "name" : "key",
 201           "type" : "String",
 202           "desc" : "The state key which was changed",
 203           "isOptional" : false
 204         },
 205         {
 206           "name" : "value",
 207           "type" : "String",
 208           "desc" : "The encoded value for the state",
 209           "isOptional" : false
 210         }
 211       ],
 212       "returns" : [
 213       ]
 214     }
 215   ]
 216 }