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           <tr class="method-row config-row-alt1 expandable">
 365             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 366
 367
 368             <td class="sig">
 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>
 372
 373                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
 374
 375
 376
 377                 </div>
 378                 <div class="mdesc">
 379
 380                    <div class="short">Clears a value from the state</div>
 381
 382
 383
 384                     <div class="long">
 385
 386                                 Clears a value from the state
 387
 388
 389
 390
 391
 392
 393                                 <dl class="detailList">
 394                                 <dt class="heading">Parameters:</dt>
 395
 396                                         <dt>
 397                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 398
 399                                         </dt>
 400                                         <dd>The key name</dd>
 401
 402                                 </dl>
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414                     </div>
 415                 </div>
 416
 417             </td>
 418             <td class="msource">
 419
 420                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 421                 &nbsp;
 422             </td>
 423         </tr>
 424
 425
 426           <tr class="method-row config-row-alt0 expandable">
 427             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 428
 429
 430             <td class="sig">
 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>
 434
 435                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 436
 437
 438                                          :
 439
 440
 441                                                 Mixed
 442
 443
 444
 445
 446
 447                 </div>
 448                 <div class="mdesc">
 449
 450                    <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
 451
 452
 453
 454                     <div class="long">
 455
 456                                 Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
 457
 458
 459
 460
 461
 462
 463                                 <dl class="detailList">
 464                                 <dt class="heading">Parameters:</dt>
 465
 466                                         <dt>
 467                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 468
 469                                         </dt>
 470                                         <dd>The value to decode</dd>
 471
 472                                 </dl>
 473
 474
 475
 476
 477
 478                                 <dl class="detailList">
 479                                 <dt class="heading">Returns:</dt>
 480
 481                                         <dd><span class="fixedFont">Mixed</span>  The decoded value</dd>
 482
 483                                 </dl>
 484
 485
 486
 487
 488
 489
 490
 491                     </div>
 492                 </div>
 493
 494             </td>
 495             <td class="msource">
 496
 497                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 498                 &nbsp;
 499             </td>
 500         </tr>
 501
 502
 503           <tr class="method-row config-row-alt1 expandable">
 504             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 505
 506
 507             <td class="sig">
 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>
 511
 512                                  (Mixed <B><i>value</i></B>)
 513
 514
 515                                          :
 516
 517
 518                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 519
 520
 521
 522
 523
 524                 </div>
 525                 <div class="mdesc">
 526
 527                    <div class="short">Encodes a value including type information.</div>
 528
 529
 530
 531                     <div class="long">
 532
 533                                 Encodes a value including type information.  Decode with {<b>link</b> <b>decodeValue</b>}.
 534
 535
 536
 537
 538
 539
 540                                 <dl class="detailList">
 541                                 <dt class="heading">Parameters:</dt>
 542
 543                                         <dt>
 544                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 545
 546                                         </dt>
 547                                         <dd>The value to encode</dd>
 548
 549                                 </dl>
 550
 551
 552
 553
 554
 555                                 <dl class="detailList">
 556                                 <dt class="heading">Returns:</dt>
 557
 558                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The encoded value</dd>
 559
 560                                 </dl>
 561
 562
 563
 564
 565
 566
 567
 568                     </div>
 569                 </div>
 570
 571             </td>
 572             <td class="msource">
 573
 574                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 575                 &nbsp;
 576             </td>
 577         </tr>
 578
 579
 580           <tr class="method-row config-row-alt0 expandable">
 581             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 582
 583
 584             <td class="sig">
 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>
 588
 589                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
 590
 591
 592                                          :
 593
 594
 595                                                 Mixed
 596
 597
 598
 599
 600
 601                 </div>
 602                 <div class="mdesc">
 603
 604                    <div class="short">Returns the current value for a key</div>
 605
 606
 607
 608                     <div class="long">
 609
 610                                 Returns the current value for a key
 611
 612
 613
 614
 615
 616
 617                                 <dl class="detailList">
 618                                 <dt class="heading">Parameters:</dt>
 619
 620                                         <dt>
 621                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 622
 623                                         </dt>
 624                                         <dd>The key name</dd>
 625
 626                                         <dt>
 627                                                 <span class="fixedFont">Mixed</span>  <b>defaultValue</b>
 628
 629                                         </dt>
 630                                         <dd>A default value to return if the key's value is not found</dd>
 631
 632                                 </dl>
 633
 634
 635
 636
 637
 638                                 <dl class="detailList">
 639                                 <dt class="heading">Returns:</dt>
 640
 641                                         <dd><span class="fixedFont">Mixed</span>  The state data</dd>
 642
 643                                 </dl>
 644
 645
 646
 647
 648
 649
 650
 651                     </div>
 652                 </div>
 653
 654             </td>
 655             <td class="msource">
 656
 657                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 658                 &nbsp;
 659             </td>
 660         </tr>
 661
 662
 663           <tr class="method-row config-row-alt1 expandable">
 664             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 665
 666
 667             <td class="sig">
 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>
 671
 672                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
 673
 674
 675
 676                 </div>
 677                 <div class="mdesc">
 678
 679                    <div class="short">Sets the value for a key</div>
 680
 681
 682
 683                     <div class="long">
 684
 685                                 Sets the value for a key
 686
 687
 688
 689
 690
 691
 692                                 <dl class="detailList">
 693                                 <dt class="heading">Parameters:</dt>
 694
 695                                         <dt>
 696                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 697
 698                                         </dt>
 699                                         <dd>The key name</dd>
 700
 701                                         <dt>
 702                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 703
 704                                         </dt>
 705                                         <dd>The value to set</dd>
 706
 707                                 </dl>
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719                     </div>
 720                 </div>
 721
 722             </td>
 723             <td class="msource">
 724
 725                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 726                 &nbsp;
 727             </td>
 728         </tr>
 729
 730
 731     </table>
 732
 733
 734   <!-- ============================== events summary / details ======================== -->
 735
 736
 737   <a id="Roo.state.CookieProvider-events"></a>
 738
 739
 740
 741
 742
 743
 744
 745
 746       <table cellspacing="0" class="member-table">
 747                 <caption>Events</caption>
 748               <thead>
 749                 <tr>
 750                     <th class="sig-header" colspan="2">Event</th>
 751                     <th class="msource-header">Defined By</th>
 752
 753                 </tr>
 754               </thead>
 755
 756
 757
 758
 759
 760           <tr class="method-row expandable config-row-alt0">
 761             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 762
 763             <td class="sig">
 764                 <a id="Roo.state.Provider-event-*statechange"></a>
 765
 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>)
 768
 769                 </div>
 770
 771                 <div class="mdesc">
 772
 773                    <div class="short">Fires when a state change occurs.
 774
 775                 </div>
 776
 777                     <div class="long">
 778
 779                         Fires when a state change occurs.
 780
 781
 782
 783
 784
 785                                 <dl class="detailList">
 786                                 <dt class="heading">Parameters:</dt>
 787
 788                                         <dt>
 789                                                 <span class="fixedFont">Provider</span> <b>this</b>
 790
 791                                         </dt>
 792                                         <dd>This state provider</dd>
 793
 794                                         <dt>
 795                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
 796
 797                                         </dt>
 798                                         <dd>The state key which was changed</dd>
 799
 800                                         <dt>
 801                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
 802
 803                                         </dt>
 804                                         <dd>The encoded value for the state</dd>
 805
 806                                 </dl>
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818                     </div>
 819                 </div>
 820
 821             </td>
 822             <td class="msource">
 823                 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 824             </td>
 825         </tr>
 826
 827
 828     </table>
 829
 830
 831
 832
 833
 834 <!-- ============================== footer ================================= -->
 835                 <div class="fineprint" style="clear:both">
 836
 837                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
 838                         Based on
 839                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 840                 </div>
 841         </body>
 842 </html>