git.roojs.org Git - roojs1/blob - docs/symbols/Roo.state.Provider.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.Provider</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.Provider-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.state.Provider-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.state.Provider-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.state.Provider-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 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.state.Provider
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.state</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_state_Provider.js.html">Roo/state/Provider.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Provider</td></tr>
  63
  64
  65         <tr><td class="label">Subclasses:</td><td class="hd-info">
  66                 <a href="./Roo.state.CookieProvider.html#constructor" roo:cls="Roo.state.CookieProvider.html#constructor">Roo.state.CookieProvider</a>
  67
  68
  69
  70         </td></tr>
  71
  72
  73
  74     </table>
  75
  76
  77 <!-- ============================== class summary ========================== -->
  78     <div class="description">
  79         Abstract base class for state provider implementations. This class provides methods<br/>for encoding and decoding <b>typed</b> variables including dates and defines the <br/>Provider interface.
  80     </div>
  81
  82
  83 <!-- ============================== Class comment block... ========================== -->
  84
  85 <div class="comments">
  86         <b>Class Comments / Notes</B> =>
  87         <u onclick="parent.CommentDialog.showCommentId = 'Roo.state.Provider';">[Add Your comment/notes about this class]</u>
  88         <br/>
  89         <iframe frameborder="0"  id="comments-Roo.state" style="border: none;width:100%;"
  90                 src="/blog.php/GtkDjsComments/Roo.state.Provider.html"></iframe>
  91 </div>
  92
  93
  94
  95 <!-- ============================== config options ========================== -->
  96
  97
  98
  99
 100     <div class="hr"></div>
 101     <a id="Roo.state.Provider-configs"></a>
 102
 103
 104
 105      <table cellspacing="0" class="member-table">
 106       <caption class="Empty">Config Options - Has None</caption>
 107      </table>
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120   <!-- ============================== public properties ==================== -->
 121
 122
 123
 124     <a id="Roo.state.Provider-props"></a>
 125
 126
 127
 128
 129
 130      <table cellspacing="0" class="member-table">
 131       <caption class="Empty">Public Properties - Has None</caption>
 132      </table>
 133
 134
 135
 136
 137   <!-- ============================== methods summary / details ======================== -->
 138
 139
 140   <a id="Roo.state.Provider-methods"></a>
 141         <!-- constructor?? -->
 142
 143         <!-- static's first
 144
 145
 146         -->
 147
 148         <!-- then dynamics first -->
 149
 150
 151
 152
 153
 154
 155       <table cellspacing="0" class="member-table">
 156       <caption>Public Methods</caption>
 157         <tr>
 158             <th class="sig-header" colspan="2">Method</th>
 159             <th class="msource-header">Defined By</th>
 160
 161         </tr>
 162
 163
 164
 165
 166
 167
 168
 169           <tr class="method-row config-row-alt0 notInherited">
 170             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 171
 172
 173             <td class="sig">
 174                 <a id="Roo.state-method-Provider"   name=".Provider"></a>
 175                 <div class="fixedFont">
 176                         <span class="attributes">new <B>Roo.state.</B></span><b class="itemname">Provider</b>
 177
 178                                  ()
 179
 180
 181
 182                 </div>
 183                 <div class="mdesc">
 184
 185
 186                         <div class="short">Create a new Roo.state.Provider</div>
 187
 188
 189                     <div class="long">
 190
 191
 192
 193                                 Create a new Roo.state.Provider
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206                     </div>
 207                 </div>
 208
 209             </td>
 210             <td class="msource">
 211                 &nbsp;
 212             </td>
 213         </tr>
 214
 215
 216           <tr class="method-row config-row-alt1 expandable notInherited">
 217             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 218
 219
 220             <td class="sig">
 221                 <a id="Roo.state.Provider-method-clear"   name=".clear"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes"></span><b class="itemname">clear</b>
 224
 225                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232                    <div class="short">Clears a value from the state</div>
 233
 234
 235
 236                     <div class="long">
 237
 238                                 Clears a value from the state
 239
 240
 241
 242
 243
 244
 245                                 <dl class="detailList">
 246                                 <dt class="heading">Parameters:</dt>
 247
 248                                         <dt>
 249                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 250
 251                                         </dt>
 252                                         <dd>The key name</dd>
 253
 254                                 </dl>
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266                     </div>
 267                 </div>
 268
 269             </td>
 270             <td class="msource">
 271
 272                         Roo.state.Provider
 273                 &nbsp;
 274             </td>
 275         </tr>
 276
 277
 278           <tr class="method-row config-row-alt0 expandable notInherited">
 279             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 280
 281
 282             <td class="sig">
 283                 <a id="Roo.state.Provider-method-decodeValue"   name=".decodeValue"></a>
 284                 <div class="fixedFont">
 285                         <span class="attributes"></span><b class="itemname">decodeValue</b>
 286
 287                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 288
 289
 290                                          :
 291
 292
 293                                                 Mixed
 294
 295
 296
 297
 298
 299                 </div>
 300                 <div class="mdesc">
 301
 302                    <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div>
 303
 304
 305
 306                     <div class="long">
 307
 308                                 Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
 309
 310
 311
 312
 313
 314
 315                                 <dl class="detailList">
 316                                 <dt class="heading">Parameters:</dt>
 317
 318                                         <dt>
 319                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 320
 321                                         </dt>
 322                                         <dd>The value to decode</dd>
 323
 324                                 </dl>
 325
 326
 327
 328
 329
 330                                 <dl class="detailList">
 331                                 <dt class="heading">Returns:</dt>
 332
 333                                         <dd><span class="fixedFont">Mixed</span>  The decoded value</dd>
 334
 335                                 </dl>
 336
 337
 338
 339
 340
 341
 342
 343                     </div>
 344                 </div>
 345
 346             </td>
 347             <td class="msource">
 348
 349                         Roo.state.Provider
 350                 &nbsp;
 351             </td>
 352         </tr>
 353
 354
 355           <tr class="method-row config-row-alt1 expandable notInherited">
 356             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 357
 358
 359             <td class="sig">
 360                 <a id="Roo.state.Provider-method-encodeValue"   name=".encodeValue"></a>
 361                 <div class="fixedFont">
 362                         <span class="attributes"></span><b class="itemname">encodeValue</b>
 363
 364                                  (Mixed <B><i>value</i></B>)
 365
 366
 367                                          :
 368
 369
 370                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 371
 372
 373
 374
 375
 376                 </div>
 377                 <div class="mdesc">
 378
 379                    <div class="short">Encodes a value including type information.</div>
 380
 381
 382
 383                     <div class="long">
 384
 385                                 Encodes a value including type information.  Decode with {<b>link</b> <b>decodeValue</b>}.
 386
 387
 388
 389
 390
 391
 392                                 <dl class="detailList">
 393                                 <dt class="heading">Parameters:</dt>
 394
 395                                         <dt>
 396                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 397
 398                                         </dt>
 399                                         <dd>The value to encode</dd>
 400
 401                                 </dl>
 402
 403
 404
 405
 406
 407                                 <dl class="detailList">
 408                                 <dt class="heading">Returns:</dt>
 409
 410                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The encoded value</dd>
 411
 412                                 </dl>
 413
 414
 415
 416
 417
 418
 419
 420                     </div>
 421                 </div>
 422
 423             </td>
 424             <td class="msource">
 425
 426                         Roo.state.Provider
 427                 &nbsp;
 428             </td>
 429         </tr>
 430
 431
 432           <tr class="method-row config-row-alt0 expandable notInherited">
 433             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 434
 435
 436             <td class="sig">
 437                 <a id="Roo.state.Provider-method-get"   name=".get"></a>
 438                 <div class="fixedFont">
 439                         <span class="attributes"></span><b class="itemname">get</b>
 440
 441                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
 442
 443
 444                                          :
 445
 446
 447                                                 Mixed
 448
 449
 450
 451
 452
 453                 </div>
 454                 <div class="mdesc">
 455
 456                    <div class="short">Returns the current value for a key</div>
 457
 458
 459
 460                     <div class="long">
 461
 462                                 Returns the current value for a key
 463
 464
 465
 466
 467
 468
 469                                 <dl class="detailList">
 470                                 <dt class="heading">Parameters:</dt>
 471
 472                                         <dt>
 473                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 474
 475                                         </dt>
 476                                         <dd>The key name</dd>
 477
 478                                         <dt>
 479                                                 <span class="fixedFont">Mixed</span>  <b>defaultValue</b>
 480
 481                                         </dt>
 482                                         <dd>A default value to return if the key's value is not found</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 state data</dd>
 494
 495                                 </dl>
 496
 497
 498
 499
 500
 501
 502
 503                     </div>
 504                 </div>
 505
 506             </td>
 507             <td class="msource">
 508
 509                         Roo.state.Provider
 510                 &nbsp;
 511             </td>
 512         </tr>
 513
 514
 515           <tr class="method-row config-row-alt1 expandable notInherited">
 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-set"   name=".set"></a>
 521                 <div class="fixedFont">
 522                         <span class="attributes"></span><b class="itemname">set</b>
 523
 524                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
 525
 526
 527
 528                 </div>
 529                 <div class="mdesc">
 530
 531                    <div class="short">Sets the value for a key</div>
 532
 533
 534
 535                     <div class="long">
 536
 537                                 Sets the value for a key
 538
 539
 540
 541
 542
 543
 544                                 <dl class="detailList">
 545                                 <dt class="heading">Parameters:</dt>
 546
 547                                         <dt>
 548                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 549
 550                                         </dt>
 551                                         <dd>The key name</dd>
 552
 553                                         <dt>
 554                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 555
 556                                         </dt>
 557                                         <dd>The value to set</dd>
 558
 559                                 </dl>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571                     </div>
 572                 </div>
 573
 574             </td>
 575             <td class="msource">
 576
 577                         Roo.state.Provider
 578                 &nbsp;
 579             </td>
 580         </tr>
 581
 582
 583     </table>
 584
 585
 586   <!-- ============================== events summary / details ======================== -->
 587
 588
 589   <a id="Roo.state.Provider-events"></a>
 590
 591
 592
 593
 594
 595
 596
 597
 598       <table cellspacing="0" class="member-table">
 599                 <caption>Events</caption>
 600               <thead>
 601                 <tr>
 602                     <th class="sig-header" colspan="2">Event</th>
 603                     <th class="msource-header">Defined By</th>
 604
 605                 </tr>
 606               </thead>
 607
 608
 609
 610
 611
 612           <tr class="method-row expandable config-row-alt0 notInherited">
 613             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 614
 615             <td class="sig">
 616                 <a id="Roo.state.Provider-event-*statechange"></a>
 617
 618                <div class="fixedFont">
 619                 <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>)
 620
 621                 </div>
 622
 623                 <div class="mdesc">
 624
 625                    <div class="short">Fires when a state change occurs.
 626
 627                 </div>
 628
 629                     <div class="long">
 630
 631                         Fires when a state change occurs.
 632
 633
 634
 635
 636
 637                                 <dl class="detailList">
 638                                 <dt class="heading">Parameters:</dt>
 639
 640                                         <dt>
 641                                                 <span class="fixedFont">Provider</span> <b>this</b>
 642
 643                                         </dt>
 644                                         <dd>This state provider</dd>
 645
 646                                         <dt>
 647                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
 648
 649                                         </dt>
 650                                         <dd>The state key which was changed</dd>
 651
 652                                         <dt>
 653                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
 654
 655                                         </dt>
 656                                         <dd>The encoded value for the state</dd>
 657
 658                                 </dl>
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670                     </div>
 671                 </div>
 672
 673             </td>
 674             <td class="msource">
 675                 Roo.state.Provider
 676             </td>
 677         </tr>
 678
 679
 680     </table>
 681
 682
 683
 684
 685
 686 <!-- ============================== footer ================================= -->
 687                 <div class="fineprint" style="clear:both">
 688
 689                         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)
 690                         Based on
 691                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 692                 </div>
 693         </body>
 694 </html>