git.roojs.org Git - roojs1/blob - docs/symbols/Roo.state.Manager.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.Manager</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.Manager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.state.Manager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.state.Manager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.state.Manager-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.Manager
  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_Manager.js.html">Roo/state/Manager.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         This is the global state manager. By default all components that are "state aware" check this class<br/>for state information if you don't pass them a custom state provider. In order for this class<br/>to be useful, it must be initialized with a provider when your application initializes.<br/> <pre><code><br/>// in your initialization function<br/>init : function(){<br/>   Roo.state.Manager.setProvider(new Roo.state.CookieProvider());<br/>   ...<br/>   // supposed you have a {<b>link</b> Roo.BorderLayout}<br/>   var layout = new Roo.BorderLayout(...);<br/>   layout.restoreState();<br/>   // or a {Roo.BasicDialog}<br/>   var dialog = new Roo.BasicDialog(...);<br/>   dialog.restoreState();<br/> </code></pre>
  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.Manager';">[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.Manager.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.state.Manager-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.Manager-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.Manager-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 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.state.Manager-method-clear"   name=".clear"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">Roo.state.Manager.</span><b class="itemname">clear</b>
 170
 171                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
 172
 173
 174
 175                 </div>
 176                 <div class="mdesc">
 177
 178                    <div class="short">Clears a value from the state</div>
 179
 180
 181
 182                     <div class="long">
 183
 184                                 Clears a value from the state
 185
 186
 187
 188
 189
 190
 191                                 <dl class="detailList">
 192                                 <dt class="heading">Parameters:</dt>
 193
 194                                         <dt>
 195                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 196
 197                                         </dt>
 198                                         <dd>The key name</dd>
 199
 200                                 </dl>
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212                     </div>
 213                 </div>
 214
 215             </td>
 216             <td class="msource">
 217
 218                         Roo.state.Manager
 219                 &nbsp;
 220             </td>
 221         </tr>
 222
 223
 224           <tr class="method-row config-row-alt1 expandable notInherited">
 225             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 226
 227
 228             <td class="sig">
 229                 <a id="Roo.state.Manager-method-get"   name=".get"></a>
 230                 <div class="fixedFont">
 231                         <span class="attributes">Roo.state.Manager.</span><b class="itemname">get</b>
 232
 233                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>)
 234
 235
 236                                          :
 237
 238
 239                                                 Mixed
 240
 241
 242
 243
 244
 245                 </div>
 246                 <div class="mdesc">
 247
 248                    <div class="short">Returns the current value for a key</div>
 249
 250
 251
 252                     <div class="long">
 253
 254                                 Returns the current value for a key
 255
 256
 257
 258
 259
 260
 261                                 <dl class="detailList">
 262                                 <dt class="heading">Parameters:</dt>
 263
 264                                         <dt>
 265                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 266
 267                                         </dt>
 268                                         <dd>The key name</dd>
 269
 270                                         <dt>
 271                                                 <span class="fixedFont">Mixed</span>  <b>defaultValue</b>
 272
 273                                         </dt>
 274                                         <dd>The default value to return if the key lookup does not match</dd>
 275
 276                                 </dl>
 277
 278
 279
 280
 281
 282                                 <dl class="detailList">
 283                                 <dt class="heading">Returns:</dt>
 284
 285                                         <dd><span class="fixedFont">Mixed</span>  The state data</dd>
 286
 287                                 </dl>
 288
 289
 290
 291
 292
 293
 294
 295                     </div>
 296                 </div>
 297
 298             </td>
 299             <td class="msource">
 300
 301                         Roo.state.Manager
 302                 &nbsp;
 303             </td>
 304         </tr>
 305
 306
 307           <tr class="method-row config-row-alt0 expandable notInherited">
 308             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309
 310
 311             <td class="sig">
 312                 <a id="Roo.state.Manager-method-getProvider"   name=".getProvider"></a>
 313                 <div class="fixedFont">
 314                         <span class="attributes">Roo.state.Manager.</span><b class="itemname">getProvider</b>
 315
 316                                  ()
 317
 318
 319                                          :
 320
 321
 322                                                 Provider
 323
 324
 325
 326
 327
 328                 </div>
 329                 <div class="mdesc">
 330
 331                    <div class="short">Gets the currently configured state provider</div>
 332
 333
 334
 335                     <div class="long">
 336
 337                                 Gets the currently configured state provider
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348                                 <dl class="detailList">
 349                                 <dt class="heading">Returns:</dt>
 350
 351                                         <dd><span class="fixedFont">Provider</span>  The state provider</dd>
 352
 353                                 </dl>
 354
 355
 356
 357
 358
 359
 360
 361                     </div>
 362                 </div>
 363
 364             </td>
 365             <td class="msource">
 366
 367                         Roo.state.Manager
 368                 &nbsp;
 369             </td>
 370         </tr>
 371
 372
 373           <tr class="method-row config-row-alt1 expandable notInherited">
 374             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 375
 376
 377             <td class="sig">
 378                 <a id="Roo.state.Manager-method-set"   name=".set"></a>
 379                 <div class="fixedFont">
 380                         <span class="attributes">Roo.state.Manager.</span><b class="itemname">set</b>
 381
 382                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>)
 383
 384
 385
 386                 </div>
 387                 <div class="mdesc">
 388
 389                    <div class="short">Sets the value for a key</div>
 390
 391
 392
 393                     <div class="long">
 394
 395                                 Sets the value for a key
 396
 397
 398
 399
 400
 401
 402                                 <dl class="detailList">
 403                                 <dt class="heading">Parameters:</dt>
 404
 405                                         <dt>
 406                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
 407
 408                                         </dt>
 409                                         <dd>The key name</dd>
 410
 411                                         <dt>
 412                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 413
 414                                         </dt>
 415                                         <dd>The state data</dd>
 416
 417                                 </dl>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429                     </div>
 430                 </div>
 431
 432             </td>
 433             <td class="msource">
 434
 435                         Roo.state.Manager
 436                 &nbsp;
 437             </td>
 438         </tr>
 439
 440
 441           <tr class="method-row config-row-alt0 expandable notInherited">
 442             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 443
 444
 445             <td class="sig">
 446                 <a id="Roo.state.Manager-method-setProvider"   name=".setProvider"></a>
 447                 <div class="fixedFont">
 448                         <span class="attributes">Roo.state.Manager.</span><b class="itemname">setProvider</b>
 449
 450                                  (Provider <B><i>stateProvider</i></B>)
 451
 452
 453
 454                 </div>
 455                 <div class="mdesc">
 456
 457                    <div class="short">Configures the default state provider for your application</div>
 458
 459
 460
 461                     <div class="long">
 462
 463                                 Configures the default state provider for your application
 464
 465
 466
 467
 468
 469
 470                                 <dl class="detailList">
 471                                 <dt class="heading">Parameters:</dt>
 472
 473                                         <dt>
 474                                                 <span class="fixedFont">Provider</span>  <b>stateProvider</b>
 475
 476                                         </dt>
 477                                         <dd>The state provider to set</dd>
 478
 479                                 </dl>
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491                     </div>
 492                 </div>
 493
 494             </td>
 495             <td class="msource">
 496
 497                         Roo.state.Manager
 498                 &nbsp;
 499             </td>
 500         </tr>
 501
 502
 503     </table>
 504
 505
 506   <!-- ============================== events summary / details ======================== -->
 507
 508
 509   <a id="Roo.state.Manager-events"></a>
 510
 511
 512
 513
 514
 515      <table cellspacing="0" class="member-table">
 516       <caption class="Empty">Events - Has None</caption>
 517      </table>
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527 <!-- ============================== footer ================================= -->
 528                 <div class="fineprint" style="clear:both">
 529
 530                         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)
 531                         Based on
 532                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 533                 </div>
 534         </body>
 535 </html>