git.roojs.org Git - roojs1/blob - docs/symbols/Roo.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</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-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo-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
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55         <tr><td class="label">Defined In:</td><td class="hd-info">
  56
  57                                         <a href="./src/Roo.js.html">Roo.js</a>.
  58
  59         </td></tr>
  60         <tr><td class="label">Class:</td><td class="hd-info">Roo</td></tr>
  61
  62
  63
  64
  65     </table>
  66
  67
  68 <!-- ============================== class summary ========================== -->
  69     <div class="description">
  70         Roo core utilities and functions.
  71     </div>
  72
  73
  74 <!-- ============================== Class comment block... ========================== -->
  75
  76 <div class="comments">
  77         <b>Class Comments / Notes</B> =>
  78         <u onclick="parent.CommentDialog.showCommentId = 'Roo';">[Add Your comment/notes about this class]</u>
  79         <br/>
  80         <iframe frameborder="0"  id="comments-" style="border: none;width:100%;"
  81                 src="/blog.php/GtkDjsComments/Roo.html"></iframe>
  82 </div>
  83
  84
  85
  86 <!-- ============================== config options ========================== -->
  87
  88
  89
  90
  91     <div class="hr"></div>
  92     <a id="Roo-configs"></a>
  93
  94
  95
  96      <table cellspacing="0" class="member-table">
  97       <caption class="Empty">Config Options - Has None</caption>
  98      </table>
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111   <!-- ============================== public properties ==================== -->
 112
 113
 114
 115     <a id="Roo-props"></a>
 116
 117
 118
 119
 120
 121
 122
 123       <table cellspacing="0" class="member-table">
 124       <caption>Public Properties </caption>
 125         <tr>
 126             <th class="sig-header" colspan="2">Property</th>
 127             <th class="sig-header">Description</th>
 128             <th class="msource-header">Defined By</th>
 129         </tr>
 130
 131
 132
 133
 134
 135
 136
 137
 138           <tr class="property-row config-row-alt0 notInherited">
 139             <td class="micon">
 140                 <a class="exi" href="#expand">&nbsp;</a>
 141             </td>
 142             <td class="sig">
 143                <a id="Roo-prop-BLANK_IMAGE_URL" name=".BLANK_IMAGE_URL"></a>
 144                <div class="fixedFont">
 145                     <span class="attributes">Roo.</span><b  class="itemname">BLANK_IMAGE_URL</b> :
 146                      <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
 147                      </div>
 148             </td>
 149             <td class="sig">
 150                 <div class="mdesc">
 151
 152
 153                    <div class="short">
 154                         URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images.
 155
 156
 157
 158                    </div>
 159
 160                     <div class="long">
 161
 162                         URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images. (Defaults to<br/>"http://Roojs.com/s.gif" and you should change this to a URL on your server).
 163
 164                 </div>
 165                 </div>
 166             </td>
 167
 168             <td class="msource">
 169             Roo
 170             </td>
 171
 172           </tr>
 173
 174
 175
 176
 177           <tr class="property-row config-row-alt1 notInherited">
 178             <td class="micon">
 179                 <a class="exi" href="#expand">&nbsp;</a>
 180             </td>
 181             <td class="sig">
 182                <a id="Roo-prop-MessageBox" name=".MessageBox"></a>
 183                <div class="fixedFont">
 184                     <span class="attributes">Roo.</span><b  class="itemname">MessageBox</b> :
 185                      <span type="etype"></span>
 186                      </div>
 187             </td>
 188             <td class="sig">
 189                 <div class="mdesc">
 190
 191
 192                    <div class="short">
 193                         Shorthand for {<b>link</b> Roo.MessageBox}
 194
 195
 196
 197                    </div>
 198
 199                     <div class="long">
 200
 201                         Shorthand for {<b>link</b> Roo.MessageBox}
 202
 203                 </div>
 204                 </div>
 205             </td>
 206
 207             <td class="msource">
 208             Roo
 209             </td>
 210
 211           </tr>
 212
 213
 214
 215
 216           <tr class="property-row config-row-alt0 notInherited">
 217             <td class="micon">
 218                 <a class="exi" href="#expand">&nbsp;</a>
 219             </td>
 220             <td class="sig">
 221                <a id="Roo-prop-Msg" name=".Msg"></a>
 222                <div class="fixedFont">
 223                     <span class="attributes">Roo.</span><b  class="itemname">Msg</b> :
 224                      <span type="etype"></span>
 225                      </div>
 226             </td>
 227             <td class="sig">
 228                 <div class="mdesc">
 229
 230
 231                    <div class="short">
 232                         Shorthand for {<b>link</b> Roo.MessageBox}
 233
 234
 235
 236                    </div>
 237
 238                     <div class="long">
 239
 240                         Shorthand for {<b>link</b> Roo.MessageBox}
 241
 242                 </div>
 243                 </div>
 244             </td>
 245
 246             <td class="msource">
 247             Roo
 248             </td>
 249
 250           </tr>
 251
 252
 253
 254
 255           <tr class="property-row config-row-alt1 notInherited">
 256             <td class="micon">
 257                 <a class="exi" href="#expand">&nbsp;</a>
 258             </td>
 259             <td class="sig">
 260                <a id="Roo-prop-SSL_SECURE_URL" name=".SSL_SECURE_URL"></a>
 261                <div class="fixedFont">
 262                     <span class="attributes">Roo.</span><b  class="itemname">SSL_SECURE_URL</b> :
 263                      <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
 264                      </div>
 265             </td>
 266             <td class="sig">
 267                 <div class="mdesc">
 268
 269
 270                    <div class="short">
 271                         URL to a blank file used by Roo when in secure mode for iframe src and onReady src to prevent<br/>the IE insecure content warning (defaults to javascript:false).
 272
 273
 274
 275                    </div>
 276
 277                     <div class="long">
 278
 279                         URL to a blank file used by Roo when in secure mode for iframe src and onReady src to prevent<br/>the IE insecure content warning (defaults to javascript:false).
 280
 281                 </div>
 282                 </div>
 283             </td>
 284
 285             <td class="msource">
 286             Roo
 287             </td>
 288
 289           </tr>
 290
 291
 292
 293
 294           <tr class="property-row config-row-alt0 notInherited">
 295             <td class="micon">
 296                 <a class="exi" href="#expand">&nbsp;</a>
 297             </td>
 298             <td class="sig">
 299                <a id="Roo-prop-debug" name=".debug"></a>
 300                <div class="fixedFont">
 301                     <span class="attributes">Roo.</span><b  class="itemname">debug</b> :
 302                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 303                      </div>
 304             </td>
 305             <td class="sig">
 306                 <div class="mdesc">
 307
 308
 309                    <div class="short">
 310                         Turn on debugging output (currently only the factory uses this)
 311
 312
 313
 314                    </div>
 315
 316                     <div class="long">
 317
 318                         Turn on debugging output (currently only the factory uses this)
 319
 320                 </div>
 321                 </div>
 322             </td>
 323
 324             <td class="msource">
 325             Roo
 326             </td>
 327
 328           </tr>
 329
 330
 331
 332
 333           <tr class="property-row config-row-alt1 notInherited">
 334             <td class="micon">
 335                 <a class="exi" href="#expand">&nbsp;</a>
 336             </td>
 337             <td class="sig">
 338                <a id="Roo-prop-enableGarbageCollector" name=".enableGarbageCollector"></a>
 339                <div class="fixedFont">
 340                     <span class="attributes">Roo.</span><b  class="itemname">enableGarbageCollector</b> :
 341                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 342                      </div>
 343             </td>
 344             <td class="sig">
 345                 <div class="mdesc">
 346
 347
 348                    <div class="short">
 349                         True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
 350
 351
 352
 353                    </div>
 354
 355                     <div class="long">
 356
 357                         True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
 358
 359                 </div>
 360                 </div>
 361             </td>
 362
 363             <td class="msource">
 364             Roo
 365             </td>
 366
 367           </tr>
 368
 369
 370
 371
 372           <tr class="property-row config-row-alt0 notInherited">
 373             <td class="micon">
 374                 <a class="exi" href="#expand">&nbsp;</a>
 375             </td>
 376             <td class="sig">
 377                <a id="Roo-prop-enableListenerCollection" name=".enableListenerCollection"></a>
 378                <div class="fixedFont">
 379                     <span class="attributes">Roo.</span><b  class="itemname">enableListenerCollection</b> :
 380                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 381                      </div>
 382             </td>
 383             <td class="sig">
 384                 <div class="mdesc">
 385
 386
 387                    <div class="short">
 388                         True to automatically purge event listeners after uncaching an element (defaults to false).
 389
 390
 391
 392                    </div>
 393
 394                     <div class="long">
 395
 396                         True to automatically purge event listeners after uncaching an element (defaults to false).<br/>Note: this only happens if enableGarbageCollector is true.
 397
 398                 </div>
 399                 </div>
 400             </td>
 401
 402             <td class="msource">
 403             Roo
 404             </td>
 405
 406           </tr>
 407
 408
 409
 410
 411           <tr class="property-row config-row-alt1 notInherited">
 412             <td class="micon">
 413                 <a class="exi" href="#expand">&nbsp;</a>
 414             </td>
 415             <td class="sig">
 416                <a id="Roo-prop-isBorderBox" name=".isBorderBox"></a>
 417                <div class="fixedFont">
 418                     <span class="attributes">Roo.</span><b  class="itemname">isBorderBox</b> :
 419                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 420                      </div>
 421             </td>
 422             <td class="sig">
 423                 <div class="mdesc">
 424
 425
 426                    <div class="short">
 427
 428
 429
 430
 431                    </div>
 432
 433                     <div class="long">
 434
 435
 436
 437                 </div>
 438                 </div>
 439             </td>
 440
 441             <td class="msource">
 442             Roo
 443             </td>
 444
 445           </tr>
 446
 447
 448
 449
 450           <tr class="property-row config-row-alt0 notInherited">
 451             <td class="micon">
 452                 <a class="exi" href="#expand">&nbsp;</a>
 453             </td>
 454             <td class="sig">
 455                <a id="Roo-prop-isGecko" name=".isGecko"></a>
 456                <div class="fixedFont">
 457                     <span class="attributes">Roo.</span><b  class="itemname">isGecko</b> :
 458                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 459                      </div>
 460             </td>
 461             <td class="sig">
 462                 <div class="mdesc">
 463
 464
 465                    <div class="short">
 466
 467
 468
 469
 470                    </div>
 471
 472                     <div class="long">
 473
 474
 475
 476                 </div>
 477                 </div>
 478             </td>
 479
 480             <td class="msource">
 481             Roo
 482             </td>
 483
 484           </tr>
 485
 486
 487
 488
 489           <tr class="property-row config-row-alt1 notInherited">
 490             <td class="micon">
 491                 <a class="exi" href="#expand">&nbsp;</a>
 492             </td>
 493             <td class="sig">
 494                <a id="Roo-prop-isIE" name=".isIE"></a>
 495                <div class="fixedFont">
 496                     <span class="attributes">Roo.</span><b  class="itemname">isIE</b> :
 497                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 498                      </div>
 499             </td>
 500             <td class="sig">
 501                 <div class="mdesc">
 502
 503
 504                    <div class="short">
 505
 506
 507
 508
 509                    </div>
 510
 511                     <div class="long">
 512
 513
 514
 515                 </div>
 516                 </div>
 517             </td>
 518
 519             <td class="msource">
 520             Roo
 521             </td>
 522
 523           </tr>
 524
 525
 526
 527
 528           <tr class="property-row config-row-alt0 notInherited">
 529             <td class="micon">
 530                 <a class="exi" href="#expand">&nbsp;</a>
 531             </td>
 532             <td class="sig">
 533                <a id="Roo-prop-isIE7" name=".isIE7"></a>
 534                <div class="fixedFont">
 535                     <span class="attributes">Roo.</span><b  class="itemname">isIE7</b> :
 536                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 537                      </div>
 538             </td>
 539             <td class="sig">
 540                 <div class="mdesc">
 541
 542
 543                    <div class="short">
 544
 545
 546
 547
 548                    </div>
 549
 550                     <div class="long">
 551
 552
 553
 554                 </div>
 555                 </div>
 556             </td>
 557
 558             <td class="msource">
 559             Roo
 560             </td>
 561
 562           </tr>
 563
 564
 565
 566
 567           <tr class="property-row config-row-alt1 notInherited">
 568             <td class="micon">
 569                 <a class="exi" href="#expand">&nbsp;</a>
 570             </td>
 571             <td class="sig">
 572                <a id="Roo-prop-isLinux" name=".isLinux"></a>
 573                <div class="fixedFont">
 574                     <span class="attributes">Roo.</span><b  class="itemname">isLinux</b> :
 575                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 576                      </div>
 577             </td>
 578             <td class="sig">
 579                 <div class="mdesc">
 580
 581
 582                    <div class="short">
 583
 584
 585
 586
 587                    </div>
 588
 589                     <div class="long">
 590
 591
 592
 593                 </div>
 594                 </div>
 595             </td>
 596
 597             <td class="msource">
 598             Roo
 599             </td>
 600
 601           </tr>
 602
 603
 604
 605
 606           <tr class="property-row config-row-alt0 notInherited">
 607             <td class="micon">
 608                 <a class="exi" href="#expand">&nbsp;</a>
 609             </td>
 610             <td class="sig">
 611                <a id="Roo-prop-isMac" name=".isMac"></a>
 612                <div class="fixedFont">
 613                     <span class="attributes">Roo.</span><b  class="itemname">isMac</b> :
 614                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 615                      </div>
 616             </td>
 617             <td class="sig">
 618                 <div class="mdesc">
 619
 620
 621                    <div class="short">
 622
 623
 624
 625
 626                    </div>
 627
 628                     <div class="long">
 629
 630
 631
 632                 </div>
 633                 </div>
 634             </td>
 635
 636             <td class="msource">
 637             Roo
 638             </td>
 639
 640           </tr>
 641
 642
 643
 644
 645           <tr class="property-row config-row-alt1 notInherited">
 646             <td class="micon">
 647                 <a class="exi" href="#expand">&nbsp;</a>
 648             </td>
 649             <td class="sig">
 650                <a id="Roo-prop-isOpera" name=".isOpera"></a>
 651                <div class="fixedFont">
 652                     <span class="attributes">Roo.</span><b  class="itemname">isOpera</b> :
 653                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 654                      </div>
 655             </td>
 656             <td class="sig">
 657                 <div class="mdesc">
 658
 659
 660                    <div class="short">
 661
 662
 663
 664
 665                    </div>
 666
 667                     <div class="long">
 668
 669
 670
 671                 </div>
 672                 </div>
 673             </td>
 674
 675             <td class="msource">
 676             Roo
 677             </td>
 678
 679           </tr>
 680
 681
 682
 683
 684           <tr class="property-row config-row-alt0 notInherited">
 685             <td class="micon">
 686                 <a class="exi" href="#expand">&nbsp;</a>
 687             </td>
 688             <td class="sig">
 689                <a id="Roo-prop-isReady" name=".isReady"></a>
 690                <div class="fixedFont">
 691                     <span class="attributes">Roo.</span><b  class="itemname">isReady</b> :
 692                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 693                      </div>
 694             </td>
 695             <td class="sig">
 696                 <div class="mdesc">
 697
 698
 699                    <div class="short">
 700                         True when the document is fully initialized and ready for action
 701
 702
 703
 704                    </div>
 705
 706                     <div class="long">
 707
 708                         True when the document is fully initialized and ready for action
 709
 710                 </div>
 711                 </div>
 712             </td>
 713
 714             <td class="msource">
 715             Roo
 716             </td>
 717
 718           </tr>
 719
 720
 721
 722
 723           <tr class="property-row config-row-alt1 notInherited">
 724             <td class="micon">
 725                 <a class="exi" href="#expand">&nbsp;</a>
 726             </td>
 727             <td class="sig">
 728                <a id="Roo-prop-isSafari" name=".isSafari"></a>
 729                <div class="fixedFont">
 730                     <span class="attributes">Roo.</span><b  class="itemname">isSafari</b> :
 731                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 732                      </div>
 733             </td>
 734             <td class="sig">
 735                 <div class="mdesc">
 736
 737
 738                    <div class="short">
 739
 740
 741
 742
 743                    </div>
 744
 745                     <div class="long">
 746
 747
 748
 749                 </div>
 750                 </div>
 751             </td>
 752
 753             <td class="msource">
 754             Roo
 755             </td>
 756
 757           </tr>
 758
 759
 760
 761
 762           <tr class="property-row config-row-alt0 notInherited">
 763             <td class="micon">
 764                 <a class="exi" href="#expand">&nbsp;</a>
 765             </td>
 766             <td class="sig">
 767                <a id="Roo-prop-isSecure" name=".isSecure"></a>
 768                <div class="fixedFont">
 769                     <span class="attributes">Roo.</span><b  class="itemname">isSecure</b> :
 770                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 771                      </div>
 772             </td>
 773             <td class="sig">
 774                 <div class="mdesc">
 775
 776
 777                    <div class="short">
 778                         True if the page is running over SSL
 779
 780
 781
 782                    </div>
 783
 784                     <div class="long">
 785
 786                         True if the page is running over SSL
 787
 788                 </div>
 789                 </div>
 790             </td>
 791
 792             <td class="msource">
 793             Roo
 794             </td>
 795
 796           </tr>
 797
 798
 799
 800
 801           <tr class="property-row config-row-alt1 notInherited">
 802             <td class="micon">
 803                 <a class="exi" href="#expand">&nbsp;</a>
 804             </td>
 805             <td class="sig">
 806                <a id="Roo-prop-isStrict" name=".isStrict"></a>
 807                <div class="fixedFont">
 808                     <span class="attributes">Roo.</span><b  class="itemname">isStrict</b> :
 809                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 810                      </div>
 811             </td>
 812             <td class="sig">
 813                 <div class="mdesc">
 814
 815
 816                    <div class="short">
 817                         True if the browser is in strict mode
 818
 819
 820
 821                    </div>
 822
 823                     <div class="long">
 824
 825                         True if the browser is in strict mode
 826
 827                 </div>
 828                 </div>
 829             </td>
 830
 831             <td class="msource">
 832             Roo
 833             </td>
 834
 835           </tr>
 836
 837
 838
 839
 840           <tr class="property-row config-row-alt0 notInherited">
 841             <td class="micon">
 842                 <a class="exi" href="#expand">&nbsp;</a>
 843             </td>
 844             <td class="sig">
 845                <a id="Roo-prop-isTouch" name=".isTouch"></a>
 846                <div class="fixedFont">
 847                     <span class="attributes">Roo.</span><b  class="itemname">isTouch</b> :
 848                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 849                      </div>
 850             </td>
 851             <td class="sig">
 852                 <div class="mdesc">
 853
 854
 855                    <div class="short">
 856
 857
 858
 859
 860                    </div>
 861
 862                     <div class="long">
 863
 864
 865
 866                 </div>
 867                 </div>
 868             </td>
 869
 870             <td class="msource">
 871             Roo
 872             </td>
 873
 874           </tr>
 875
 876
 877
 878
 879           <tr class="property-row config-row-alt1 notInherited">
 880             <td class="micon">
 881                 <a class="exi" href="#expand">&nbsp;</a>
 882             </td>
 883             <td class="sig">
 884                <a id="Roo-prop-isWindows" name=".isWindows"></a>
 885                <div class="fixedFont">
 886                     <span class="attributes">Roo.</span><b  class="itemname">isWindows</b> :
 887                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 888                      </div>
 889             </td>
 890             <td class="sig">
 891                 <div class="mdesc">
 892
 893
 894                    <div class="short">
 895
 896
 897
 898
 899                    </div>
 900
 901                     <div class="long">
 902
 903
 904
 905                 </div>
 906                 </div>
 907             </td>
 908
 909             <td class="msource">
 910             Roo
 911             </td>
 912
 913           </tr>
 914
 915
 916
 917
 918           <tr class="property-row config-row-alt0 notInherited">
 919             <td class="micon">
 920                 <a class="exi" href="#expand">&nbsp;</a>
 921             </td>
 922             <td class="sig">
 923                <a id="Roo-prop-useShims" name=".useShims"></a>
 924                <div class="fixedFont">
 925                     <span class="attributes">Roo.</span><b  class="itemname">useShims</b> :
 926                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 927                      </div>
 928             </td>
 929             <td class="sig">
 930                 <div class="mdesc">
 931
 932
 933                    <div class="short">
 934                         By default, Ext intelligently decides whether floating elements should be shimmed.
 935
 936
 937
 938                    </div>
 939
 940                     <div class="long">
 941
 942                         By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash,<br/>you may want to set this to true.
 943
 944                 </div>
 945                 </div>
 946             </td>
 947
 948             <td class="msource">
 949             Roo
 950             </td>
 951
 952           </tr>
 953
 954
 955
 956
 957
 958         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 959         <tr class="property-row alt">
 960
 961         -->
 962
 963     </table>
 964
 965
 966   <!-- ============================== methods summary / details ======================== -->
 967
 968
 969   <a id="Roo-methods"></a>
 970         <!-- constructor?? -->
 971
 972         <!-- static's first
 973
 974
 975         -->
 976
 977         <!-- then dynamics first -->
 978
 979
 980
 981
 982
 983
 984       <table cellspacing="0" class="member-table">
 985       <caption>Public Methods</caption>
 986         <tr>
 987             <th class="sig-header" colspan="2">Method</th>
 988             <th class="msource-header">Defined By</th>
 989
 990         </tr>
 991
 992
 993
 994
 995
 996
 997
 998           <tr class="method-row config-row-alt0 expandable notInherited">
 999             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1000
