Subversion Repositories eFlore/Applications.cel

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 aperonnet 1 
        <div class="body-wrap">
2 
        <div class="top-tools">
3 
            <a class="inner-link" href="#Ext.state.CookieProvider-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 
            <a class="inner-link" href="#Ext.state.CookieProvider-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 
            <a class="inner-link" href="#Ext.state.CookieProvider-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 
                            <a class="inner-link" href="#Ext.state.CookieProvider-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 
                        <a class="bookmark" href="../docs/?class=Ext.state.CookieProvider"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8 
        </div>
9 
                <div class="inheritance res-block">
10 
<pre class="res-block-inner"><a ext:cls="Ext.state.Provider" ext:member="" href="output/Ext.state.Provider.html">Provider</a>
11 
  <img src="resources/elbow-end.gif"/>CookieProvider</pre></div>
12 
                <h1>Class Ext.state.CookieProvider</h1>
13 
        <table cellspacing="0">
14 
            <tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr>
15 
            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/state/CookieProvider.js" target="_blank">CookieProvider.js</a></td></tr>
16 
            <tr><td class="label">Class:</td><td class="hd-info">CookieProvider</td></tr>
17 
                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.state.Provider" ext:member="" href="output/Ext.state.Provider.html">Provider</a></td></tr>
18 
                    </table>
19 
        <div class="description">
20 
            The default Provider implementation which saves state via cookies.
21 
<br />Usage:
22 
 <pre><code>var cp = <b>new</b> Ext.state.CookieProvider({
23 
       path: <em>"/cgi-bin/"</em>,
24 
       expires: <b>new</b> Date(<b>new</b> Date().getTime()+(1000*60*60*24*30)), <i>//30 days</i>
25 
       domain: <em>"extjs.com"</em>
26 
   });
27 
   Ext.state.Manager.setProvider(cp);</code></pre>        </div>
28 
 
29 
        <div class="hr"></div>
30 
                <a id="Ext.state.CookieProvider-configs"></a>
31 
        <h2>Config Options</h2>
32 
        <table cellspacing="0" class="member-table">
33 
            <tr>
34 
                <th class="sig-header" colspan="2">Config Options</th>
35 
                <th class="msource-header">Defined By</th>
36 
            </tr>
37 
                <tr class="config-row expandable">
38 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
39 
        <td class="sig">
40 
        <a id="Ext.state.CookieProvider-domain"></a>
41 
            <b>domain</b> : String            <div class="mdesc">
42 
                        <div class="short">The domain to save the cookie for. Note that you cannot specify a different domain than your page is on, but you can ...</div>
43 
            <div class="long">
44 
                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>
45 
                        </div>
46 
        </td>
47 
        <td class="msource">CookieProvider</td>
48 
    </tr>
49 
        <tr class="config-row alt">
50 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
51 
        <td class="sig">
52 
        <a id="Ext.state.CookieProvider-expires"></a>
53 
            <b>expires</b> : Date            <div class="mdesc">
54 
                            The cookie expiration date (defaults to 7 days from now)                        </div>
55 
        </td>
56 
        <td class="msource">CookieProvider</td>
57 
    </tr>
58 
        <tr class="config-row">
59 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
60 
        <td class="sig">
61 
        <a id="Ext.state.CookieProvider-path"></a>
62 
            <b>path</b> : String            <div class="mdesc">
63 
                            The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)                        </div>
64 
        </td>
65 
        <td class="msource">CookieProvider</td>
66 
    </tr>
67 
        <tr class="config-row alt">
68 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
69 
        <td class="sig">
70 
        <a id="Ext.state.CookieProvider-secure"></a>
71 
            <b>secure</b> : Boolean            <div class="mdesc">
72 
                            True if the site is using SSL (defaults to false)                        </div>
73 
        </td>
74 
        <td class="msource">CookieProvider</td>
75 
    </tr>
76 
            </table>
77 
                <a id="Ext.state.CookieProvider-props"></a>
78 
        <h2>Public Properties</h2>
