1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.state.CookieProvider</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.state.CookieProvider-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.state.CookieProvider-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.state.CookieProvider-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.state.CookieProvider-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.state.CookieProvider
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.state.CookieProvider
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.state</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_state_CookieProvider.js.html">Roo/state/CookieProvider.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">CookieProvider</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 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>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.state.CookieProvider';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.state" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.state.CookieProvider.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.state.CookieProvider-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.state.CookieProvider-cfg-domain" name=".domain"></a>
132 <div class="fixedFont">
133 <b class="itemname">domain</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">The domain to save the cookie for.</div>
144 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')
154 Roo.state.CookieProvider
160 <tr class="config-row expandable config-row-alt1 notInherited">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.state.CookieProvider-cfg-expires" name=".expires"></a>
165 <div class="fixedFont">
166 <b class="itemname">expires</b> : <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a>
172 <div class="short">The cookie expiration date (defaults to 7 days from now)</div>
177 The cookie expiration date (defaults to 7 days from now)
187 Roo.state.CookieProvider
193 <tr class="config-row expandable config-row-alt0 notInherited">
194 <td class="micon"><a class="exi" href="#expand"> </a></td>
197 <a id="Roo.state.CookieProvider-cfg-path" name=".path"></a>
198 <div class="fixedFont">
199 <b class="itemname">path</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
205 <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>
210 The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)
220 Roo.state.CookieProvider
226 <tr class="config-row expandable config-row-alt1 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
230 <a id="Roo.state.CookieProvider-cfg-secure" name=".secure"></a>
231 <div class="fixedFont">
232 <b class="itemname">secure</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
238 <div class="short">True if the site is using SSL (defaults to false)</div>
243 True if the site is using SSL (defaults to false)
253 Roo.state.CookieProvider
269 <!-- ============================== public properties ==================== -->
273 <a id="Roo.state.CookieProvider-props"></a>
279 <table cellspacing="0" class="member-table">
280 <caption class="Empty">Public Properties - Has None</caption>
286 <!-- ============================== methods summary / details ======================== -->
289 <a id="Roo.state.CookieProvider-methods"></a>
290 <!-- constructor?? -->
297 <!-- then dynamics first -->
304 <table cellspacing="0" class="member-table">
305 <caption>Public Methods</caption>
307 <th class="sig-header" colspan="2">Method</th>
308 <th class="msource-header">Defined By</th>
318 <tr class="method-row config-row-alt0 expandable notInherited">
319 <td class="micon"><a class="exi" href="#expand"> </a></td>
323 <a id="Roo.state-method-CookieProvider" name=".CookieProvider"></a>
324 <div class="fixedFont">
325 <span class="attributes">new <B>Roo.state.</B></span><b class="itemname">CookieProvider</b>
327 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
335 <div class="short">Create a new Roo.state.CookieProvider</div>
342 Create a new Roo.state.CookieProvider
345 <dl class="detailList">
346 <dt class="heading">Parameters:</dt>
349 <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>
352 <dd>The configuration object</dd>
376 <tr class="method-row config-row-alt1 expandable">
377 <td class="micon"><a class="exi" href="#expand"> </a></td>
381 <a id="Roo.state.Provider-method-clear" name=".clear"></a>
382 <div class="fixedFont">
383 <span class="attributes"></span><b class="itemname">clear</b>
385 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
392 <div class="short">Clears a value from the state</div>
398 Clears a value from the state
405 <dl class="detailList">
406 <dt class="heading">Parameters:</dt>
409 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
412 <dd>The key name</dd>
432 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
438 <tr class="method-row config-row-alt0 expandable">
439 <td class="micon"><a class="exi" href="#expand"> </a></td>
443 <a id="Roo.state.Provider-method-decodeValue" name=".decodeValue"></a>
444 <div class="fixedFont">
445 <span class="attributes"></span><b class="itemname">decodeValue</b>
447 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
462 <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
468 Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
475 <dl class="detailList">
476 <dt class="heading">Parameters:</dt>
479 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
482 <dd>The value to decode</dd>
490 <dl class="detailList">
491 <dt class="heading">Returns:</dt>
493 <dd><span class="fixedFont">Mixed</span> The decoded value</dd>
509 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
515 <tr class="method-row config-row-alt1 expandable">
516 <td class="micon"><a class="exi" href="#expand"> </a></td>
520 <a id="Roo.state.Provider-method-encodeValue" name=".encodeValue"></a>
521 <div class="fixedFont">
522 <span class="attributes"></span><b class="itemname">encodeValue</b>
524 (Mixed <B><i>value</i></B>)
530 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
539 <div class="short">Encodes a value including type information.</div>
545 Encodes a value including type information. Decode with {<b>link</b> <b>decodeValue</b>}.
552 <dl class="detailList">
553 <dt class="heading">Parameters:</dt>
556 <span class="fixedFont">Mixed</span> <b>value</b>
559 <dd>The value to encode</dd>
567 <dl class="detailList">
568 <dt class="heading">Returns:</dt>
570 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The encoded value</dd>
586 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
592 <tr class="method-row config-row-alt0 expandable">
593 <td class="micon"><a class="exi" href="#expand"> </a></td>
597 <a id="Roo.state.Provider-method-get" name=".get"></a>
598 <div class="fixedFont">
599 <span class="attributes"></span><b class="itemname">get</b>
601 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
616 <div class="short">Returns the current value for a key</div>
622 Returns the current value for a key
629 <dl class="detailList">
630 <dt class="heading">Parameters:</dt>
633 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
636 <dd>The key name</dd>
639 <span class="fixedFont">Mixed</span> <b>defaultValue</b>
642 <dd>A default value to return if the key's value is not found</dd>
650 <dl class="detailList">
651 <dt class="heading">Returns:</dt>
653 <dd><span class="fixedFont">Mixed</span> The state data</dd>
669 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
675 <tr class="method-row config-row-alt1 expandable">
676 <td class="micon"><a class="exi" href="#expand"> </a></td>
680 <a id="Roo.state.Provider-method-set" name=".set"></a>
681 <div class="fixedFont">
682 <span class="attributes"></span><b class="itemname">set</b>
684 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
691 <div class="short">Sets the value for a key</div>
697 Sets the value for a key
704 <dl class="detailList">
705 <dt class="heading">Parameters:</dt>
708 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
711 <dd>The key name</dd>
714 <span class="fixedFont">Mixed</span> <b>value</b>
717 <dd>The value to set</dd>
737 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
746 <!-- ============================== events summary / details ======================== -->
749 <a id="Roo.state.CookieProvider-events"></a>
758 <table cellspacing="0" class="member-table">
759 <caption>Events</caption>
762 <th class="sig-header" colspan="2">Event</th>
763 <th class="msource-header">Defined By</th>
772 <tr class="method-row expandable config-row-alt0">
773 <td class="micon"><a class="exi" href="#expand"> </a></td>
776 <a id="Roo.state.Provider-event-*statechange"></a>
778 <div class="fixedFont">
779 <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>)
785 <div class="short">Fires when a state change occurs.
791 Fires when a state change occurs.
797 <dl class="detailList">
798 <dt class="heading">Parameters:</dt>
801 <span class="fixedFont">Provider</span> <b>this</b>
804 <dd>This state provider</dd>
807 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
810 <dd>The state key which was changed</dd>
813 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
816 <dd>The encoded value for the state</dd>
835 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
846 <!-- ============================== footer ================================= -->
847 <div class="fineprint" style="clear:both">
849 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Sep 09 2016 14:38:14 GMT+0800 (HKT)
851 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>