git.roojs.org Git - roojs1/blob - docs.old/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">
 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')
 145
 146                 </div>
 147                         </div>
 148
 149
 150
 151                     </td>
 152                     <td class="msource">
 153
 154                         Roo.state.CookieProvider
 155
 156                     </td>
 157                 </tr>
 158
 159
 160                 <tr class="config-row expandable config-row-alt1 notInherited">
 161                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 162                     <td class="sig">
 163
 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>
 167
 168
 169                         </div>
 170
 171                         <div class="mdesc">
 172                             <div class="short">The cookie expiration date (defaults to 7 days from now)</div>
 173                         </div>
 174
 175                         <div class="mdesc">
 176                             <div class="long">
 177                     The cookie expiration date (defaults to 7 days from now)
 178
 179                 </div>
 180                         </div>
 181
 182
 183
 184                     </td>
 185                     <td class="msource">
 186
 187                         Roo.state.CookieProvider
 188
 189                     </td>
 190                 </tr>
 191
 192
 193                 <tr class="config-row expandable config-row-alt0 notInherited">
 194                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 195                     <td class="sig">
 196
 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>
 200
 201
 202                         </div>
 203
 204                         <div class="mdesc">
 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>
 206                         </div>
 207
 208                         <div class="mdesc">
 209                             <div class="long">
 210                     The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)
 211
 212                 </div>
 213                         </div>
 214
 215
 216
 217                     </td>
 218                     <td class="msource">
 219
 220                         Roo.state.CookieProvider
 221
 222                     </td>
 223                 </tr>
 224
 225
 226                 <tr class="config-row expandable config-row-alt1 notInherited">
 227                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 228                     <td class="sig">
 229
 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>
 233
 234
 235                         </div>
 236
 237                         <div class="mdesc">
 238                             <div class="short">True if the site is using SSL (defaults to false)</div>
 239                         </div>
 240
 241                         <div class="mdesc">
 242                             <div class="long">
 243                     True if the site is using SSL (defaults to false)
 244
 245                 </div>
 246                         </div>
 247
 248
 249
 250                     </td>
 251                     <td class="msource">
 252
 253                         Roo.state.CookieProvider
 254
 255                     </td>
 256                 </tr>
 257
 258
 259     </table>
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269   <!-- ============================== public properties ==================== -->
 270
 271
 272
 273     <a id="Roo.state.CookieProvider-props"></a>
 274
 275
 276
 277
 278
 279      <table cellspacing="0" class="member-table">
 280       <caption class="Empty">Public Properties - Has None</caption>
 281      </table>
 282
 283
 284
 285
 286   <!-- ============================== methods summary / details ======================== -->
 287
 288
 289   <a id="Roo.state.CookieProvider-methods"></a>
 290         <!-- constructor?? -->
 291
 292         <!-- static's first
 293
 294
 295         -->
 296
 297         <!-- then dynamics first -->
 298
 299
 300
 301
 302
 303
 304       <table cellspacing="0" class="member-table">
 305       <caption>Public Methods</caption>
 306         <tr>
 307             <th class="sig-header" colspan="2">Method</th>
 308             <th class="msource-header">Defined By</th>
 309
 310         </tr>
 311
 312
 313
 314
 315
 316
 317
 318           <tr class="method-row config-row-alt0 expandable notInherited">
 319             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 320
 321
 322             <td class="sig">
 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>
 326
 327                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 328
 329
 330
 331                 </div>
 332                 <div class="mdesc">
 333
 334
 335                         <div class="short">Create a new Roo.state.CookieProvider</div>
 336
 337
 338                     <div class="long">
 339
 340
 341
 342                                 Create a new Roo.state.CookieProvider
 343
 344
 345                                 <dl class="detailList">
 346                                 <dt class="heading">Parameters:</dt>
 347
 348                                         <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>
 350
 351                                         </dt>
 352                                         <dd>The configuration object</dd>
 353
 354                                 </dl>
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366                     </div>
 367                 </div>
 368
 369             </td>
 370             <td class="msource">
 371                 &nbsp;
 372             </td>
 373         </tr>
 374
 375
 376           <tr class="method-row config-row-alt1 expandable">
 377             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 378
 379
 380             <td class="sig">
 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>
 384
 385                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
 386
 387
 388
 389                 </div>
 390                 <div class="mdesc">
 391
 392                    <div class="short">Clears a value from the state</div>
 393
 394
 395
 396                     <div class="long">
 397
 398                                 Clears a value from the state
 399
 400
 401
 402
 403
 404
 405                                 <dl class="detailList">
 406                                 <dt class="heading">Parameters:</dt>
 407
 408                                         <dt>
 409                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 410
 411                                         </dt>
 412                                         <dd>The key name</dd>
 413
 414                                 </dl>
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426                     </div>
 427                 </div>
 428
 429             </td>
 430             <td class="msource">
 431
 432                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 433                 &nbsp;
 434             </td>
 435         </tr>
 436
 437
 438           <tr class="method-row config-row-alt0 expandable">
 439             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 440
 441
 442             <td class="sig">
 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>
 446
 447                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 448
 449
 450                                          :
 451
 452
 453                                                 Mixed
 454
 455
 456
 457
 458
 459                 </div>
 460                 <div class="mdesc">
 461
 462                    <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
 463
 464
 465
 466                     <div class="long">
 467
 468                                 Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
 469
 470
 471
 472
 473
 474
 475                                 <dl class="detailList">
 476                                 <dt class="heading">Parameters:</dt>
 477
 478                                         <dt>
 479                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 480
 481                                         </dt>
 482                                         <dd>The value to decode</dd>
 483
 484                                 </dl>
 485
 486
 487
 488
 489
 490                                 <dl class="detailList">
 491                                 <dt class="heading">Returns:</dt>
 492
 493                                         <dd><span class="fixedFont">Mixed</span>  The decoded value</dd>
 494
 495                                 </dl>
 496
 497
 498
 499
 500
 501
 502
 503                     </div>
 504                 </div>
 505
 506             </td>
 507             <td class="msource">
 508
 509                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 510                 &nbsp;
 511             </td>
 512         </tr>
 513
 514
 515           <tr class="method-row config-row-alt1 expandable">
 516             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 517
 518
 519             <td class="sig">
 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>
 523
 524                                  (Mixed <B><i>value</i></B>)
 525
 526
 527                                          :
 528
 529
 530                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 531
 532
 533
 534
 535
 536                 </div>
 537                 <div class="mdesc">
 538
 539                    <div class="short">Encodes a value including type information.</div>
 540
 541
 542
 543                     <div class="long">
 544
 545                                 Encodes a value including type information.  Decode with {<b>link</b> <b>decodeValue</b>}.
 546
 547
 548
 549
 550
 551
 552                                 <dl class="detailList">
 553                                 <dt class="heading">Parameters:</dt>
 554
 555                                         <dt>
 556                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 557
 558                                         </dt>
 559                                         <dd>The value to encode</dd>
 560
 561                                 </dl>
 562
 563
 564
 565
 566
 567                                 <dl class="detailList">
 568                                 <dt class="heading">Returns:</dt>
 569
 570                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The encoded value</dd>
 571
 572                                 </dl>
 573
 574
 575
 576
 577
 578
 579
 580                     </div>
 581                 </div>
 582
 583             </td>
 584             <td class="msource">
 585
 586                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 587                 &nbsp;
 588             </td>
 589         </tr>
 590
 591
 592           <tr class="method-row config-row-alt0 expandable">
 593             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 594
 595
 596             <td class="sig">
 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>
 600
 601                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
 602
 603
 604                                          :
 605
 606
 607                                                 Mixed
 608
 609
 610
 611
 612
 613                 </div>
 614                 <div class="mdesc">
 615
 616                    <div class="short">Returns the current value for a key</div>
 617
 618
 619
 620                     <div class="long">
 621
 622                                 Returns the current value for a key
 623
 624
 625
 626
 627
 628
 629                                 <dl class="detailList">
 630                                 <dt class="heading">Parameters:</dt>
 631
 632                                         <dt>
 633                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 634
 635                                         </dt>
 636                                         <dd>The key name</dd>
 637
 638                                         <dt>
 639                                                 <span class="fixedFont">Mixed</span>  <b>defaultValue</b>
 640
 641                                         </dt>
 642                                         <dd>A default value to return if the key's value is not found</dd>
 643
 644                                 </dl>
 645
 646
 647
 648
 649
 650                                 <dl class="detailList">
 651                                 <dt class="heading">Returns:</dt>
 652
 653                                         <dd><span class="fixedFont">Mixed</span>  The state data</dd>
 654
 655                                 </dl>
 656
 657
 658
 659
 660
 661
 662
 663                     </div>
 664                 </div>
 665
 666             </td>
 667             <td class="msource">
 668
 669                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 670                 &nbsp;
 671             </td>
 672         </tr>
 673
 674
 675           <tr class="method-row config-row-alt1 expandable">
 676             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 677
 678
 679             <td class="sig">
 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>
 683
 684                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
 685
 686
 687
 688                 </div>
 689                 <div class="mdesc">
 690
 691                    <div class="short">Sets the value for a key</div>
 692
 693
 694
 695                     <div class="long">
 696
 697                                 Sets the value for a key
 698
 699
 700
 701
 702
 703
 704                                 <dl class="detailList">
 705                                 <dt class="heading">Parameters:</dt>
 706
 707                                         <dt>
 708                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 709
 710                                         </dt>
 711                                         <dd>The key name</dd>
 712
 713                                         <dt>
 714                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 715
 716                                         </dt>
 717                                         <dd>The value to set</dd>
 718
 719                                 </dl>
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731                     </div>
 732                 </div>
 733
 734             </td>
 735             <td class="msource">
 736
 737                         <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 738                 &nbsp;
 739             </td>
 740         </tr>
 741
 742
 743     </table>
 744
 745
 746   <!-- ============================== events summary / details ======================== -->
 747
 748
 749   <a id="Roo.state.CookieProvider-events"></a>
 750
 751
 752
 753
 754
 755
 756
 757
 758       <table cellspacing="0" class="member-table">
 759                 <caption>Events</caption>
 760               <thead>
 761                 <tr>
 762                     <th class="sig-header" colspan="2">Event</th>
 763                     <th class="msource-header">Defined By</th>
 764
 765                 </tr>
 766               </thead>
 767
 768
 769
 770
 771
 772           <tr class="method-row expandable config-row-alt0">
 773             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 774
 775             <td class="sig">
 776                 <a id="Roo.state.Provider-event-*statechange"></a>
 777
 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>)
 780
 781                 </div>
 782
 783                 <div class="mdesc">
 784
 785                    <div class="short">Fires when a state change occurs.
 786
 787                 </div>
 788
 789                     <div class="long">
 790
 791                         Fires when a state change occurs.
 792
 793
 794
 795
 796
 797                                 <dl class="detailList">
 798                                 <dt class="heading">Parameters:</dt>
 799
 800                                         <dt>
 801                                                 <span class="fixedFont">Provider</span> <b>this</b>
 802
 803                                         </dt>
 804                                         <dd>This state provider</dd>
 805
 806                                         <dt>
 807                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
 808
 809                                         </dt>
 810                                         <dd>The state key which was changed</dd>
 811
 812                                         <dt>
 813                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
 814
 815                                         </dt>
 816                                         <dd>The encoded value for the state</dd>
 817
 818                                 </dl>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830                     </div>
 831                 </div>
 832
 833             </td>
 834             <td class="msource">
 835                 <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
 836             </td>
 837         </tr>
 838
 839
 840     </table>
 841
 842
 843
 844
 845
 846 <!-- ============================== footer ================================= -->
 847                 <div class="fineprint" style="clear:both">
 848
 849                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT)
 850                         Based on
 851                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 852                 </div>
 853         </body>
 854 </html>