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