1001
1002             <td class="sig">
1003                 <a id="Roo-method-addBehaviors"   name=".addBehaviors"></a>
1004                 <div class="fixedFont">
1005                         <span class="attributes">Roo.</span><b class="itemname">addBehaviors</b>
1006
1007                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>)
1008
1009
1010
1011                 </div>
1012                 <div class="mdesc">
1013
1014                    <div class="short">Applies event listeners to elements by selectors when the document is ready.</div>
1015
1016
1017
1018                     <div class="long">
1019
1020                                 Applies event listeners to elements by selectors when the document is ready.<br/>The event name is specified with an @ suffix.<br/><pre><code><br/>Roo.addBehaviors({<br/>   // add a listener for click on all anchors in element with id foo<br/>   '<b>foo</b> a<b>click</b>' : function(e, t){<br/>       // do something<br/>   },<br/><br/>   // add the same listener to multiple selectors (separated by comma BEFORE the @)<br/>   '<b>foo</b> a, <b>bar</b> span.some-class<b>mouseover</b>' : function(){<br/>       // do something<br/>   }<br/>});<br/></code></pre>
1021
1022
1023
1024
1025
1026
1027                                 <dl class="detailList">
1028                                 <dt class="heading">Parameters:</dt>
1029
1030                                         <dt>
1031                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>obj</b>
1032
1033                                         </dt>
1034                                         <dd>The list of behaviors to apply</dd>
1035
1036                                 </dl>
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048                     </div>
1049                 </div>
1050
1051             </td>
1052             <td class="msource">
1053
1054                         Roo
1055                 &nbsp;
1056             </td>
1057         </tr>
1058
1059
1060           <tr class="method-row config-row-alt1 expandable notInherited">
1061             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1062
1063
1064             <td class="sig">
1065                 <a id="Roo-method-apply"   name=".apply"></a>
1066                 <div class="fixedFont">
1067                         <span class="attributes">Roo.</span><b class="itemname">apply</b>
1068
1069                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>defaults</i></B>)
1070
1071
1072                                          :
1073
1074
1075                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1076
1077
1078
1079
1080
1081                 </div>
1082                 <div class="mdesc">
1083
1084                    <div class="short">Copies all the properties of config to obj.</div>
1085
1086
1087
1088                     <div class="long">
1089
1090                                 Copies all the properties of config to obj.
1091
1092
1093
1094
1095
1096
1097                                 <dl class="detailList">
1098                                 <dt class="heading">Parameters:</dt>
1099
1100                                         <dt>
1101                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>obj</b>
1102
1103                                         </dt>
1104                                         <dd>The receiver of the properties</dd>
1105
1106                                         <dt>
1107                                                 <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>
1108
1109                                         </dt>
1110                                         <dd>The source of the properties</dd>
1111
1112                                         <dt>
1113                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>defaults</b>
1114
1115                                         </dt>
1116                                         <dd>A different object that will also be applied for default values</dd>
1117
1118                                 </dl>
1119
1120
1121
1122
1123
1124                                 <dl class="detailList">
1125                                 <dt class="heading">Returns:</dt>
1126
1127                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  returns obj</dd>
1128
1129                                 </dl>
1130
1131
1132
1133
1134
1135
1136
1137                     </div>
1138                 </div>
1139
1140             </td>
1141             <td class="msource">
1142
1143                         Roo
1144                 &nbsp;
1145             </td>
1146         </tr>
1147
1148
1149           <tr class="method-row config-row-alt0 expandable notInherited">
1150             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1151
1152
1153             <td class="sig">
1154                 <a id="Roo-method-applyIf"   name=".applyIf"></a>
1155                 <div class="fixedFont">
1156                         <span class="attributes">Roo.</span><b class="itemname">applyIf</b>
1157
1158                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1159
1160
1161                                          :
1162
1163
1164                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1165
1166
1167
1168
1169
1170                 </div>
1171                 <div class="mdesc">
1172
1173                    <div class="short">Copies all the properties of config to obj if they don't already exist.</div>
1174
1175
1176
1177                     <div class="long">
1178
1179                                 Copies all the properties of config to obj if they don't already exist.
1180
1181
1182
1183
1184
1185
1186                                 <dl class="detailList">
1187                                 <dt class="heading">Parameters:</dt>
1188
1189                                         <dt>
1190                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>obj</b>
1191
1192                                         </dt>
1193                                         <dd>The receiver of the properties</dd>
1194
1195                                         <dt>
1196                                                 <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>
1197
1198                                         </dt>
1199                                         <dd>The source of the properties</dd>
1200
1201                                 </dl>
1202
1203
1204
1205
1206
1207                                 <dl class="detailList">
1208                                 <dt class="heading">Returns:</dt>
1209
1210                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  returns obj</dd>
1211
1212                                 </dl>
1213
1214
1215
1216
1217
1218
1219
1220                     </div>
1221                 </div>
1222
1223             </td>
1224             <td class="msource">
1225
1226                         Roo
1227                 &nbsp;
1228             </td>
1229         </tr>
1230
1231
1232           <tr class="method-row config-row-alt1 expandable notInherited">
1233             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1234
1235
1236             <td class="sig">
1237                 <a id="Roo-method-decode"   name=".decode"></a>
1238                 <div class="fixedFont">
1239                         <span class="attributes">Roo.</span><b class="itemname">decode</b>
1240
1241                                  ()
1242
1243
1244
1245                 </div>
1246                 <div class="mdesc">
1247
1248                    <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}</div>
1249
1250
1251
1252                     <div class="long">
1253
1254                                 Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271                     </div>
1272                 </div>
1273
1274             </td>
1275             <td class="msource">
1276
1277                         Roo
1278                 &nbsp;
1279             </td>
1280         </tr>
1281
1282
1283           <tr class="method-row config-row-alt0 expandable notInherited">
1284             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1285
1286
1287             <td class="sig">
1288                 <a id="Roo-method-each"   name=".each"></a>
1289                 <div class="fixedFont">
1290                         <span class="attributes">Roo.</span><b class="itemname">each</b>
1291
1292                                  (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed <B><i>array</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1293
1294
1295
1296                 </div>
1297                 <div class="mdesc">
1298
1299                    <div class="short">Iterates an array calling the passed function with each item, stopping if your function returns false.</div>
1300
1301
1302
1303                     <div class="long">
1304
1305                                 Iterates an array calling the passed function with each item, stopping if your function returns false. If the<br/>passed array is not really an array, your function is called once with it.<br/>The supplied function is called with (Object item, Number index, Array allItems).
1306
1307
1308
1309
1310
1311
1312                                 <dl class="detailList">
1313                                 <dt class="heading">Parameters:</dt>
1314
1315                                         <dt>
1316                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed</span>  <b>array</b>
1317
1318                                         </dt>
1319                                         <dd></dd>
1320
1321                                         <dt>
1322                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
1323
1324                                         </dt>
1325                                         <dd></dd>
1326
1327                                         <dt>
1328                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1329
1330                                         </dt>
1331                                         <dd></dd>
1332
1333                                 </dl>
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345                     </div>
1346                 </div>
1347
1348             </td>
1349             <td class="msource">
1350
1351                         Roo
1352                 &nbsp;
1353             </td>
1354         </tr>
1355
1356
1357           <tr class="method-row config-row-alt1 expandable notInherited">
1358             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1359
1360
1361             <td class="sig">
1362                 <a id="Roo-method-encode"   name=".encode"></a>
1363                 <div class="fixedFont">
1364                         <span class="attributes">Roo.</span><b class="itemname">encode</b>
1365
1366                                  ()
1367
1368
1369
1370                 </div>
1371                 <div class="mdesc">
1372
1373                    <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}</div>
1374
1375
1376
1377                     <div class="long">
1378
1379                                 Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396                     </div>
1397                 </div>
1398
1399             </td>
1400             <td class="msource">
1401
1402                         Roo
1403                 &nbsp;
1404             </td>
1405         </tr>
1406
1407
1408           <tr class="method-row config-row-alt0 expandable notInherited">
1409             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1410
1411
1412             <td class="sig">
1413                 <a id="Roo-method-encodeURIComponent"   name=".encodeURIComponent"></a>
1414                 <div class="fixedFont">
1415                         <span class="attributes">Roo.</span><b class="itemname">encodeURIComponent</b>
1416
1417                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>data</i></B>)
1418
1419
1420                                          :
1421
1422
1423                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1424
1425
1426
1427
1428
1429                 </div>
1430                 <div class="mdesc">
1431
1432                    <div class="short">Safe version of encodeURIComponent</div>
1433
1434
1435
1436                     <div class="long">
1437
1438                                 Safe version of encodeURIComponent
1439
1440
1441
1442
1443
1444
1445                                 <dl class="detailList">
1446                                 <dt class="heading">Parameters:</dt>
1447
1448                                         <dt>
1449                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>data</b>
1450
1451                                         </dt>
1452                                         <dd></dd>
1453
1454                                 </dl>
1455
1456
1457
1458
1459
1460                                 <dl class="detailList">
1461                                 <dt class="heading">Returns:</dt>
1462
1463                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
1464
1465                                 </dl>
1466
1467
1468
1469
1470
1471
1472
1473                     </div>
1474                 </div>
1475
1476             </td>
1477             <td class="msource">
1478
1479                         Roo
1480                 &nbsp;
1481             </td>
1482         </tr>
1483
1484
1485           <tr class="method-row config-row-alt1 expandable notInherited">
1486             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1487
1488
1489             <td class="sig">
1490                 <a id="Roo-method-escapeRe"   name=".escapeRe"></a>
1491                 <div class="fixedFont">
1492                         <span class="attributes">Roo.</span><b class="itemname">escapeRe</b>
1493
1494                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>str</i></B>)
1495
1496
1497                                          :
1498
1499
1500                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1501
1502
1503
1504
1505
1506                 </div>
1507                 <div class="mdesc">
1508
1509                    <div class="short">Escapes the passed string for use in a regular expression</div>
1510
1511
1512
1513                     <div class="long">
1514
1515                                 Escapes the passed string for use in a regular expression
1516
1517
1518
1519
1520
1521
1522                                 <dl class="detailList">
1523                                 <dt class="heading">Parameters:</dt>
1524
1525                                         <dt>
1526                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>str</b>
1527
1528                                         </dt>
1529                                         <dd></dd>
1530
1531                                 </dl>
1532
1533
1534
1535
1536
1537                                 <dl class="detailList">
1538                                 <dt class="heading">Returns:</dt>
1539
1540                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
1541
1542                                 </dl>
1543
1544
1545
1546
1547
1548
1549
1550                     </div>
1551                 </div>
1552
1553             </td>
1554             <td class="msource">
1555
1556                         Roo
1557                 &nbsp;
1558             </td>
1559         </tr>
1560
1561
1562           <tr class="method-row config-row-alt0 expandable notInherited">
1563             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1564
1565
1566             <td class="sig">
1567                 <a id="Roo-method-extend"   name=".extend"></a>
1568                 <div class="fixedFont">
1569                         <span class="attributes">Roo.</span><b class="itemname">extend</b>
1570
1571                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>subclass</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>superclass</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>overrides</i></B>)
1572
1573
1574
1575                 </div>
1576                 <div class="mdesc">
1577
1578                    <div class="short">Extends one class with another class and optionally overrides members with the passed literal.</div>
1579
1580
1581
1582                     <div class="long">
1583
1584                                 Extends one class with another class and optionally overrides members with the passed literal. This class<br/>also adds the function "override()" to the class that can be used to override<br/>members on an instance.
1585
1586
1587
1588
1589
1590
1591                                 <dl class="detailList">
1592                                 <dt class="heading">Parameters:</dt>
1593
1594                                         <dt>
1595                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>subclass</b>
1596
1597                                         </dt>
1598                                         <dd>The class inheriting the functionality</dd>
1599
1600                                         <dt>
1601                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>superclass</b>
1602
1603                                         </dt>
1604                                         <dd>The class being extended</dd>
1605
1606                                         <dt>
1607                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>overrides</b>
1608
1609                                         </dt>
1610                                         <dd>(optional) A literal with members</dd>
1611
1612                                 </dl>
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624                     </div>
1625                 </div>
1626
1627             </td>
1628             <td class="msource">
1629
1630                         Roo
1631                 &nbsp;
1632             </td>
1633         </tr>
1634
1635
1636           <tr class="method-row config-row-alt1 expandable notInherited">
1637             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1638
1639
1640             <td class="sig">
1641                 <a id="Roo-method-factory"   name=".factory"></a>
1642                 <div class="fixedFont">
1643                         <span class="attributes">Roo.</span><b class="itemname">factory</b>
1644
1645                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>classname</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>namespace</i></B>)
1646
1647
1648
1649                 </div>
1650                 <div class="mdesc">
1651
1652                    <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
1653
1654
1655
1656                     <div class="long">
1657
1658                                 Creates namespaces to be used for scoping variables and classes so that they are not global.  Usage:<br/><pre><code><br/>Roo.factory({ xns: Roo.data, xtype : 'Store', .....});<br/>Roo.factory(conf, Roo.data);<br/></code></pre>
1659
1660
1661
1662
1663
1664
1665                                 <dl class="detailList">
1666                                 <dt class="heading">Parameters:</dt>
1667
1668                                         <dt>
1669                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>classname</b>
1670
1671                                         </dt>
1672                                         <dd></dd>
1673
1674                                         <dt>
1675                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace</b>
1676
1677                                         </dt>
1678                                         <dd>(optional)</dd>
1679
1680                                 </dl>
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692                     </div>
1693                 </div>
1694
1695             </td>
1696             <td class="msource">
1697
1698                         Roo
1699                 &nbsp;
1700             </td>
1701         </tr>
1702
1703
1704           <tr class="method-row config-row-alt0 expandable notInherited">
1705             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1706
1707
1708             <td class="sig">
1709                 <a id="Roo-method-fly"   name=".fly"></a>
1710                 <div class="fixedFont">
1711                         <span class="attributes">Roo.</span><b class="itemname">fly</b>
1712
1713                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>named</i></B>)
1714
1715
1716                                          :
1717
1718
1719                                                 Element
1720
1721
1722
1723
1724
1725                 </div>
1726                 <div class="mdesc">
1727
1728                    <div class="short">Gets the globally shared flyweight Element, with the passed node as the active element.</div>
1729
1730
1731
1732                     <div class="long">
1733
1734                                 Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -<br/>the dom node can be overwritten by other code.<br/>Shorthand of {<b>link</b> Roo.Element<b>fly</b>}
1735
1736
1737
1738
1739
1740
1741                                 <dl class="detailList">
1742                                 <dt class="heading">Parameters:</dt>
1743
1744                                         <dt>
1745                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
1746
1747                                         </dt>
1748                                         <dd>The dom node or id</dd>
1749
1750                                         <dt>
1751                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>named</b>
1752
1753                                         </dt>
1754                                         <dd>(optional) Allows for creation of named reusable flyweights to<br/>                                 prevent conflicts (e.g. internally Roo uses "_internal")</dd>
1755
1756                                 </dl>
1757
1758
1759
1760
1761
1762                                 <dl class="detailList">
1763                                 <dt class="heading">Returns:</dt>
1764
1765                                         <dd><span class="fixedFont">Element</span>  The shared Element object</dd>
1766
1767                                 </dl>
1768
1769
1770
1771
1772
1773
1774
1775                     </div>
1776                 </div>
1777
1778             </td>
1779             <td class="msource">
1780
1781                         Roo
1782                 &nbsp;
1783             </td>
1784         </tr>
1785
1786
1787           <tr class="method-row config-row-alt1 expandable notInherited">
1788             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1789
1790
1791             <td class="sig">
1792                 <a id="Roo-method-get"   name=".get"></a>
1793                 <div class="fixedFont">
1794                         <span class="attributes">Roo.</span><b class="itemname">get</b>
1795
1796                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1797
1798
1799                                          :
1800
1801
1802                                                 Element
1803
1804
1805
1806
1807
1808                 </div>
1809                 <div class="mdesc">
1810
1811                    <div class="short">Static method to retrieve Element objects.</div>
1812
1813
1814
1815                     <div class="long">
1816
1817                                 Static method to retrieve Element objects. Uses simple caching to consistently return the same object.<br/>Automatically fixes if an object was recreated with the same id via AJAX or DOM.<br/>Shorthand of {<b>link</b> Roo.Element<b>get</b>}
1818
1819
1820
1821
1822
1823
1824                                 <dl class="detailList">
1825                                 <dt class="heading">Parameters:</dt>
1826
1827                                         <dt>
1828                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
1829
1830                                         </dt>
1831                                         <dd>The id of the node, a DOM Node or an existing Element.</dd>
1832
1833                                 </dl>
1834
1835
1836
1837
1838
1839                                 <dl class="detailList">
1840                                 <dt class="heading">Returns:</dt>
1841
1842                                         <dd><span class="fixedFont">Element</span>  The Element object</dd>
1843
1844                                 </dl>
1845
1846
1847
1848
1849
1850
1851
1852                     </div>
1853                 </div>
1854
1855             </td>
1856             <td class="msource">
1857
1858                         Roo
1859                 &nbsp;
1860             </td>
1861         </tr>
1862
1863
1864           <tr class="method-row config-row-alt0 expandable notInherited">
1865             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1866
1867
1868             <td class="sig">
1869                 <a id="Roo-method-getCmp"   name=".getCmp"></a>
1870                 <div class="fixedFont">
1871                         <span class="attributes">Roo.</span><b class="itemname">getCmp</b>
1872
1873                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1874
1875
1876                                          :
1877
1878
1879
1880
1881
1882
1883
1884
1885                 </div>
1886                 <div class="mdesc">
1887
1888                    <div class="short">Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}</div>
1889
1890
1891
1892                     <div class="long">
1893
1894                                 Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}
1895
1896
1897
1898
1899
1900
1901                                 <dl class="detailList">
1902                                 <dt class="heading">Parameters:</dt>
1903
1904                                         <dt>
1905                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1906
1907                                         </dt>
1908                                         <dd></dd>
1909
1910                                 </dl>
1911
1912
1913
1914
1915
1916                                 <dl class="detailList">
1917                                 <dt class="heading">Returns:</dt>
1918
1919                                         <dd> Roo.Component</dd>
1920
1921                                 </dl>
1922
1923
1924
1925
1926
1927
1928
1929                     </div>
1930                 </div>
1931
1932             </td>
1933             <td class="msource">
1934
1935                         Roo
1936                 &nbsp;
1937             </td>
1938         </tr>
1939
1940
1941           <tr class="method-row config-row-alt1 expandable notInherited">
1942             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1943
1944
1945             <td class="sig">
1946                 <a id="Roo-method-getDom"   name=".getDom"></a>
1947                 <div class="fixedFont">
1948                         <span class="attributes">Roo.</span><b class="itemname">getDom</b>
1949
1950                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>)
1951
1952
1953                                          :
1954
1955
1956
1957
1958
1959
1960
1961
1962                 </div>
1963                 <div class="mdesc">
1964
1965                    <div class="short">Return the dom node for the passed string (id), dom node, or Roo.Element</div>
1966
1967
1968
1969                     <div class="long">
1970
1971                                 Return the dom node for the passed string (id), dom node, or Roo.Element
1972
1973
1974
1975
1976
1977
1978                                 <dl class="detailList">
1979                                 <dt class="heading">Parameters:</dt>
1980
1981                                         <dt>
1982                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
1983
1984                                         </dt>
1985                                         <dd></dd>
1986
1987                                 </dl>
1988
1989
1990
1991
1992
1993                                 <dl class="detailList">
1994                                 <dt class="heading">Returns:</dt>
1995
1996                                         <dd> HTMLElement</dd>
1997
1998                                 </dl>
1999
2000
2001
2002
2003
2004
2005
2006                     </div>
2007                 </div>
2008
2009             </td>
2010             <td class="msource">
2011
2012                         Roo
2013                 &nbsp;
2014             </td>
2015         </tr>
2016
2017
2018           <tr class="method-row config-row-alt0 expandable notInherited">
2019             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2020
2021
2022             <td class="sig">
2023                 <a id="Roo-method-id"   name=".id"></a>
2024                 <div class="fixedFont">
2025                         <span class="attributes">Roo.</span><b class="itemname">id</b>
2026
2027                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>prefix</i></B>)
2028
2029
2030                                          :
2031
2032
2033                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2034
2035
2036
2037
2038
2039                 </div>
2040                 <div class="mdesc">
2041
2042                    <div class="short">Generates unique ids.</div>
2043
2044
2045
2046                     <div class="long">
2047
2048                                 Generates unique ids. If the element already has an id, it is unchanged
2049
2050
2051
2052
2053
2054
2055                                 <dl class="detailList">
2056                                 <dt class="heading">Parameters:</dt>
2057
2058                                         <dt>
2059                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
2060
2061                                         </dt>
2062                                         <dd>(optional) The element to generate an id for</dd>
2063
2064                                         <dt>
2065                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>prefix</b>
2066
2067                                         </dt>
2068                                         <dd>(optional) Id prefix (defaults "Roo-gen")</dd>
2069
2070                                 </dl>
2071
2072
2073
2074
2075
2076                                 <dl class="detailList">
2077                                 <dt class="heading">Returns:</dt>
2078
2079                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The generated Id.</dd>
2080
2081                                 </dl>
2082
2083
2084
2085
2086
2087
2088
2089                     </div>
2090                 </div>
2091
2092             </td>
2093             <td class="msource">
2094
2095                         Roo
2096                 &nbsp;
2097             </td>
2098         </tr>
2099
2100
2101           <tr class="method-row config-row-alt1 expandable notInherited">
2102             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2103
2104
2105             <td class="sig">
2106                 <a id="Roo-method-isEmpty"   name=".isEmpty"></a>
2107                 <div class="fixedFont">
2108                         <span class="attributes">Roo.</span><b class="itemname">isEmpty</b>
2109
2110                                  (Mixed <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>allowBlank</i></B>)
2111
2112
2113                                          :
2114
2115
2116                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2117
2118
2119
2120
2121
2122                 </div>
2123                 <div class="mdesc">
2124
2125                    <div class="short">Returns true if the passed value is null, undefined or an empty string (optional).</div>
2126
2127
2128
2129                     <div class="long">
2130
2131                                 Returns true if the passed value is null, undefined or an empty string (optional).
2132
2133
2134
2135
2136
2137
2138                                 <dl class="detailList">
2139                                 <dt class="heading">Parameters:</dt>
2140
2141                                         <dt>
2142                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
2143
2144                                         </dt>
2145                                         <dd>The value to test</dd>
2146
2147                                         <dt>
2148                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>allowBlank</b>
2149
2150                                         </dt>
2151                                         <dd>(optional) Pass true if an empty string is not considered empty</dd>
2152
2153                                 </dl>
2154
2155
2156
2157
2158
2159                                 <dl class="detailList">
2160                                 <dt class="heading">Returns:</dt>
2161
2162                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
2163
2164                                 </dl>
2165
2166
2167
2168
2169
2170
2171
2172                     </div>
2173                 </div>
2174
2175             </td>
2176             <td class="msource">
2177
2178                         Roo
2179                 &nbsp;
2180             </td>
2181         </tr>
2182
2183
2184           <tr class="method-row config-row-alt0 expandable notInherited">
2185             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2186
2187
2188             <td class="sig">
2189                 <a id="Roo-method-log"   name=".log"></a>
2190                 <div class="fixedFont">
2191                         <span class="attributes">Roo.</span><b class="itemname">log</b>
2192
2193                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>string</i></B>)
2194
2195
2196
2197                 </div>
2198                 <div class="mdesc">
2199
2200                    <div class="short">Logs to console if it can.</div>
2201
2202
2203
2204                     <div class="long">
2205
2206                                 Logs to console if it can.
2207
2208
2209
2210
2211
2212
2213                                 <dl class="detailList">
2214                                 <dt class="heading">Parameters:</dt>
2215
2216                                         <dt>
2217                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>string</b>
2218
2219                                         </dt>
2220                                         <dd></dd>
2221
2222                                 </dl>
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234                     </div>
2235                 </div>
2236
2237             </td>
2238             <td class="msource">
2239
2240                         Roo
2241                 &nbsp;
2242             </td>
2243         </tr>
2244
2245
2246           <tr class="method-row config-row-alt1 expandable notInherited">
2247             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2248
2249
2250             <td class="sig">
2251                 <a id="Roo-method-namespace"   name=".namespace"></a>
2252                 <div class="fixedFont">
2253                         <span class="attributes">Roo.</span><b class="itemname">namespace</b>
2254
2255                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>namespace1</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>namespace2</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>etc</i></B>)
2256
2257
2258
2259                 </div>
2260                 <div class="mdesc">
2261
2262                    <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
2263
2264
2265
2266                     <div class="long">
2267
2268                                 Creates namespaces to be used for scoping variables and classes so that they are not global.  Usage:<br/><pre><code><br/>Roo.namespace('Company', 'Company.data');<br/>Company.Widget = function() { ... }<br/>Company.data.CustomStore = function(config) { ... }<br/></code></pre>
2269
2270
2271
2272
2273
2274
2275                                 <dl class="detailList">
2276                                 <dt class="heading">Parameters:</dt>
2277
2278                                         <dt>
2279                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace1</b>
2280
2281                                         </dt>
2282                                         <dd></dd>
2283
2284                                         <dt>
2285                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace2</b>
2286
2287                                         </dt>
2288                                         <dd></dd>
2289
2290                                         <dt>
2291                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>etc</b>
2292
2293                                         </dt>
2294                                         <dd></dd>
2295
2296                                 </dl>
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308                     </div>
2309                 </div>
2310
2311             </td>
2312             <td class="msource">
2313
2314                         Roo
2315                 &nbsp;
2316             </td>
2317         </tr>
2318
2319
2320           <tr class="method-row config-row-alt0 expandable notInherited">
2321             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2322
2323
2324             <td class="sig">
2325                 <a id="Roo-method-onReady"   name=".onReady"></a>
2326                 <div class="fixedFont">
2327                         <span class="attributes">Roo.</span><b class="itemname">onReady</b>
2328
2329                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, boolean <B><i>override</i></B>)
2330
2331
2332
2333                 </div>
2334                 <div class="mdesc">
2335
2336                    <div class="short">Fires when the document is ready (before onload and before images are loaded).</div>
2337
2338
2339
2340                     <div class="long">
2341
2342                                 Fires when the document is ready (before onload and before images are loaded).  Shorthand of {<b>link</b> Roo.EventManager<b>onDocumentReady</b>}.
2343
2344
2345
2346
2347
2348
2349                                 <dl class="detailList">
2350                                 <dt class="heading">Parameters:</dt>
2351
2352                                         <dt>
2353                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
2354
2355                                         </dt>
2356                                         <dd>The method the event invokes</dd>
2357
2358                                         <dt>
2359                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
2360
2361                                         </dt>
2362                                         <dd>An  object that becomes the scope of the handler</dd>
2363
2364                                         <dt>
2365                                                 <span class="fixedFont">boolean</span>  <b>override</b>
2366
2367                                         </dt>
2368                                         <dd>If true, the obj passed in becomes<br/>                            the execution scope of the listener</dd>
2369
2370                                 </dl>
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382                     </div>
2383                 </div>
2384
2385             </td>
2386             <td class="msource">
2387
2388                         Roo
2389                 &nbsp;
2390             </td>
2391         </tr>
2392
2393
2394           <tr class="method-row config-row-alt1 expandable notInherited">
2395             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2396
2397
2398             <td class="sig">
2399                 <a id="Roo-method-override"   name=".override"></a>
2400                 <div class="fixedFont">
2401                         <span class="attributes">Roo.</span><b class="itemname">override</b>
2402
2403                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>origclass</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>overrides</i></B>)
2404
2405
2406
2407                 </div>
2408                 <div class="mdesc">
2409
2410                    <div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.</div>
2411
2412
2413
2414                     <div class="long">
2415
2416                                 Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.<br/>Usage:<pre><code><br/>Roo.override(MyClass, {<br/>    newMethod1: function(){<br/>        // etc.<br/>    },<br/>    newMethod2: function(foo){<br/>        // etc.<br/>    }<br/>});<br/> </code></pre>
2417
2418
2419
2420
2421
2422
2423                                 <dl class="detailList">
2424                                 <dt class="heading">Parameters:</dt>
2425
2426                                         <dt>
2427                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>origclass</b>
2428
2429                                         </dt>
2430                                         <dd>The class to override</dd>
2431
2432                                         <dt>
2433                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>overrides</b>
2434
2435                                         </dt>
2436                                         <dd>The list of functions to add to origClass.  This should be specified as an object literal<br/>containing one or more methods.</dd>
2437
2438                                 </dl>
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450                     </div>
2451                 </div>
2452
2453             </td>
2454             <td class="msource">
2455
2456                         Roo
2457                 &nbsp;
2458             </td>
2459         </tr>
2460
2461
2462           <tr class="method-row config-row-alt0 expandable notInherited">
2463             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2464
2465
2466             <td class="sig">
2467                 <a id="Roo-method-query"   name=".query"></a>
2468                 <div class="fixedFont">
2469                         <span class="attributes">Roo.</span><b class="itemname">query</b>
2470
2471                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, Node <B><i>root</i></B>)
2472
2473
2474                                          :
2475
2476
2477                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2478
2479
2480
2481
2482
2483                 </div>
2484                 <div class="mdesc">
2485
2486                    <div class="short">Selects an array of DOM nodes by CSS/XPath selector.</div>
2487
2488
2489
2490                     <div class="long">
2491
2492                                 Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {<b>link</b> Roo.DomQuery<b>select</b>}
2493
2494
2495
2496
2497
2498
2499                                 <dl class="detailList">
2500                                 <dt class="heading">Parameters:</dt>
2501
2502                                         <dt>
2503                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>path</b>
2504
2505                                         </dt>
2506                                         <dd>The selector/xpath query</dd>
2507
2508                                         <dt>
2509                                                 <span class="fixedFont">Node</span>  <b>root</b>
2510
2511                                         </dt>
2512                                         <dd>(optional) The start of the query (defaults to document).</dd>
2513
2514                                 </dl>
2515
2516
2517
2518
2519
2520                                 <dl class="detailList">
2521                                 <dt class="heading">Returns:</dt>
2522
2523                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  </dd>
2524
2525                                 </dl>
2526
2527
2528
2529
2530
2531
2532
2533                     </div>
2534                 </div>
2535
2536             </td>
2537             <td class="msource">
2538
2539                         Roo
2540                 &nbsp;
2541             </td>
2542         </tr>
2543
2544
2545           <tr class="method-row config-row-alt1 expandable notInherited">
2546             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2547
2548
2549             <td class="sig">
2550                 <a id="Roo-method-select"   name=".select"></a>
2551                 <div class="fixedFont">
2552                         <span class="attributes">Roo.</span><b class="itemname">select</b>
2553
2554                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>selector</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>unique</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String <B><i>root</i></B>)
2555
2556
2557                                          :
2558
2559
2560                                                 CompositeElementLite/CompositeElement
2561
2562
2563
2564
2565
2566                 </div>
2567                 <div class="mdesc">
2568
2569                    <div class="short">Selects elements based on the passed CSS selector to enable working on them as 1.</div>
2570
2571
2572
2573                     <div class="long">
2574
2575                                 Selects elements based on the passed CSS selector to enable working on them as 1.
2576
2577
2578
2579
2580
2581
2582                                 <dl class="detailList">
2583                                 <dt class="heading">Parameters:</dt>
2584
2585                                         <dt>
2586                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>selector</b>
2587
2588                                         </dt>
2589                                         <dd>The CSS selector or an array of elements</dd>
2590
2591                                         <dt>
2592                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>unique</b>
2593
2594                                         </dt>
2595                                         <dd>(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)</dd>
2596
2597                                         <dt>
2598                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String</span>  <b>root</b>
2599
2600                                         </dt>
2601                                         <dd>(optional) The root element of the query or id of the root</dd>
2602
2603                                 </dl>
2604
2605
2606
2607
2608
2609                                 <dl class="detailList">
2610                                 <dt class="heading">Returns:</dt>
2611
2612                                         <dd><span class="fixedFont">CompositeElementLite/CompositeElement</span>  </dd>
2613
2614                                 </dl>
2615
2616
2617
2618
2619
2620
2621
2622                     </div>
2623                 </div>
2624
2625             </td>
2626             <td class="msource">
2627
2628                         Roo
2629                 &nbsp;
2630             </td>
2631         </tr>
2632
2633
2634           <tr class="method-row config-row-alt0 expandable notInherited">
2635             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2636
2637
2638             <td class="sig">
2639                 <a id="Roo-method-selectNode"   name=".selectNode"></a>
2640                 <div class="fixedFont">
2641                         <span class="attributes">Roo.</span><b class="itemname">selectNode</b>
2642
2643                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>selector</i></B>, Node <B><i>root</i></B>)
2644
2645
2646                                          :
2647
2648
2649                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
2650
2651
2652
2653
2654
2655                 </div>
2656                 <div class="mdesc">
2657
2658                    <div class="short">Selects a single element as a Roo Element<br/>This is about as close as you can get to jQuery's $('do crazy stuff')</div>
2659
2660
2661
2662                     <div class="long">
2663
2664                                 Selects a single element as a Roo Element<br/>This is about as close as you can get to jQuery's $('do crazy stuff')
2665
2666
2667
2668
2669
2670
2671                                 <dl class="detailList">
2672                                 <dt class="heading">Parameters:</dt>
2673
2674                                         <dt>
2675                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>selector</b>
2676
2677                                         </dt>
2678                                         <dd>The selector/xpath query</dd>
2679
2680                                         <dt>
2681                                                 <span class="fixedFont">Node</span>  <b>root</b>
2682
2683                                         </dt>
2684                                         <dd>(optional) The start of the query (defaults to document).</dd>
2685
2686                                 </dl>
2687
2688
2689
2690
2691
2692                                 <dl class="detailList">
2693                                 <dt class="heading">Returns:</dt>
2694
2695                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
2696
2697                                 </dl>
2698
2699
2700
2701
2702
2703
2704
2705                     </div>
2706                 </div>
2707
2708             </td>
2709             <td class="msource">
2710
2711                         Roo
2712                 &nbsp;
2713             </td>
2714         </tr>
2715
2716
2717           <tr class="method-row config-row-alt1 expandable notInherited">
2718             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2719
2720
2721             <td class="sig">
2722                 <a id="Roo-method-type"   name=".type"></a>
2723                 <div class="fixedFont">
2724                         <span class="attributes">Roo.</span><b class="itemname">type</b>
2725
2726                                  (Mixed <B><i>object</i></B>)
2727
2728
2729                                          :
2730
2731
2732                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2733
2734
2735
2736
2737
2738                 </div>
2739                 <div class="mdesc">
2740
2741                    <div class="short">Returns the type of object that is passed in.</div>
2742
2743
2744
2745                     <div class="long">
2746
2747                                 Returns the type of object that is passed in. If the object passed in is null or undefined it<br/>return false otherwise it returns one of the following values:<ul><br/><li><b>string</b>: If the object passed is a string</li><br/><li><b>number</b>: If the object passed is a number</li><br/><li><b>boolean</b>: If the object passed is a boolean value</li><br/><li><b>function</b>: If the object passed is a function reference</li><br/><li><b>object</b>: If the object passed is an object</li><br/><li><b>array</b>: If the object passed is an array</li><br/><li><b>regexp</b>: If the object passed is a regular expression</li><br/><li><b>element</b>: If the object passed is a DOM Element</li><br/><li><b>nodelist</b>: If the object passed is a DOM NodeList</li><br/><li><b>textnode</b>: If the object passed is a DOM text node and contains something other than whitespace</li><br/><li><b>whitespace</b>: If the object passed is a DOM text node and contains only whitespace</li>
2748
2749
2750
2751
2752
2753
2754                                 <dl class="detailList">
2755                                 <dt class="heading">Parameters:</dt>
2756
2757                                         <dt>
2758                                                 <span class="fixedFont">Mixed</span>  <b>object</b>
2759
2760                                         </dt>
2761                                         <dd></dd>
2762
2763                                 </dl>
2764
2765
2766
2767
2768
2769                                 <dl class="detailList">
2770                                 <dt class="heading">Returns:</dt>
2771
2772                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
2773
2774                                 </dl>
2775
2776
2777
2778
2779
2780
2781
2782                     </div>
2783                 </div>
2784
2785             </td>
2786             <td class="msource">
2787
2788                         Roo
2789                 &nbsp;
2790             </td>
2791         </tr>
2792
2793
2794           <tr class="method-row config-row-alt0 expandable notInherited">
2795             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2796
2797
2798             <td class="sig">
2799                 <a id="Roo-method-urlDecode"   name=".urlDecode"></a>
2800                 <div class="fixedFont">
2801                         <span class="attributes">Roo.</span><b class="itemname">urlDecode</b>
2802
2803                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>string</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>overwrite</i></B>)
2804
2805
2806                                          :
2807
2808
2809                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2810
2811
2812
2813
2814
2815                 </div>
2816                 <div class="mdesc">
2817
2818                    <div class="short">Takes an encoded URL and and converts it to an object.</div>
2819
2820
2821
2822                     <div class="long">
2823
2824                                 Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode("foo=1&bar=2"); would return {foo: 1, bar: 2} or Roo.urlDecode("foo=1&bar=2&bar=3&bar=4", true); would return {foo: 1, bar: [2, 3, 4]}.
2825
2826
2827
2828
2829
2830
2831                                 <dl class="detailList">
2832                                 <dt class="heading">Parameters:</dt>
2833
2834                                         <dt>
2835                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>string</b>
2836
2837                                         </dt>
2838                                         <dd></dd>
2839
2840                                         <dt>
2841                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>overwrite</b>
2842
2843                                         </dt>
2844                                         <dd>(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).</dd>
2845
2846                                 </dl>
2847
2848
2849
2850
2851
2852                                 <dl class="detailList">
2853                                 <dt class="heading">Returns:</dt>
2854
2855                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  A literal with members</dd>
2856
2857                                 </dl>
2858
2859
2860
2861
2862
2863
2864
2865                     </div>
2866                 </div>
2867
2868             </td>
2869             <td class="msource">
2870
2871                         Roo
2872                 &nbsp;
2873             </td>
2874         </tr>
2875
2876
2877           <tr class="method-row config-row-alt1 expandable notInherited">
2878             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2879
2880
2881             <td class="sig">
2882                 <a id="Roo-method-urlEncode"   name=".urlEncode"></a>
2883                 <div class="fixedFont">
2884                         <span class="attributes">Roo.</span><b class="itemname">urlEncode</b>
2885
2886                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
2887
2888
2889                                          :
2890
2891
2892                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2893
2894
2895
2896
2897
2898                 </div>
2899                 <div class="mdesc">
2900
2901                    <div class="short">Takes an object and converts it to an encoded URL.</div>
2902
2903
2904
2905                     <div class="long">
2906
2907                                 Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return "foo=1&bar=2".  Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.
2908
2909
2910
2911
2912
2913
2914                                 <dl class="detailList">
2915                                 <dt class="heading">Parameters:</dt>
2916
2917                                         <dt>
2918                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>o</b>
2919
2920                                         </dt>
2921                                         <dd></dd>
2922
2923                                 </dl>
2924
2925
2926
2927
2928
2929                                 <dl class="detailList">
2930                                 <dt class="heading">Returns:</dt>
2931
2932                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
2933
2934                                 </dl>
2935
2936
2937
2938
2939
2940
2941
2942                     </div>
2943                 </div>
2944
2945             </td>
2946             <td class="msource">
2947
2948                         Roo
2949                 &nbsp;
2950             </td>
2951         </tr>
2952
2953
2954     </table>
2955
2956
2957   <!-- ============================== events summary / details ======================== -->
2958
2959
2960   <a id="Roo-events"></a>
2961
2962
2963
2964
2965
2966      <table cellspacing="0" class="member-table">
2967       <caption class="Empty">Events - Has None</caption>
2968      </table>
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978 <!-- ============================== footer ================================= -->
2979                 <div class="fineprint" style="clear:both">
2980
2981                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Thu Feb 05 2015 18:22:25 GMT+0800 (HKT)
2982                         Based on
2983                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
2984                 </div>
2985         </body>
2986 </html>