X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.state.CookieProvider.html?ds=sidebyside diff --git a/docs/output/Ext.state.CookieProvider.html b/docs/output/Ext.state.CookieProvider.html index 54c92d71..80cb4ebb 100644 --- a/docs/output/Ext.state.CookieProvider.html +++ b/docs/output/Ext.state.CookieProvider.html @@ -1,233 +1,32 @@ -
Provider - CookieProvider
Package: | Ext.state |
Defined In: | CookieProvider.js |
Class: | CookieProvider |
Extends: | Provider |
var cp = new Ext.state.CookieProvider({
+Provider
+ CookieProvider
Class Ext.state.CookieProvider
Package: Ext.state Defined In: CookieProvider.js Class: CookieProvider Extends: Provider
The default Provider implementation which saves state via cookies.
+
Usage:
+ var cp = new Ext.state.CookieProvider({
path: "/cgi-bin/",
expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
domain: "extjs.com"
});
- Ext.state.Manager.setProvider(cp);
-
-
-
- Config Options
-
- Public Properties
- This class has no public properties.
- Public Methods
-
-
- Method
- Defined By
-
-
-
-
-
- CookieProvider( Object config
)
- Create a new CookieProvider
-
- Create a new CookieProvider
- Parameters:
- config
: ObjectThe configuration object
- Returns:
-
-
-
-
-
-
-
- CookieProvider
-
-
-
-
-
- clear( String name
) : void
- Clears a value from the state
-
- Clears a value from the state
- Parameters:
- name
: StringThe key name
- Returns:
-
- void
-
-
-
-
-
- Provider
-
-
-
-
-
- decodeValue( String value
) : Mixed
- Decodes a string previously encoded with encodeValue.
-
- Decodes a string previously encoded with encodeValue.
- Parameters:
- value
: StringThe value to decode
- Returns:
-
- Mixed
The decoded value
-
-
-
-
-
- Provider
-
-
-
-
-
- encodeValue( Mixed value
) : String
- Encodes a value including type information. Decode with decodeValue.
-
- Encodes a value including type information. Decode with decodeValue.
- Parameters:
- value
: MixedThe value to encode
- Returns:
-
- String
The encoded value
-
-
-
-
-
- Provider
-
-
-
-
-
- get( String name
, Mixed defaultValue
) : Mixed
- Returns the current value for a key
-
- Returns the current value for a key
- Parameters:
- name
: StringThe key namedefaultValue
: MixedA default value to return if the key's value is not found
- Returns:
-
- Mixed
The state data
-
-
-
-
-
- Provider
-
-
-
-
-
- set( String name
, Mixed value
) : void
- Sets the value for a key
-
- Sets the value for a key
- Parameters:
- name
: StringThe key namevalue
: MixedThe value to set
- Returns:
-
- void
-
-
-
-
-
- Provider
-
-
-
- Public Events
-
-
- Event
- Defined By
-
-
-
-
-
- statechange : ( Provider this
, String key
, String value
)
- Fires when a state change occurs.
-
- Fires when a state change occurs.
- Listeners will be called with the following arguments:
- this
: ProviderThis state providerkey
: StringThe state key which was changedvalue
: StringThe encoded value for the state
-
-
-
-
- Provider
-
-
-
-
\ No newline at end of file
+ Ext.state.Manager.setProvider(cp);
Config Options | Defined By | |
---|---|---|
domain : String The domain to save the cookie for. Note that you cannot specify a different domain than
+your page is on, but you can... The domain to save the cookie for. Note that you cannot specify a different domain than
+your page is on, but you can specify a sub-domain, or simply the domain itself like 'extjs.com' to include
+all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same
+domain the page is running on including the 'www' like 'www.extjs.com') | CookieProvider | |
expires : Date The cookie expiration date (defaults to 7 days from now) | CookieProvider | |
path : String The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site) | CookieProvider | |
secure : Boolean True if the site is using SSL (defaults to false) | CookieProvider |
Property | Defined By | |
---|---|---|
var : Object a -> Array
+n -> Number
+d -> Date
+b -> Boolean
+s -> String
+o -> Object
+-> Empty (null) | Provider |
Method | Defined By | |
---|---|---|
CookieProvider( Object config )
+ Create a new CookieProvider Create a new CookieProvider Parameters:
| CookieProvider | |
clear( String name )
+ :
+ voidClears a value from the state Clears a value from the state Parameters:
| Provider | |
decodeValue( String value )
+ :
+ MixedDecodes a string previously encoded with encodeValue. Decodes a string previously encoded with encodeValue. Parameters:
| Provider | |
encodeValue( Mixed value )
+ :
+ StringEncodes a value including type information. Decode with decodeValue. Encodes a value including type information. Decode with decodeValue. Parameters:
| Provider | |
get( String name , Mixed defaultValue )
+ :
+ MixedReturns the current value for a key Returns the current value for a key Parameters:
| Provider | |
set( String name , Mixed value )
+ :
+ voidSets the value for a key Sets the value for a key Parameters:
| Provider |
Event | Defined By | |
---|---|---|
statechange :
+ ( Provider this , String key , String value )
+ Fires when a state change occurs. Fires when a state change occurs. Listeners will be called with the following arguments:
| Provider |