79 
        <div class="no-members">This class has no public properties.</div>        <a id="Ext.state.CookieProvider-methods"></a>
80 
        <h2>Public Methods</h2>
81 
                <table cellspacing="0" class="member-table">
82 
            <tr>
83 
                <th class="sig-header" colspan="2">Method</th>
84 
                <th class="msource-header">Defined By</th>
85 
            </tr>
86 
                <tr class="method-row expandable">
87 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
88 
        <td class="sig">
89 
        <a id="Ext.state.CookieProvider-CookieProvider"></a>
90 
            <b>CookieProvider</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">
91 
                        <div class="short">Create a new CookieProvider</div>
92 
            <div class="long">
93 
                Create a new CookieProvider    <div class="mdetail-params">
94 
        <strong>Parameters:</strong>
95 
        <ul><li><code>config</code> : Object<div class="sub-desc">The configuration object</div></li>        </ul>
96 
        <strong>Returns:</strong>
97 
        <ul>
98 
            <li><code></code></li>
99 
        </ul>
100 
    </div>
101 
                </div>
102 
                        </div>
103 
        </td>
104 
        <td class="msource">CookieProvider</td>
105 
    </tr>
106 
        <tr class="method-row inherited alt expandable">
107 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
108 
        <td class="sig">
109 
        <a id="Ext.state.CookieProvider-clear"></a>
110 
            <b>clear</b>(&nbsp;<code>String name</code>&nbsp;) : void            <div class="mdesc">
111 
                        <div class="short">Clears a value from the state</div>
112 
            <div class="long">
113 
                Clears a value from the state    <div class="mdetail-params">
114 
        <strong>Parameters:</strong>
115 
        <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li>        </ul>
116 
        <strong>Returns:</strong>
117 
        <ul>
118 
            <li><code>void</code></li>
119 
        </ul>
120 
    </div>
121 
                </div>
122 
                        </div>
123 
        </td>
124 
        <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#clear" href="output/Ext.state.Provider.html#clear">Provider</a></td>
125 
    </tr>
126 
        <tr class="method-row inherited expandable">
127 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
128 
        <td class="sig">
129 
        <a id="Ext.state.CookieProvider-decodeValue"></a>
130 
            <b>decodeValue</b>(&nbsp;<code>String value</code>&nbsp;) : Mixed            <div class="mdesc">
131 
                        <div class="short">Decodes a string previously encoded with <a ext:cls="Ext.state.Provider" ext:member="encodeValue" href="output/Ext.state.Provider.html#encodeValue">encodeValue</a>.</div>
132 
            <div class="long">
133 
                Decodes a string previously encoded with <a ext:cls="Ext.state.Provider" ext:member="encodeValue" href="output/Ext.state.Provider.html#encodeValue">encodeValue</a>.    <div class="mdetail-params">
134 
        <strong>Parameters:</strong>
135 
        <ul><li><code>value</code> : String<div class="sub-desc">The value to decode</div></li>        </ul>
136 
        <strong>Returns:</strong>
137 
        <ul>
138 
            <li><code>Mixed</code><div class="sub-desc">The decoded value</div></li>
139 
        </ul>
140 
    </div>
141 
                </div>
142 
                        </div>
143 
        </td>
144 
        <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#decodeValue" href="output/Ext.state.Provider.html#decodeValue">Provider</a></td>
145 
    </tr>
146 
        <tr class="method-row inherited alt expandable">
147 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
148 
        <td class="sig">
149 
        <a id="Ext.state.CookieProvider-encodeValue"></a>
150 
            <b>encodeValue</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">
151 
                        <div class="short">Encodes a value including type information.  Decode with <a ext:cls="Ext.state.Provider" ext:member="decodeValue" href="output/Ext.state.Provider.html#decodeValue">decodeValue</a>.</div>
152 
            <div class="long">
153 
                Encodes a value including type information.  Decode with <a ext:cls="Ext.state.Provider" ext:member="decodeValue" href="output/Ext.state.Provider.html#decodeValue">decodeValue</a>.    <div class="mdetail-params">
