Upgrade to ExtJS 3.3.1 - Released 11/30/2010

[extjs.git] / docs / output / Ext.state.CookieProvider.html

diff --git a/docs/output/Ext.state.CookieProvider.html b/docs/output/Ext.state.CookieProvider.html
index 02cab98..80cb4eb 100644 (file)
--- a/docs/output/Ext.state.CookieProvider.html
+++ b/docs/output/Ext.state.CookieProvider.html
@@ -1,4 +1,5 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.state.CookieProvider-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.state.CookieProvider-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.state.CookieProvider-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.state.CookieProvider-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.state.CookieProvider"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.state.Provider.html" ext:member="" ext:cls="Ext.state.Provider">Provider</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">CookieProvider</pre></div><h1>Class <a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">Ext.state.CookieProvider</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">CookieProvider.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">CookieProvider</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider" ext:member="">Provider</a></td></tr></table><div class="description">The default Provider implementation which saves state via cookies.
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.state.CookieProvider-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.state.CookieProvider-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.state.CookieProvider-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.state.CookieProvider-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.state.CookieProvider"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.state.Provider.html" ext:member="" ext:cls="Ext.state.Provider">Provider</a>
+  <img src="resources/elbow-end.gif">CookieProvider</pre></div><h1>Class <a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">Ext.state.CookieProvider</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">CookieProvider.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">CookieProvider</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider" ext:member="">Provider</a></td></tr></table><div class="description">The default Provider implementation which saves state via cookies.

 <br />Usage:
  <pre><code><b>var</b> cp = <b>new</b> Ext.state.CookieProvider({
        path: <em>"/cgi-bin/"</em>,
 <br />Usage:
  <pre><code><b>var</b> cp = <b>new</b> Ext.state.CookieProvider({
        path: <em>"/cgi-bin/"</em>,


@@ -9,15 +10,13 @@
 your page is on, but you can...</div><div class="long">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
 your page is on, but you can...</div><div class="long">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')</div></div></td><td class="msource">CookieProvider</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-expires"></a><b><a href="source/CookieProvider.html#cfg-Ext.state.CookieProvider-expires">expires</a></b> : Date<div class="mdesc">The cookie expiration date (defaults to 7 days from now)</div></td><td class="msource">CookieProvider</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-path"></a><b><a href="source/CookieProvider.html#cfg-Ext.state.CookieProvider-path">path</a></b> : String<div class="mdesc">The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)</div></td><td class="msource">CookieProvider</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-secure"></a><b><a href="source/CookieProvider.html#cfg-Ext.state.CookieProvider-secure">secure</a></b> : Boolean<div class="mdesc">True if the site is using SSL (defaults to false)</div></td><td class="msource">CookieProvider</td></tr></tbody></table><a id="Ext.state.CookieProvider-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-"></a><b><a href="source/ext-lang-vn.html#prop-Ext.state.Provider-"></a></b> : Object<div class="mdesc">List compiled by mystix on the extjs.com forums.
-Thank you Mystix!</div></td><td class="msource"><a href="output/Ext.state.Provider.html#" ext:member="#" ext:cls="Ext.state.Provider">Provider</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-Slovak"></a><b><a href="source/ext-lang-sk.html#prop-Ext.state.Provider-Slovak">Slovak</a></b> : Object<div class="mdesc">List compiled by mystix on the extjs.com forums.
-Thank you Mystix!</div></td><td class="msource"><a href="output/Ext.state.Provider.html#Slovak" ext:member="#Slovak" ext:cls="Ext.state.Provider">Provider</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-indicatorText"></a><b><a href="source/ext-lang-sv_SE.html#prop-Ext.state.Provider-indicatorText">indicatorText</a></b> : Object<div class="mdesc"><div class="short">Swedish translation (utf8-encoding)
-By Erik Andersson, Monator Technologies
-24 April 2007
-Changed by Cariad, 29 July ...</div><div class="long">Swedish translation (utf8-encoding)
-By Erik Andersson, Monator Technologies
-24 April 2007
-Changed by Cariad, 29 July 2007</div></div></td><td class="msource"><a href="output/Ext.state.Provider.html#indicatorText" ext:member="#indicatorText" ext:cls="Ext.state.Provider">Provider</a></td></tr></tbody></table><a id="Ext.state.CookieProvider-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-CookieProvider"></a><b><a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">CookieProvider</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
+domain the page is running on including the 'www' like 'www.extjs.com')</div></div></td><td class="msource">CookieProvider</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-expires"></a><b><a href="source/CookieProvider.html#cfg-Ext.state.CookieProvider-expires">expires</a></b> : Date<div class="mdesc">The cookie expiration date (defaults to 7 days from now)</div></td><td class="msource">CookieProvider</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-path"></a><b><a href="source/CookieProvider.html#cfg-Ext.state.CookieProvider-path">path</a></b> : String<div class="mdesc">The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)</div></td><td class="msource">CookieProvider</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-secure"></a><b><a href="source/CookieProvider.html#cfg-Ext.state.CookieProvider-secure">secure</a></b> : Boolean<div class="mdesc">True if the site is using SSL (defaults to false)</div></td><td class="msource">CookieProvider</td></tr></tbody></table><a id="Ext.state.CookieProvider-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-var"></a><b><a href="source/Provider1.html#prop-Ext.state.Provider-var">var</a></b> : Object<div class="mdesc">a -> Array
+n -> Number
+d -> Date
+b -> Boolean
+s -> String
+o -> Object
+-> Empty (null)</div></td><td class="msource"><a href="output/Ext.state.Provider.html#var" ext:member="#var" ext:cls="Ext.state.Provider">Provider</a></td></tr></tbody></table><a id="Ext.state.CookieProvider-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.CookieProvider-CookieProvider"></a><b><a href="source/CookieProvider.html#cls-Ext.state.CookieProvider">CookieProvider</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)

     <div class="mdesc"><div class="short">Create a new CookieProvider</div><div class="long">Create a new CookieProvider<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The configuration object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CookieProvider</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-clear"></a><b><a href="source/Provider1.html#method-Ext.state.Provider-clear">clear</a></b>(&nbsp;<code>String&nbsp;name</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Clears a value from the state</div><div class="long">Clears a value from the state<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.state.Provider.html#clear" ext:member="#clear" ext:cls="Ext.state.Provider">Provider</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-decodeValue"></a><b><a href="source/Provider1.html#method-Ext.state.Provider-decodeValue">decodeValue</a></b>(&nbsp;<code>String&nbsp;value</code>&nbsp;)
     <div class="mdesc"><div class="short">Create a new CookieProvider</div><div class="long">Create a new CookieProvider<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The configuration object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CookieProvider</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-clear"></a><b><a href="source/Provider1.html#method-Ext.state.Provider-clear">clear</a></b>(&nbsp;<code>String&nbsp;name</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Clears a value from the state</div><div class="long">Clears a value from the state<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.state.Provider.html#clear" ext:member="#clear" ext:cls="Ext.state.Provider">Provider</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Provider-decodeValue"></a><b><a href="source/Provider1.html#method-Ext.state.Provider-decodeValue">decodeValue</a></b>(&nbsp;<code>String&nbsp;value</code>&nbsp;)