git.roojs.org Git - roojs1/blob - docs.old/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-isAndroid" name=".isAndroid"></a>
 417                <div class="fixedFont">
 418                     <span class="attributes">Roo.</span><b  class="itemname">isAndroid</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-isBorderBox" name=".isBorderBox"></a>
 456                <div class="fixedFont">
 457                     <span class="attributes">Roo.</span><b  class="itemname">isBorderBox</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-isEdge" name=".isEdge"></a>
 495                <div class="fixedFont">
 496                     <span class="attributes">Roo.</span><b  class="itemname">isEdge</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-isFirefox" name=".isFirefox"></a>
 534                <div class="fixedFont">
 535                     <span class="attributes">Roo.</span><b  class="itemname">isFirefox</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-isGecko" name=".isGecko"></a>
 573                <div class="fixedFont">
 574                     <span class="attributes">Roo.</span><b  class="itemname">isGecko</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-isIE" name=".isIE"></a>
 612                <div class="fixedFont">
 613                     <span class="attributes">Roo.</span><b  class="itemname">isIE</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-isIE11" name=".isIE11"></a>
 651                <div class="fixedFont">
 652                     <span class="attributes">Roo.</span><b  class="itemname">isIE11</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-isIE7" name=".isIE7"></a>
 690                <div class="fixedFont">
 691                     <span class="attributes">Roo.</span><b  class="itemname">isIE7</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
 701
 702
 703
 704                    </div>
 705
 706                     <div class="long">
 707
 708
 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-isIOS" name=".isIOS"></a>
 729                <div class="fixedFont">
 730                     <span class="attributes">Roo.</span><b  class="itemname">isIOS</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-isLinux" name=".isLinux"></a>
 768                <div class="fixedFont">
 769                     <span class="attributes">Roo.</span><b  class="itemname">isLinux</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
 779
 780
 781
 782                    </div>
 783
 784                     <div class="long">
 785
 786
 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-isMac" name=".isMac"></a>
 807                <div class="fixedFont">
 808                     <span class="attributes">Roo.</span><b  class="itemname">isMac</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
 818
 819
 820
 821                    </div>
 822
 823                     <div class="long">
 824
 825
 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-isOpera" name=".isOpera"></a>
 846                <div class="fixedFont">
 847                     <span class="attributes">Roo.</span><b  class="itemname">isOpera</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-isReady" name=".isReady"></a>
 885                <div class="fixedFont">
 886                     <span class="attributes">Roo.</span><b  class="itemname">isReady</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                         True when the document is fully initialized and ready for action
 896
 897
 898
 899                    </div>
 900
 901                     <div class="long">
 902
 903                         True when the document is fully initialized and ready for action
 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-isSafari" name=".isSafari"></a>
 924                <div class="fixedFont">
 925                     <span class="attributes">Roo.</span><b  class="itemname">isSafari</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
 935
 936
 937
 938                    </div>
 939
 940                     <div class="long">
 941
 942
 943
 944                 </div>
 945                 </div>
 946             </td>
 947
 948             <td class="msource">
 949             Roo
 950             </td>
 951
 952           </tr>
 953
 954
 955
 956
 957           <tr class="property-row config-row-alt1 notInherited">
 958             <td class="micon">
 959                 <a class="exi" href="#expand">&nbsp;</a>
 960             </td>
 961             <td class="sig">
 962                <a id="Roo-prop-isSecure" name=".isSecure"></a>
 963                <div class="fixedFont">
 964                     <span class="attributes">Roo.</span><b  class="itemname">isSecure</b> :
 965                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 966                      </div>
 967             </td>
 968             <td class="sig">
 969                 <div class="mdesc">
 970
 971
 972                    <div class="short">
 973                         True if the page is running over SSL
 974
 975
 976
 977                    </div>
 978
 979                     <div class="long">
 980
 981                         True if the page is running over SSL
 982
 983                 </div>
 984                 </div>
 985             </td>
 986
 987             <td class="msource">
 988             Roo
 989             </td>
 990
 991           </tr>
 992
 993
 994
 995
 996           <tr class="property-row config-row-alt0 notInherited">
 997             <td class="micon">
 998                 <a class="exi" href="#expand">&nbsp;</a>
 999             </td>