154 
        <strong>Parameters:</strong>
155 
        <ul><li><code>value</code> : Mixed<div class="sub-desc">The value to encode</div></li>        </ul>
156 
        <strong>Returns:</strong>
157 
        <ul>
158 
            <li><code>String</code><div class="sub-desc">The encoded value</div></li>
159 
        </ul>
160 
    </div>
161 
                </div>
162 
                        </div>
163 
        </td>
164 
        <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#encodeValue" href="output/Ext.state.Provider.html#encodeValue">Provider</a></td>
165 
    </tr>
166 
        <tr class="method-row inherited expandable">
167 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
168 
        <td class="sig">
169 
        <a id="Ext.state.CookieProvider-get"></a>
170 
            <b>get</b>(&nbsp;<code>String name</code>, <code>Mixed defaultValue</code>&nbsp;) : Mixed            <div class="mdesc">
171 
                        <div class="short">Returns the current value for a key</div>
172 
            <div class="long">
173 
                Returns the current value for a key    <div class="mdetail-params">
174 
        <strong>Parameters:</strong>
175 
        <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li><li><code>defaultValue</code> : Mixed<div class="sub-desc">A default value to return if the key's value is not found</div></li>        </ul>
176 
        <strong>Returns:</strong>
177 
        <ul>
178 
            <li><code>Mixed</code><div class="sub-desc">The state data</div></li>
179 
        </ul>
180 
    </div>
181 
                </div>
182 
                        </div>
183 
        </td>
184 
        <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#get" href="output/Ext.state.Provider.html#get">Provider</a></td>
185 
    </tr>
186 
        <tr class="method-row inherited alt expandable">
187 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
188 
        <td class="sig">
189 
        <a id="Ext.state.CookieProvider-set"></a>
190 
            <b>set</b>(&nbsp;<code>String name</code>, <code>Mixed value</code>&nbsp;) : void            <div class="mdesc">
191 
                        <div class="short">Sets the value for a key</div>
192 
            <div class="long">
193 
                Sets the value for a key    <div class="mdetail-params">
194 
        <strong>Parameters:</strong>
195 
        <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The value to set</div></li>        </ul>
196 
        <strong>Returns:</strong>
197 
        <ul>
198 
            <li><code>void</code></li>
199 
        </ul>
200 
    </div>
201 
                </div>
202 
                        </div>
203 
        </td>
204 
        <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#set" href="output/Ext.state.Provider.html#set">Provider</a></td>
205 
    </tr>
206 
            </table>
207 
                <a id="Ext.state.CookieProvider-events"></a>
208 
        <h2>Public Events</h2>
209 
                <table cellspacing="0" class="member-table">
210 
            <tr>
211 
                <th class="sig-header" colspan="2">Event</th>
212 
                <th class="msource-header">Defined By</th>
213 
            </tr>
214 
                <tr class="event-row inherited expandable">
215 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
216 
        <td class="sig">
217 
        <a id="Ext.state.CookieProvider-statechange"></a>
218 
            <b>statechange</b> : (&nbsp;<code>Provider this</code>, <code>String key</code>, <code>String value</code>&nbsp;)            <div class="mdesc">
219 
                        <div class="short">Fires when a state change occurs.</div>
220 
            <div class="long">
221 
                Fires when a state change occurs.    <div class="mdetail-params">
222 
        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
223 
        <ul><li><code>this</code> : Provider<div class="sub-desc">This state provider</div></li><li><code>key</code> : String<div class="sub-desc">The state key which was changed</div></li><li><code>value</code> : String<div class="sub-desc">The encoded value for the state</div></li>        </ul>
224 
    </div>
225 
                </div>
226 
                        </div>
227 
        </td>
228 
        <td class="msource"><a ext:cls="Ext.state.Provider" ext:member="#event-statechange" href="output/Ext.state.Provider.html#event-statechange">Provider</a></td>
229 
    </tr>
230 
            </table>
231 
 
232 
        </div>