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>
143 <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>
151 Roo.state.CookieProvider
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.state.CookieProvider-cfg-expires" name=".expires"></a>
162 <div class="fixedFont">
163 <b class="itemname">expires</b> : <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a>
169 <div class="short">The cookie expiration date (defaults to 7 days from now)</div>
173 <div class="long">The cookie expiration date (defaults to 7 days from now)</div>
181 Roo.state.CookieProvider
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.state.CookieProvider-cfg-path" name=".path"></a>
192 <div class="fixedFont">
193 <b class="itemname">path</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
199 <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>
203 <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>
211 Roo.state.CookieProvider
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.state.CookieProvider-cfg-secure" name=".secure"></a>
222 <div class="fixedFont">
223 <b class="itemname">secure</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
229 <div class="short">True if the site is using SSL (defaults to false)</div>
233 <div class="long">True if the site is using SSL (defaults to false)</div>
241 Roo.state.CookieProvider
257 <!-- ============================== public properties ==================== -->
261 <a id="Roo.state.CookieProvider-props"></a>
267 <table cellspacing="0" class="member-table">
268 <caption class="Empty">Public Properties - Has None</caption>
274 <!-- ============================== methods summary / details ======================== -->
277 <a id="Roo.state.CookieProvider-methods"></a>
278 <!-- constructor?? -->
285 <!-- then dynamics first -->
292 <table cellspacing="0" class="member-table">
293 <caption>Public Methods</caption>
295 <th class="sig-header" colspan="2">Method</th>
296 <th class="msource-header">Defined By</th>
306 <tr class="method-row config-row-alt0 expandable notInherited">
307 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.state-method-CookieProvider" name=".CookieProvider"></a>
312 <div class="fixedFont">
313 <span class="attributes">new <B>Roo.state.</B></span><b class="itemname">CookieProvider</b>
315 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
323 <div class="short">Create a new Roo.state.CookieProvider</div>
330 Create a new Roo.state.CookieProvider
333 <dl class="detailList">
334 <dt class="heading">Parameters:</dt>
337 <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>
340 <dd>The configuration object</dd>
364 <tr class="method-row config-row-alt1 expandable">
365 <td class="micon"><a class="exi" href="#expand"> </a></td>
369 <a id="Roo.state.Provider-method-clear" name=".clear"></a>
370 <div class="fixedFont">
371 <span class="attributes"></span><b class="itemname">clear</b>
373 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
380 <div class="short">Clears a value from the state</div>
386 Clears a value from the state
393 <dl class="detailList">
394 <dt class="heading">Parameters:</dt>
397 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
400 <dd>The key name</dd>
420 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
426 <tr class="method-row config-row-alt0 expandable">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.state.Provider-method-decodeValue" name=".decodeValue"></a>
432 <div class="fixedFont">
433 <span class="attributes"></span><b class="itemname">decodeValue</b>
435 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
450 <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
456 Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
463 <dl class="detailList">
464 <dt class="heading">Parameters:</dt>
467 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
470 <dd>The value to decode</dd>
478 <dl class="detailList">
479 <dt class="heading">Returns:</dt>
481 <dd><span class="fixedFont">Mixed</span> The decoded value</dd>
497 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
503 <tr class="method-row config-row-alt1 expandable">
504 <td class="micon"><a class="exi" href="#expand"> </a></td>
508 <a id="Roo.state.Provider-method-encodeValue" name=".encodeValue"></a>
509 <div class="fixedFont">
510 <span class="attributes"></span><b class="itemname">encodeValue</b>
512 (Mixed <B><i>value</i></B>)
518 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
527 <div class="short">Encodes a value including type information.</div>
533 Encodes a value including type information. Decode with {<b>link</b> <b>decodeValue</b>}.
540 <dl class="detailList">
541 <dt class="heading">Parameters:</dt>
544 <span class="fixedFont">Mixed</span> <b>value</b>
547 <dd>The value to encode</dd>
555 <dl class="detailList">
556 <dt class="heading">Returns:</dt>
558 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The encoded value</dd>
574 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
580 <tr class="method-row config-row-alt0 expandable">
581 <td class="micon"><a class="exi" href="#expand"> </a></td>
585 <a id="Roo.state.Provider-method-get" name=".get"></a>
586 <div class="fixedFont">
587 <span class="attributes"></span><b class="itemname">get</b>
589 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
604 <div class="short">Returns the current value for a key</div>
610 Returns the current value for a key
617 <dl class="detailList">
618 <dt class="heading">Parameters:</dt>
621 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
624 <dd>The key name</dd>
627 <span class="fixedFont">Mixed</span> <b>defaultValue</b>
630 <dd>A default value to return if the key's value is not found</dd>
638 <dl class="detailList">
639 <dt class="heading">Returns:</dt>
641 <dd><span class="fixedFont">Mixed</span> The state data</dd>
657 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
663 <tr class="method-row config-row-alt1 expandable">
664 <td class="micon"><a class="exi" href="#expand"> </a></td>
668 <a id="Roo.state.Provider-method-set" name=".set"></a>
669 <div class="fixedFont">
670 <span class="attributes"></span><b class="itemname">set</b>
672 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
679 <div class="short">Sets the value for a key</div>
685 Sets the value for a key
692 <dl class="detailList">
693 <dt class="heading">Parameters:</dt>
696 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
699 <dd>The key name</dd>
702 <span class="fixedFont">Mixed</span> <b>value</b>
705 <dd>The value to set</dd>
725 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
734 <!-- ============================== events summary / details ======================== -->
737 <a id="Roo.state.CookieProvider-events"></a>
746 <table cellspacing="0" class="member-table">
747 <caption>Events</caption>
750 <th class="sig-header" colspan="2">Event</th>
751 <th class="msource-header">Defined By</th>
760 <tr class="method-row expandable config-row-alt0">
761 <td class="micon"><a class="exi" href="#expand"> </a></td>
764 <a id="Roo.state.Provider-event-*statechange"></a>
766 <div class="fixedFont">
767 <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>)
773 <div class="short">Fires when a state change occurs.
779 Fires when a state change occurs.
785 <dl class="detailList">
786 <dt class="heading">Parameters:</dt>
789 <span class="fixedFont">Provider</span> <b>this</b>
792 <dd>This state provider</dd>
795 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
798 <dd>The state key which was changed</dd>
801 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
804 <dd>The encoded value for the state</dd>
823 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
834 <!-- ============================== footer ================================= -->
835 <div class="fineprint" style="clear:both">
837 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Apr 08 2014 15:05:41 GMT+0800 (HKT)
839 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>