--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.state.CookieProvider</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.state.CookieProvider-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.state.CookieProvider-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.state.CookieProvider-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.state.CookieProvider-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+ <div class="inheritance res-block">
+ <pre class="res-block-inner"><a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.state.CookieProvider
+
+ </pre>
+ </div>
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.state.CookieProvider
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo.state</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_state_CookieProvider.js.html">Roo/state/CookieProvider.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">CookieProvider</td></tr>
+
+
+
+
+ <tr><td class="label">Extends:</td><td class="hd-info">
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+
+ </td></tr>
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ The default Provider implementation which saves state via cookies.<br/><br />Usage:<br/> <pre><code><br/> var cp = new Roo.state.CookieProvider({<br/> path: "/cgi-bin/",<br/> expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days<br/> domain: "roojs.com"<br/> })<br/> Roo.state.Manager.setProvider(cp);<br/> </code></pre>
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.state.CookieProvider';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo.state" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.state.CookieProvider.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.state.CookieProvider-configs"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
+
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.state.CookieProvider-cfg-domain" name=".domain"></a>
+ <div class="fixedFont">
+ <b class="itemname">domain</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The domain to save the cookie for.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ The domain to save the cookie for. Note that you cannot specify a different domain than<br/>your page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include<br/>all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same<br/>domain the page is running on including the 'www' like 'www.roojs.com')
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.state.CookieProvider
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.state.CookieProvider-cfg-expires" name=".expires"></a>
+ <div class="fixedFont">
+ <b class="itemname">expires</b> : <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The cookie expiration date (defaults to 7 days from now)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ The cookie expiration date (defaults to 7 days from now)
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.state.CookieProvider
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.state.CookieProvider-cfg-path" name=".path"></a>
+ <div class="fixedFont">
+ <b class="itemname">path</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.state.CookieProvider
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.state.CookieProvider-cfg-secure" name=".secure"></a>
+ <div class="fixedFont">
+ <b class="itemname">secure</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True if the site is using SSL (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">
+ True if the site is using SSL (defaults to false)
+
+ </div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.state.CookieProvider
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.state.CookieProvider-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.state.CookieProvider-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.state-method-CookieProvider" name=".CookieProvider"></a>
+ <div class="fixedFont">
+ <span class="attributes">new <B>Roo.state.</B></span><b class="itemname">CookieProvider</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+
+ <div class="short">Create a new Roo.state.CookieProvider</div>
+
+
+ <div class="long">
+
+
+
+ Create a new Roo.state.CookieProvider
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
+
+ </dt>
+ <dd>The configuration object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.state.Provider-method-clear" name=".clear"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">clear</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Clears a value from the state</div>
+
+
+
+ <div class="long">
+
+ Clears a value from the state
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
+
+ </dt>
+ <dd>The key name</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.state.Provider-method-decodeValue" name=".decodeValue"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">decodeValue</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ Mixed
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
+
+
+
+ <div class="long">
+
+ Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The value to decode</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">Mixed</span> The decoded value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.state.Provider-method-encodeValue" name=".encodeValue"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">encodeValue</b>
+
+ (Mixed <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Encodes a value including type information.</div>
+
+
+
+ <div class="long">
+
+ Encodes a value including type information. Decode with {<b>link</b> <b>decodeValue</b>}.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The value to encode</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The encoded value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.state.Provider-method-get" name=".get"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">get</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
+
+
+ :
+
+
+ Mixed
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns the current value for a key</div>
+
+
+
+ <div class="long">
+
+ Returns the current value for a key
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
+
+ </dt>
+ <dd>The key name</dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>defaultValue</b>
+
+ </dt>
+ <dd>A default value to return if the key's value is not found</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">Mixed</span> The state data</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.state.Provider-method-set" name=".set"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">set</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sets the value for a key</div>
+
+
+
+ <div class="long">
+
+ Sets the value for a key
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
+
+ </dt>
+ <dd>The key name</dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The value to set</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.state.CookieProvider-events"></a>
+
+
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Events</caption>
+ <thead>
+ <tr>
+ <th class="sig-header" colspan="2">Event</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+ </thead>
+
+
+
+
+
+ <tr class="method-row expandable config-row-alt0">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.state.Provider-event-*statechange"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">statechange</b> (Provider <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>key</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when a state change occurs.
+
+ </div>
+
+ <div class="long">
+
+ Fires when a state change occurs.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Provider</span> <b>this</b>
+
+ </dt>
+ <dd>This state provider</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
+
+ </dt>
+ <dd>The state key which was changed</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The encoded value for the state</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>
projects / roojs1 / blobdiff