git.roojs.org Git - roojs1/blob - docs/symbols/Roo.state.CookieProvider.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.state.CookieProvider</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  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
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.state.CookieProvider
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.state</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_state_CookieProvider.js.html">Roo/state/CookieProvider.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">CookieProvider</td></tr>
  70
  71
  72
  73
  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>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  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>
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  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>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.state" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.state.CookieProvider.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.state.CookieProvider-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 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>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">The domain to save the cookie for.</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 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>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.state.CookieProvider
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 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>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">The cookie expiration date (defaults to 7 days from now)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">The cookie expiration date (defaults to 7 days from now)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.state.CookieProvider
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 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>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 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>
 200                         </div>
 201
 202                         <div class="mdesc">
 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>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.state.CookieProvider
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 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>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">True if the site is using SSL (defaults to false)</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">True if the site is using SSL (defaults to false)</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.state.CookieProvider
 242
 243                     </td>
 244                 </tr>
 245
 246
 247     </table>
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257   <!-- ============================== public properties ==================== -->
 258
 259
 260
 261     <a id="Roo.state.CookieProvider-props"></a>
 262
 263
 264
 265
 266
 267      <table cellspacing="0" class="member-table">
 268       <caption class="Empty">Public Properties - Has None</caption>
 269      </table>
 270
 271
 272
 273
 274   <!-- ============================== methods summary / details ======================== -->
 275
 276
 277   <a id="Roo.state.CookieProvider-methods"></a>
 278         <!-- constructor?? -->
 279
 280         <!-- static's first
 281
 282
 283         -->
 284
 285         <!-- then dynamics first -->
 286
 287
 288
 289
 290
 291
 292       <table cellspacing="0" class="member-table">
 293       <caption>Public Methods</caption>
 294         <tr>
 295             <th class="sig-header" colspan="2">Method</th>
 296             <th class="msource-header">Defined By</th>
 297
 298         </tr>
 299
 300
 301
 302
 303
 304
 305
 306           <tr class="method-row config-row-alt0 expandable notInherited">
 307             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 308
 309
 310             <td class="sig">
 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>
 314
 315                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 316
 317
 318
 319                 </div>
 320                 <div class="mdesc">
 321
 322
 323                         <div class="short">Create a new Roo.state.CookieProvider</div>
 324
 325
 326                     <div class="long">
 327
 328
 329
 330                                 Create a new Roo.state.CookieProvider
 331
 332
 333                                 <dl class="detailList">
 334                                 <dt class="heading">Parameters:</dt>
 335
 336                                         <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>
 338
 339                                         </dt>
 340                                         <dd>The configuration object</dd>
 341
 342                                 </dl>
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354                     </div>
 355                 </div>
 356
 357             </td>
 358             <td class="msource">
 359                 &nbsp;
 360             </td>
 361         </tr>
 362
 363
 364     </table>
 365
 366
 367   <!-- ============================== events summary / details ======================== -->
 368
 369
 370   <a id="Roo.state.CookieProvider-events"></a>
 371
 372
 373
 374
 375
 376      <table cellspacing="0" class="member-table">
 377       <caption class="Empty">Events - Has None</caption>
 378      </table>
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388 <!-- ============================== footer ================================= -->
 389                 <div class="fineprint" style="clear:both">
 390
 391                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:11:57 GMT+0800 (HKT)
 392                         Based on
 393                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 394                 </div>
 395         </body>
 396 </html>