1000             <td class="sig">
1001                <a id="Roo-prop-isStrict" name=".isStrict"></a>
1002                <div class="fixedFont">
1003                     <span class="attributes">Roo.</span><b  class="itemname">isStrict</b> :
1004                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
1005                      </div>
1006             </td>
1007             <td class="sig">
1008                 <div class="mdesc">
1009
1010
1011                    <div class="short">
1012                         True if the browser is in strict mode
1013
1014
1015
1016                    </div>
1017
1018                     <div class="long">
1019
1020                         True if the browser is in strict mode
1021
1022                 </div>
1023                 </div>
1024             </td>
1025
1026             <td class="msource">
1027             Roo
1028             </td>
1029
1030           </tr>
1031
1032
1033
1034
1035           <tr class="property-row config-row-alt1 notInherited">
1036             <td class="micon">
1037                 <a class="exi" href="#expand">&nbsp;</a>
1038             </td>
1039             <td class="sig">
1040                <a id="Roo-prop-isTouch" name=".isTouch"></a>
1041                <div class="fixedFont">
1042                     <span class="attributes">Roo.</span><b  class="itemname">isTouch</b> :
1043                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
1044                      </div>
1045             </td>
1046             <td class="sig">
1047                 <div class="mdesc">
1048
1049
1050                    <div class="short">
1051
1052
1053
1054
1055                    </div>
1056
1057                     <div class="long">
1058
1059
1060
1061                 </div>
1062                 </div>
1063             </td>
1064
1065             <td class="msource">
1066             Roo
1067             </td>
1068
1069           </tr>
1070
1071
1072
1073
1074           <tr class="property-row config-row-alt0 notInherited">
1075             <td class="micon">
1076                 <a class="exi" href="#expand">&nbsp;</a>
1077             </td>
1078             <td class="sig">
1079                <a id="Roo-prop-isWindows" name=".isWindows"></a>
1080                <div class="fixedFont">
1081                     <span class="attributes">Roo.</span><b  class="itemname">isWindows</b> :
1082                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
1083                      </div>
1084             </td>
1085             <td class="sig">
1086                 <div class="mdesc">
1087
1088
1089                    <div class="short">
1090
1091
1092
1093
1094                    </div>
1095
1096                     <div class="long">
1097
1098
1099
1100                 </div>
1101                 </div>
1102             </td>
1103
1104             <td class="msource">
1105             Roo
1106             </td>
1107
1108           </tr>
1109
1110
1111
1112
1113           <tr class="property-row config-row-alt1 notInherited">
1114             <td class="micon">
1115                 <a class="exi" href="#expand">&nbsp;</a>
1116             </td>
1117             <td class="sig">
1118                <a id="Roo-prop-log" name=".log"></a>
1119                <div class="fixedFont">
1120                     <span class="attributes">Roo.</span><b  class="itemname">log</b> :
1121                      <span type="etype"><a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a></span>
1122                      </div>
1123             </td>
1124             <td class="sig">
1125                 <div class="mdesc">
1126
1127
1128                    <div class="short">
1129                         The SplitBar for this region
1130
1131
1132
1133                    </div>
1134
1135                     <div class="long">
1136
1137                         The SplitBar for this region
1138
1139                 </div>
1140                 </div>
1141             </td>
1142
1143             <td class="msource">
1144             Roo
1145             </td>
1146
1147           </tr>
1148
1149
1150
1151
1152           <tr class="property-row config-row-alt0 notInherited">
1153             <td class="micon">
1154                 <a class="exi" href="#expand">&nbsp;</a>
1155             </td>
1156             <td class="sig">
1157                <a id="Roo-prop-useShims" name=".useShims"></a>
1158                <div class="fixedFont">
1159                     <span class="attributes">Roo.</span><b  class="itemname">useShims</b> :
1160                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
1161                      </div>
1162             </td>
1163             <td class="sig">
1164                 <div class="mdesc">
1165
1166
1167                    <div class="short">
1168                         By default, Ext intelligently decides whether floating elements should be shimmed.
1169
1170
1171
1172                    </div>
1173
1174                     <div class="long">
1175
1176                         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.
1177
1178                 </div>
1179                 </div>
1180             </td>
1181
1182             <td class="msource">
1183             Roo
1184             </td>
1185
1186           </tr>
1187
1188
1189
1190
1191
1192         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
1193         <tr class="property-row alt">
1194
1195         -->
1196
1197     </table>
1198
1199
1200   <!-- ============================== methods summary / details ======================== -->
1201
1202
1203   <a id="Roo-methods"></a>
1204         <!-- constructor?? -->
1205
1206         <!-- static's first
1207
1208
1209         -->
1210
1211         <!-- then dynamics first -->
1212
1213
1214
1215
1216
1217
1218       <table cellspacing="0" class="member-table">
1219       <caption>Public Methods</caption>
1220         <tr>
1221             <th class="sig-header" colspan="2">Method</th>
1222             <th class="msource-header">Defined By</th>
1223
1224         </tr>
1225
1226
1227
1228
1229
1230
1231
1232           <tr class="method-row config-row-alt0 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-addBehaviors"   name=".addBehaviors"></a>
1238                 <div class="fixedFont">
1239                         <span class="attributes">Roo.</span><b class="itemname">addBehaviors</b>
1240
1241                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>)
1242
1243
1244
1245                 </div>
1246                 <div class="mdesc">
1247
1248                    <div class="short">Applies event listeners to elements by selectors when the document is ready.</div>
1249
1250
1251
1252                     <div class="long">
1253
1254                                 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>
1255
1256
1257
1258
1259
1260
1261                                 <dl class="detailList">
1262                                 <dt class="heading">Parameters:</dt>
1263
1264                                         <dt>
1265                                                 <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>
1266
1267                                         </dt>
1268                                         <dd>The list of behaviors to apply</dd>
1269
1270                                 </dl>
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282                     </div>
1283                 </div>
1284
1285             </td>
1286             <td class="msource">
1287
1288                         Roo
1289                 &nbsp;
1290             </td>
1291         </tr>
1292
1293
1294           <tr class="method-row config-row-alt1 expandable notInherited">
1295             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1296
1297
1298             <td class="sig">
1299                 <a id="Roo-method-apply"   name=".apply"></a>
1300                 <div class="fixedFont">
1301                         <span class="attributes">Roo.</span><b class="itemname">apply</b>
1302
1303                                  (<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>)
1304
1305
1306                                          :
1307
1308
1309                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1310
1311
1312
1313
1314
1315                 </div>
1316                 <div class="mdesc">
1317
1318                    <div class="short">Copies all the properties of config to obj.</div>
1319
1320
1321
1322                     <div class="long">
1323
1324                                 Copies all the properties of config to obj.
1325
1326
1327
1328
1329
1330
1331                                 <dl class="detailList">
1332                                 <dt class="heading">Parameters:</dt>
1333
1334                                         <dt>
1335                                                 <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>
1336
1337                                         </dt>
1338                                         <dd>The receiver of the properties</dd>
1339
1340                                         <dt>
1341                                                 <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>
1342
1343                                         </dt>
1344                                         <dd>The source of the properties</dd>
1345
1346                                         <dt>
1347                                                 <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>
1348
1349                                         </dt>
1350                                         <dd>A different object that will also be applied for default values</dd>
1351
1352                                 </dl>
1353
1354
1355
1356
1357
1358                                 <dl class="detailList">
1359                                 <dt class="heading">Returns:</dt>
1360
1361                                         <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>
1362
1363                                 </dl>
1364
1365
1366
1367
1368
1369
1370
1371                     </div>
1372                 </div>
1373
1374             </td>
1375             <td class="msource">
1376
1377                         Roo
1378                 &nbsp;
1379             </td>
1380         </tr>
1381
1382
1383           <tr class="method-row config-row-alt0 expandable notInherited">
1384             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1385
1386
1387             <td class="sig">
1388                 <a id="Roo-method-applyIf"   name=".applyIf"></a>
1389                 <div class="fixedFont">
1390                         <span class="attributes">Roo.</span><b class="itemname">applyIf</b>
1391
1392                                  (<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>)
1393
1394
1395                                          :
1396
1397
1398                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1399
1400
1401
1402
1403
1404                 </div>
1405                 <div class="mdesc">
1406
1407                    <div class="short">Copies all the properties of config to obj if they don't already exist.</div>
1408
1409
1410
1411                     <div class="long">
1412
1413                                 Copies all the properties of config to obj if they don't already exist.
1414
1415
1416
1417
1418
1419
1420                                 <dl class="detailList">
1421                                 <dt class="heading">Parameters:</dt>
1422
1423                                         <dt>
1424                                                 <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>
1425
1426                                         </dt>
1427                                         <dd>The receiver of the properties</dd>
1428
1429                                         <dt>
1430                                                 <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>
1431
1432                                         </dt>
1433                                         <dd>The source of the properties</dd>
1434
1435                                 </dl>
1436
1437
1438
1439
1440
1441                                 <dl class="detailList">
1442                                 <dt class="heading">Returns:</dt>
1443
1444                                         <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>
1445
1446                                 </dl>
1447
1448
1449
1450
1451
1452
1453
1454                     </div>
1455                 </div>
1456
1457             </td>
1458             <td class="msource">
1459
1460                         Roo
1461                 &nbsp;
1462             </td>
1463         </tr>
1464
1465
1466           <tr class="method-row config-row-alt1 expandable notInherited">
1467             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1468
1469
1470             <td class="sig">
1471                 <a id="Roo-method-decode"   name=".decode"></a>
1472                 <div class="fixedFont">
1473                         <span class="attributes">Roo.</span><b class="itemname">decode</b>
1474
1475                                  ()
1476
1477
1478
1479                 </div>
1480                 <div class="mdesc">
1481
1482                    <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}</div>
1483
1484
1485
1486                     <div class="long">
1487
1488                                 Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505                     </div>
1506                 </div>
1507
1508             </td>
1509             <td class="msource">
1510
1511                         Roo
1512                 &nbsp;
1513             </td>
1514         </tr>
1515
1516
1517           <tr class="method-row config-row-alt0 expandable notInherited">
1518             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1519
1520
1521             <td class="sig">
1522                 <a id="Roo-method-each"   name=".each"></a>
1523                 <div class="fixedFont">
1524                         <span class="attributes">Roo.</span><b class="itemname">each</b>
1525
1526                                  (<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>)
1527
1528
1529
1530                 </div>
1531                 <div class="mdesc">
1532
1533                    <div class="short">Iterates an array calling the passed function with each item, stopping if your function returns false.</div>
1534
1535
1536
1537                     <div class="long">
1538
1539                                 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).
1540
1541
1542
1543
1544
1545
1546                                 <dl class="detailList">
1547                                 <dt class="heading">Parameters:</dt>
1548
1549                                         <dt>
1550                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed</span>  <b>array</b>
1551
1552                                         </dt>
1553                                         <dd></dd>
1554
1555                                         <dt>
1556                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
1557
1558                                         </dt>
1559                                         <dd></dd>
1560
1561                                         <dt>
1562                                                 <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>
1563
1564                                         </dt>
1565                                         <dd></dd>
1566
1567                                 </dl>
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579                     </div>
1580                 </div>
1581
1582             </td>
1583             <td class="msource">
1584
1585                         Roo
1586                 &nbsp;
1587             </td>
1588         </tr>
1589
1590
1591           <tr class="method-row config-row-alt1 expandable notInherited">
1592             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1593
1594
1595             <td class="sig">
1596                 <a id="Roo-method-encode"   name=".encode"></a>
1597                 <div class="fixedFont">
1598                         <span class="attributes">Roo.</span><b class="itemname">encode</b>
1599
1600                                  ()
1601
1602
1603
1604                 </div>
1605                 <div class="mdesc">
1606
1607                    <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}</div>
1608
1609
1610
1611                     <div class="long">
1612
1613                                 Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630                     </div>
1631                 </div>
1632
1633             </td>
1634             <td class="msource">
1635
1636                         Roo
1637                 &nbsp;
1638             </td>
1639         </tr>
1640
1641
1642           <tr class="method-row config-row-alt0 expandable notInherited">
1643             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1644
1645
1646             <td class="sig">
1647                 <a id="Roo-method-encodeURIComponent"   name=".encodeURIComponent"></a>
1648                 <div class="fixedFont">
1649                         <span class="attributes">Roo.</span><b class="itemname">encodeURIComponent</b>
1650
1651                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>data</i></B>)
1652
1653
1654                                          :
1655
1656
1657                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1658
1659
1660
1661
1662
1663                 </div>
1664                 <div class="mdesc">
1665
1666                    <div class="short">Safe version of encodeURIComponent</div>
1667
1668
1669
1670                     <div class="long">
1671
1672                                 Safe version of encodeURIComponent
1673
1674
1675
1676
1677
1678
1679                                 <dl class="detailList">
1680                                 <dt class="heading">Parameters:</dt>
1681
1682                                         <dt>
1683                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>data</b>
1684
1685                                         </dt>
1686                                         <dd></dd>
1687
1688                                 </dl>
1689
1690
1691
1692
1693
1694                                 <dl class="detailList">
1695                                 <dt class="heading">Returns:</dt>
1696
1697                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
1698
1699                                 </dl>
1700
1701
1702
1703
1704
1705
1706
1707                     </div>
1708                 </div>
1709
1710             </td>
1711             <td class="msource">
1712
1713                         Roo
1714                 &nbsp;
1715             </td>
1716         </tr>
1717
1718
1719           <tr class="method-row config-row-alt1 expandable notInherited">
1720             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1721
1722
1723             <td class="sig">
1724                 <a id="Roo-method-escapeRe"   name=".escapeRe"></a>
1725                 <div class="fixedFont">
1726                         <span class="attributes">Roo.</span><b class="itemname">escapeRe</b>
1727
1728                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>str</i></B>)
1729
1730
1731                                          :
1732
1733
1734                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1735
1736
1737
1738
1739
1740                 </div>
1741                 <div class="mdesc">
1742
1743                    <div class="short">Escapes the passed string for use in a regular expression</div>
1744
1745
1746
1747                     <div class="long">
1748
1749                                 Escapes the passed string for use in a regular expression
1750
1751
1752
1753
1754
1755
1756                                 <dl class="detailList">
1757                                 <dt class="heading">Parameters:</dt>
1758
1759                                         <dt>
1760                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>str</b>
1761
1762                                         </dt>
1763                                         <dd></dd>
1764
1765                                 </dl>
1766
1767
1768
1769
1770
1771                                 <dl class="detailList">
1772                                 <dt class="heading">Returns:</dt>
1773
1774                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
1775
1776                                 </dl>
1777
1778
1779
1780
1781
1782
1783
1784                     </div>
1785                 </div>
1786
1787             </td>
1788             <td class="msource">
1789
1790                         Roo
1791                 &nbsp;
1792             </td>
1793         </tr>
1794
1795
1796           <tr class="method-row config-row-alt0 expandable notInherited">
1797             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1798
1799
1800             <td class="sig">
1801                 <a id="Roo-method-extend"   name=".extend"></a>
1802                 <div class="fixedFont">
1803                         <span class="attributes">Roo.</span><b class="itemname">extend</b>
1804
1805                                  (<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>)
1806
1807
1808
1809                 </div>
1810                 <div class="mdesc">
1811
1812                    <div class="short">Extends one class with another class and optionally overrides members with the passed literal.</div>
1813
1814
1815
1816                     <div class="long">
1817
1818                                 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.
1819
1820
1821
1822
1823
1824
1825                                 <dl class="detailList">
1826                                 <dt class="heading">Parameters:</dt>
1827
1828                                         <dt>
1829                                                 <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>
1830
1831                                         </dt>
1832                                         <dd>The class inheriting the functionality</dd>
1833
1834                                         <dt>
1835                                                 <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>
1836
1837                                         </dt>
1838                                         <dd>The class being extended</dd>
1839
1840                                         <dt>
1841                                                 <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>
1842
1843                                         </dt>
1844                                         <dd>(optional) A literal with members</dd>
1845
1846                                 </dl>
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858                     </div>
1859                 </div>
1860
1861             </td>
1862             <td class="msource">
1863
1864                         Roo
1865                 &nbsp;
1866             </td>
1867         </tr>
1868
1869
1870           <tr class="method-row config-row-alt1 expandable notInherited">
1871             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1872
1873
1874             <td class="sig">
1875                 <a id="Roo-method-factory"   name=".factory"></a>
1876                 <div class="fixedFont">
1877                         <span class="attributes">Roo.</span><b class="itemname">factory</b>
1878
1879                                  (<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>)
1880
1881
1882
1883                 </div>
1884                 <div class="mdesc">
1885
1886                    <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
1887
1888
1889
1890                     <div class="long">
1891
1892                                 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>
1893
1894
1895
1896
1897
1898
1899                                 <dl class="detailList">
1900                                 <dt class="heading">Parameters:</dt>
1901
1902                                         <dt>
1903                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>classname</b>
1904
1905                                         </dt>
1906                                         <dd></dd>
1907
1908                                         <dt>
1909                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace</b>
1910
1911                                         </dt>
1912                                         <dd>(optional)</dd>
1913
1914                                 </dl>
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926                     </div>
1927                 </div>
1928
1929             </td>
1930             <td class="msource">
1931
1932                         Roo
1933                 &nbsp;
1934             </td>
1935         </tr>
1936
1937
1938           <tr class="method-row config-row-alt0 expandable notInherited">
1939             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1940
1941
1942             <td class="sig">
1943                 <a id="Roo-method-fly"   name=".fly"></a>
1944                 <div class="fixedFont">
1945                         <span class="attributes">Roo.</span><b class="itemname">fly</b>
1946
1947                                  (<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>)
1948
1949
1950                                          :
1951
1952
1953                                                 Element
1954
1955
1956
1957
1958
1959                 </div>
1960                 <div class="mdesc">
1961
1962                    <div class="short">Gets the globally shared flyweight Element, with the passed node as the active element.</div>
1963
1964
1965
1966                     <div class="long">
1967
1968                                 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>}
1969
1970
1971
1972
1973
1974
1975                                 <dl class="detailList">
1976                                 <dt class="heading">Parameters:</dt>
1977
1978                                         <dt>
1979                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
1980
1981                                         </dt>
1982                                         <dd>The dom node or id</dd>
1983
1984                                         <dt>
1985                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>named</b>
1986
1987                                         </dt>
1988                                         <dd>(optional) Allows for creation of named reusable flyweights to<br/>                                 prevent conflicts (e.g. internally Roo uses "_internal")</dd>
1989
1990                                 </dl>
1991
1992
1993
1994
1995
1996                                 <dl class="detailList">
1997                                 <dt class="heading">Returns:</dt>
1998
1999                                         <dd><span class="fixedFont">Element</span>  The shared Element object</dd>
2000
2001                                 </dl>
2002
2003
2004
2005
2006
2007
2008
2009                     </div>
2010                 </div>
2011
2012             </td>
2013             <td class="msource">
2014
2015                         Roo
2016                 &nbsp;
2017             </td>
2018         </tr>
2019
2020
2021           <tr class="method-row config-row-alt1 expandable notInherited">
2022             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2023
2024
2025             <td class="sig">
2026                 <a id="Roo-method-get"   name=".get"></a>
2027                 <div class="fixedFont">
2028                         <span class="attributes">Roo.</span><b class="itemname">get</b>
2029
2030                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
2031
2032
2033                                          :
2034
2035
2036                                                 Element
2037
2038
2039
2040
2041
2042                 </div>
2043                 <div class="mdesc">
2044
2045                    <div class="short">Static method to retrieve Element objects.</div>
2046
2047
2048
2049                     <div class="long">
2050
2051                                 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>}
2052
2053
2054
2055
2056
2057
2058                                 <dl class="detailList">
2059                                 <dt class="heading">Parameters:</dt>
2060
2061                                         <dt>
2062                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
2063
2064                                         </dt>
2065                                         <dd>The id of the node, a DOM Node or an existing Element.</dd>
2066
2067                                 </dl>
2068
2069
2070
2071
2072
2073                                 <dl class="detailList">
2074                                 <dt class="heading">Returns:</dt>
2075
2076                                         <dd><span class="fixedFont">Element</span>  The Element object</dd>
2077
2078                                 </dl>
2079
2080
2081
2082
2083
2084
2085
2086                     </div>
2087                 </div>
2088
2089             </td>
2090             <td class="msource">
2091
2092                         Roo
2093                 &nbsp;
2094             </td>
2095         </tr>
2096
2097
2098           <tr class="method-row config-row-alt0 expandable notInherited">
2099             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2100
2101
2102             <td class="sig">
2103                 <a id="Roo-method-getCmp"   name=".getCmp"></a>
2104                 <div class="fixedFont">
2105                         <span class="attributes">Roo.</span><b class="itemname">getCmp</b>
2106
2107                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
2108
2109
2110                                          :
2111
2112
2113
2114
2115
2116
2117
2118
2119                 </div>
2120                 <div class="mdesc">
2121
2122                    <div class="short">Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}</div>
2123
2124
2125
2126                     <div class="long">
2127
2128                                 Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}
2129
2130
2131
2132
2133
2134
2135                                 <dl class="detailList">
2136                                 <dt class="heading">Parameters:</dt>
2137
2138                                         <dt>
2139                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
2140
2141                                         </dt>
2142                                         <dd></dd>
2143
2144                                 </dl>
2145
2146
2147
2148
2149
2150                                 <dl class="detailList">
2151                                 <dt class="heading">Returns:</dt>
2152
2153                                         <dd> Roo.Component</dd>
2154
2155                                 </dl>
2156
2157
2158
2159
2160
2161
2162
2163                     </div>
2164                 </div>
2165
2166             </td>
2167             <td class="msource">
2168
2169                         Roo
2170                 &nbsp;
2171             </td>
2172         </tr>
2173
2174
2175           <tr class="method-row config-row-alt1 expandable notInherited">
2176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2177
2178
2179             <td class="sig">
2180                 <a id="Roo-method-getDom"   name=".getDom"></a>
2181                 <div class="fixedFont">
2182                         <span class="attributes">Roo.</span><b class="itemname">getDom</b>
2183
2184                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>)
2185
2186
2187                                          :
2188
2189
2190
2191
2192
2193
2194
2195
2196                 </div>
2197                 <div class="mdesc">
2198
2199                    <div class="short">Return the dom node for the passed string (id), dom node, or Roo.Element</div>
2200
2201
2202
2203                     <div class="long">
2204
2205                                 Return the dom node for the passed string (id), dom node, or Roo.Element
2206
2207
2208
2209
2210
2211
2212                                 <dl class="detailList">
2213                                 <dt class="heading">Parameters:</dt>
2214
2215                                         <dt>
2216                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
2217
2218                                         </dt>
2219                                         <dd></dd>
2220
2221                                 </dl>
2222
2223
2224
2225
2226
2227                                 <dl class="detailList">
2228                                 <dt class="heading">Returns:</dt>
2229
2230                                         <dd> HTMLElement</dd>
2231
2232                                 </dl>
2233
2234
2235
2236
2237
2238
2239
2240                     </div>
2241                 </div>
2242
2243             </td>
2244             <td class="msource">
2245
2246                         Roo
2247                 &nbsp;
2248             </td>
2249         </tr>
2250
2251
2252           <tr class="method-row config-row-alt0 expandable notInherited">
2253             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2254
2255
2256             <td class="sig">
2257                 <a id="Roo-method-id"   name=".id"></a>
2258                 <div class="fixedFont">
2259                         <span class="attributes">Roo.</span><b class="itemname">id</b>
2260
2261                                  (<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>)
2262
2263
2264                                          :
2265
2266
2267                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2268
2269
2270
2271
2272
2273                 </div>
2274                 <div class="mdesc">
2275
2276                    <div class="short">Generates unique ids.</div>
2277
2278
2279
2280                     <div class="long">
2281
2282                                 Generates unique ids. If the element already has an id, it is unchanged
2283
2284
2285
2286
2287
2288
2289                                 <dl class="detailList">
2290                                 <dt class="heading">Parameters:</dt>
2291
2292                                         <dt>
2293                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
2294
2295                                         </dt>
2296                                         <dd>(optional) The element to generate an id for</dd>
2297
2298                                         <dt>
2299                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>prefix</b>
2300
2301                                         </dt>
2302                                         <dd>(optional) Id prefix (defaults "Roo-gen")</dd>
2303
2304                                 </dl>
2305
2306
2307
2308
2309
2310                                 <dl class="detailList">
2311                                 <dt class="heading">Returns:</dt>
2312
2313                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The generated Id.</dd>
2314
2315                                 </dl>
2316
2317
2318
2319
2320
2321
2322
2323                     </div>
2324                 </div>
2325
2326             </td>
2327             <td class="msource">
2328
2329                         Roo
2330                 &nbsp;
2331             </td>
2332         </tr>
2333
2334
2335           <tr class="method-row config-row-alt1 expandable notInherited">
2336             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2337
2338
2339             <td class="sig">
2340                 <a id="Roo-method-isEmpty"   name=".isEmpty"></a>
2341                 <div class="fixedFont">
2342                         <span class="attributes">Roo.</span><b class="itemname">isEmpty</b>
2343
2344                                  (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>)
2345
2346
2347                                          :
2348
2349
2350                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2351
2352
2353
2354
2355
2356                 </div>
2357                 <div class="mdesc">
2358
2359                    <div class="short">Returns true if the passed value is null, undefined or an empty string (optional).</div>
2360
2361
2362
2363                     <div class="long">
2364
2365                                 Returns true if the passed value is null, undefined or an empty string (optional).
2366
2367
2368
2369
2370
2371
2372                                 <dl class="detailList">
2373                                 <dt class="heading">Parameters:</dt>
2374
2375                                         <dt>
2376                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
2377
2378                                         </dt>
2379                                         <dd>The value to test</dd>
2380
2381                                         <dt>
2382                                                 <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>
2383
2384                                         </dt>
2385                                         <dd>(optional) Pass true if an empty string is not considered empty</dd>
2386
2387                                 </dl>
2388
2389
2390
2391
2392
2393                                 <dl class="detailList">
2394                                 <dt class="heading">Returns:</dt>
2395
2396                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
2397
2398                                 </dl>
2399
2400
2401
2402
2403
2404
2405
2406                     </div>
2407                 </div>
2408
2409             </td>
2410             <td class="msource">
2411
2412                         Roo
2413                 &nbsp;
2414             </td>
2415         </tr>
2416
2417
2418           <tr class="method-row config-row-alt0 expandable notInherited">
2419             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2420
2421
2422             <td class="sig">
2423                 <a id="Roo-method-namespace"   name=".namespace"></a>
2424                 <div class="fixedFont">
2425                         <span class="attributes">Roo.</span><b class="itemname">namespace</b>
2426
2427                                  (<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>)
2428
2429
2430
2431                 </div>
2432                 <div class="mdesc">
2433
2434                    <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
2435
2436
2437
2438                     <div class="long">
2439
2440                                 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>
2441
2442
2443
2444
2445
2446
2447                                 <dl class="detailList">
2448                                 <dt class="heading">Parameters:</dt>
2449
2450                                         <dt>
2451                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace1</b>
2452
2453                                         </dt>
2454                                         <dd></dd>
2455
2456                                         <dt>
2457                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace2</b>
2458
2459                                         </dt>
2460                                         <dd></dd>
2461
2462                                         <dt>
2463                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>etc</b>
2464
2465                                         </dt>
2466                                         <dd></dd>
2467
2468                                 </dl>
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480                     </div>
2481                 </div>
2482
2483             </td>
2484             <td class="msource">
2485
2486                         Roo
2487                 &nbsp;
2488             </td>
2489         </tr>
2490
2491
2492           <tr class="method-row config-row-alt1 expandable notInherited">
2493             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2494
2495
2496             <td class="sig">
2497                 <a id="Roo-method-onReady"   name=".onReady"></a>
2498                 <div class="fixedFont">
2499                         <span class="attributes">Roo.</span><b class="itemname">onReady</b>
2500
2501                                  (<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>)
2502
2503
2504
2505                 </div>
2506                 <div class="mdesc">
2507
2508                    <div class="short">Fires when the document is ready (before onload and before images are loaded).</div>
2509
2510
2511
2512                     <div class="long">
2513
2514                                 Fires when the document is ready (before onload and before images are loaded).  Shorthand of {<b>link</b> Roo.EventManager<b>onDocumentReady</b>}.
2515
2516
2517
2518
2519
2520
2521                                 <dl class="detailList">
2522                                 <dt class="heading">Parameters:</dt>
2523
2524                                         <dt>
2525                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
2526
2527                                         </dt>
2528                                         <dd>The method the event invokes</dd>
2529
2530                                         <dt>
2531                                                 <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>
2532
2533                                         </dt>
2534                                         <dd>An  object that becomes the scope of the handler</dd>
2535
2536                                         <dt>
2537                                                 <span class="fixedFont">boolean</span>  <b>override</b>
2538
2539                                         </dt>
2540                                         <dd>If true, the obj passed in becomes<br/>                            the execution scope of the listener</dd>
2541
2542                                 </dl>
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554                     </div>
2555                 </div>
2556
2557             </td>
2558             <td class="msource">
2559
2560                         Roo
2561                 &nbsp;
2562             </td>
2563         </tr>
2564
2565
2566           <tr class="method-row config-row-alt0 expandable notInherited">
2567             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2568
2569
2570             <td class="sig">
2571                 <a id="Roo-method-override"   name=".override"></a>
2572                 <div class="fixedFont">
2573                         <span class="attributes">Roo.</span><b class="itemname">override</b>
2574
2575                                  (<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>)
2576
2577
2578
2579                 </div>
2580                 <div class="mdesc">
2581
2582                    <div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.</div>
2583
2584
2585
2586                     <div class="long">
2587
2588                                 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>
2589
2590
2591
2592
2593
2594
2595                                 <dl class="detailList">
2596                                 <dt class="heading">Parameters:</dt>
2597
2598                                         <dt>
2599                                                 <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>
2600
2601                                         </dt>
2602                                         <dd>The class to override</dd>
2603
2604                                         <dt>
2605                                                 <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>
2606
2607                                         </dt>
2608                                         <dd>The list of functions to add to origClass.  This should be specified as an object literal<br/>containing one or more methods.</dd>
2609
2610                                 </dl>
2611
2612
2613
2614
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-alt1 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-query"   name=".query"></a>
2640                 <div class="fixedFont">
2641                         <span class="attributes">Roo.</span><b class="itemname">query</b>
2642
2643                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, Node <B><i>root</i></B>)
2644
2645
2646                                          :
2647
2648
2649                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2650
2651
2652
2653
2654
2655                 </div>
2656                 <div class="mdesc">
2657
2658                    <div class="short">Selects an array of DOM nodes by CSS/XPath selector.</div>
2659
2660
2661
2662                     <div class="long">
2663
2664                                 Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {<b>link</b> Roo.DomQuery<b>select</b>}
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>path</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="./Array.html#constructor" roo:cls="Array.html#constructor">Array</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-alt0 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-select"   name=".select"></a>
2723                 <div class="fixedFont">
2724                         <span class="attributes">Roo.</span><b class="itemname">select</b>
2725
2726                                  (<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>)
2727
2728
2729                                          :
2730
2731
2732                                                 CompositeElementLite/CompositeElement
2733
2734
2735
2736
2737
2738                 </div>
2739                 <div class="mdesc">
2740
2741                    <div class="short">Selects elements based on the passed CSS selector to enable working on them as 1.</div>
2742
2743
2744
2745                     <div class="long">
2746
2747                                 Selects elements based on the passed CSS selector to enable working on them as 1.
2748
2749
2750
2751
2752
2753
2754                                 <dl class="detailList">
2755                                 <dt class="heading">Parameters:</dt>
2756
2757                                         <dt>
2758                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>selector</b>
2759
2760                                         </dt>
2761                                         <dd>The CSS selector or an array of elements</dd>
2762
2763                                         <dt>
2764                                                 <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>
2765
2766                                         </dt>
2767                                         <dd>(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)</dd>
2768
2769                                         <dt>
2770                                                 <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>
2771
2772                                         </dt>
2773                                         <dd>(optional) The root element of the query or id of the root</dd>
2774
2775                                 </dl>
2776
2777
2778
2779
2780
2781                                 <dl class="detailList">
2782                                 <dt class="heading">Returns:</dt>
2783
2784                                         <dd><span class="fixedFont">CompositeElementLite/CompositeElement</span>  </dd>
2785
2786                                 </dl>
2787
2788
2789
2790
2791
2792
2793
2794                     </div>
2795                 </div>
2796
2797             </td>
2798             <td class="msource">
2799
2800                         Roo
2801                 &nbsp;
2802             </td>
2803         </tr>
2804
2805
2806           <tr class="method-row config-row-alt1 expandable notInherited">
2807             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2808
2809
2810             <td class="sig">
2811                 <a id="Roo-method-selectNode"   name=".selectNode"></a>
2812                 <div class="fixedFont">
2813                         <span class="attributes">Roo.</span><b class="itemname">selectNode</b>
2814
2815                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>selector</i></B>, Node <B><i>root</i></B>)
2816
2817
2818                                          :
2819
2820
2821                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
2822
2823
2824
2825
2826
2827                 </div>
2828                 <div class="mdesc">
2829
2830                    <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>
2831
2832
2833
2834                     <div class="long">
2835
2836                                 Selects a single element as a Roo Element<br/>This is about as close as you can get to jQuery's $('do crazy stuff')
2837
2838
2839
2840
2841
2842
2843                                 <dl class="detailList">
2844                                 <dt class="heading">Parameters:</dt>
2845
2846                                         <dt>
2847                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>selector</b>
2848
2849                                         </dt>
2850                                         <dd>The selector/xpath query</dd>
2851
2852                                         <dt>
2853                                                 <span class="fixedFont">Node</span>  <b>root</b>
2854
2855                                         </dt>
2856                                         <dd>(optional) The start of the query (defaults to document).</dd>
2857
2858                                 </dl>
2859
2860
2861
2862
2863
2864                                 <dl class="detailList">
2865                                 <dt class="heading">Returns:</dt>
2866
2867                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
2868
2869                                 </dl>
2870
2871
2872
2873
2874
2875
2876
2877                     </div>
2878                 </div>
2879
2880             </td>
2881             <td class="msource">
2882
2883                         Roo
2884                 &nbsp;
2885             </td>
2886         </tr>
2887
2888
2889           <tr class="method-row config-row-alt0 expandable notInherited">
2890             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2891
2892
2893             <td class="sig">
2894                 <a id="Roo-method-type"   name=".type"></a>
2895                 <div class="fixedFont">
2896                         <span class="attributes">Roo.</span><b class="itemname">type</b>
2897
2898                                  (Mixed <B><i>object</i></B>)
2899
2900
2901                                          :
2902
2903
2904                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2905
2906
2907
2908
2909
2910                 </div>
2911                 <div class="mdesc">
2912
2913                    <div class="short">Returns the type of object that is passed in.</div>
2914
2915
2916
2917                     <div class="long">
2918
2919                                 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>
2920
2921
2922
2923
2924
2925
2926                                 <dl class="detailList">
2927                                 <dt class="heading">Parameters:</dt>
2928
2929                                         <dt>
2930                                                 <span class="fixedFont">Mixed</span>  <b>object</b>
2931
2932                                         </dt>
2933                                         <dd></dd>
2934
2935                                 </dl>
2936
2937
2938
2939
2940
2941                                 <dl class="detailList">
2942                                 <dt class="heading">Returns:</dt>
2943
2944                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
2945
2946                                 </dl>
2947
2948
2949
2950
2951
2952
2953
2954                     </div>
2955                 </div>
2956
2957             </td>
2958             <td class="msource">
2959
2960                         Roo
2961                 &nbsp;
2962             </td>
2963         </tr>
2964
2965
2966           <tr class="method-row config-row-alt1 expandable notInherited">
2967             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2968
2969
2970             <td class="sig">
2971                 <a id="Roo-method-urlDecode"   name=".urlDecode"></a>
2972                 <div class="fixedFont">
2973                         <span class="attributes">Roo.</span><b class="itemname">urlDecode</b>
2974
2975                                  (<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>)
2976
2977
2978                                          :
2979
2980
2981                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2982
2983
2984
2985
2986
2987                 </div>
2988                 <div class="mdesc">
2989
2990                    <div class="short">Takes an encoded URL and and converts it to an object.</div>
2991
2992
2993
2994                     <div class="long">
2995
2996                                 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]}.
2997
2998
2999
3000
3001
3002
3003                                 <dl class="detailList">
3004                                 <dt class="heading">Parameters:</dt>
3005
3006                                         <dt>
3007                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>string</b>
3008
3009                                         </dt>
3010                                         <dd></dd>
3011
3012                                         <dt>
3013                                                 <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>
3014
3015                                         </dt>
3016                                         <dd>(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).</dd>
3017
3018                                 </dl>
3019
3020
3021
3022
3023
3024                                 <dl class="detailList">
3025                                 <dt class="heading">Returns:</dt>
3026
3027                                         <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>
3028
3029                                 </dl>
3030
3031
3032
3033
3034
3035
3036
3037                     </div>
3038                 </div>
3039
3040             </td>
3041             <td class="msource">
3042
3043                         Roo
3044                 &nbsp;
3045             </td>
3046         </tr>
3047
3048
3049           <tr class="method-row config-row-alt0 expandable notInherited">
3050             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3051
3052
3053             <td class="sig">
3054                 <a id="Roo-method-urlEncode"   name=".urlEncode"></a>
3055                 <div class="fixedFont">
3056                         <span class="attributes">Roo.</span><b class="itemname">urlEncode</b>
3057
3058                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
3059
3060
3061                                          :
3062
3063
3064                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
3065
3066
3067
3068
3069
3070                 </div>
3071                 <div class="mdesc">
3072
3073                    <div class="short">Takes an object and converts it to an encoded URL.</div>
3074
3075
3076
3077                     <div class="long">
3078
3079                                 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.
3080
3081
3082
3083
3084
3085
3086                                 <dl class="detailList">
3087                                 <dt class="heading">Parameters:</dt>
3088
3089                                         <dt>
3090                                                 <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>
3091
3092                                         </dt>
3093                                         <dd></dd>
3094
3095                                 </dl>
3096
3097
3098
3099
3100
3101                                 <dl class="detailList">
3102                                 <dt class="heading">Returns:</dt>
3103
3104                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
3105
3106                                 </dl>
3107
3108
3109
3110
3111
3112
3113
3114                     </div>
3115                 </div>
3116
3117             </td>
3118             <td class="msource">
3119
3120                         Roo
3121                 &nbsp;
3122             </td>
3123         </tr>
3124
3125
3126     </table>
3127
3128
3129   <!-- ============================== events summary / details ======================== -->
3130
3131
3132   <a id="Roo-events"></a>
3133
3134
3135
3136
3137
3138      <table cellspacing="0" class="member-table">
3139       <caption class="Empty">Events - Has None</caption>
3140      </table>
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150 <!-- ============================== footer ================================= -->
3151                 <div class="fineprint" style="clear:both">
3152
3153                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
3154                         Based on
3155                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
3156                 </div>
3157         </body>
3158 </html>