git.roojs.org Git - roojs1/blob - docs/symbols/Roo.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55         <tr><td class="label">Defined In:</td><td class="hd-info">
  56
  57                                         <a href="./src/Roo.js.html">Roo.js</a>.
  58
  59         </td></tr>
  60         <tr><td class="label">Class:</td><td class="hd-info">Roo</td></tr>
  61
  62
  63
  64
  65     </table>
  66
  67
  68 <!-- ============================== class summary ========================== -->
  69     <div class="description">
  70         Roo core utilities and functions.
  71     </div>
  72
  73
  74 <!-- ============================== Class comment block... ========================== -->
  75
  76 <div class="comments">
  77         <b>Class Comments / Notes</B> =>
  78         <u onclick="parent.CommentDialog.showCommentId = 'Roo';">[Add Your comment/notes about this class]</u>
  79         <br/>
  80         <iframe frameborder="0"  id="comments-" style="border: none;width:100%;"
  81                 src="/blog.php/GtkDjsComments/Roo.html"></iframe>
  82 </div>
  83
  84
  85
  86 <!-- ============================== config options ========================== -->
  87
  88
  89
  90
  91     <div class="hr"></div>
  92     <a id="Roo-configs"></a>
  93
  94
  95
  96      <table cellspacing="0" class="member-table">
  97       <caption class="Empty">Config Options - Has None</caption>
  98      </table>
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111   <!-- ============================== public properties ==================== -->
 112
 113
 114
 115     <a id="Roo-props"></a>
 116
 117
 118
 119
 120
 121
 122
 123       <table cellspacing="0" class="member-table">
 124       <caption>Public Properties </caption>
 125         <tr>
 126             <th class="sig-header" colspan="2">Property</th>
 127             <th class="sig-header">Description</th>
 128             <th class="msource-header">Defined By</th>
 129         </tr>
 130
 131
 132
 133
 134
 135
 136
 137
 138           <tr class="property-row config-row-alt0 notInherited">
 139             <td class="micon">
 140                 <a class="exi" href="#expand">&nbsp;</a>
 141             </td>
 142             <td class="sig">
 143                <a id="Roo-prop-BLANK_IMAGE_URL" name=".BLANK_IMAGE_URL"></a>
 144                <div class="fixedFont">
 145                     <span class="attributes">Roo.</span><b  class="itemname">BLANK_IMAGE_URL</b> :
 146                      <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
 147                      </div>
 148             </td>
 149             <td class="sig">
 150                 <div class="mdesc">
 151
 152
 153                    <div class="short">
 154                         URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images.
 155
 156
 157
 158                    </div>
 159
 160                     <div class="long">
 161
 162                         URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images. (Defaults to<br/>"http://Roojs.com/s.gif" and you should change this to a URL on your server).
 163
 164                 </div>
 165                 </div>
 166             </td>
 167
 168             <td class="msource">
 169             Roo
 170             </td>
 171
 172           </tr>
 173
 174
 175
 176
 177           <tr class="property-row config-row-alt1 notInherited">
 178             <td class="micon">
 179                 <a class="exi" href="#expand">&nbsp;</a>
 180             </td>
 181             <td class="sig">
 182                <a id="Roo-prop-Msg" name=".Msg"></a>
 183                <div class="fixedFont">
 184                     <span class="attributes">Roo.</span><b  class="itemname">Msg</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-SSL_SECURE_URL" name=".SSL_SECURE_URL"></a>
 222                <div class="fixedFont">
 223                     <span class="attributes">Roo.</span><b  class="itemname">SSL_SECURE_URL</b> :
 224                      <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
 225                      </div>
 226             </td>
 227             <td class="sig">
 228                 <div class="mdesc">
 229
 230
 231                    <div class="short">
 232                         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).
 233
 234
 235
 236                    </div>
 237
 238                     <div class="long">
 239
 240                         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).
 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-enableGarbageCollector" name=".enableGarbageCollector"></a>
 261                <div class="fixedFont">
 262                     <span class="attributes">Roo.</span><b  class="itemname">enableGarbageCollector</b> :
 263                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 264                      </div>
 265             </td>
 266             <td class="sig">
 267                 <div class="mdesc">
 268
 269
 270                    <div class="short">
 271                         True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
 272
 273
 274
 275                    </div>
 276
 277                     <div class="long">
 278
 279                         True to automatically uncache orphaned Roo.Elements periodically (defaults to true)
 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-enableListenerCollection" name=".enableListenerCollection"></a>
 300                <div class="fixedFont">
 301                     <span class="attributes">Roo.</span><b  class="itemname">enableListenerCollection</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                         True to automatically purge event listeners after uncaching an element (defaults to false).
 311
 312
 313
 314                    </div>
 315
 316                     <div class="long">
 317
 318                         True to automatically purge event listeners after uncaching an element (defaults to false).<br/>Note: this only happens if enableGarbageCollector is true.
 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-isBorderBox" name=".isBorderBox"></a>
 339                <div class="fixedFont">
 340                     <span class="attributes">Roo.</span><b  class="itemname">isBorderBox</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
 350
 351
 352
 353                    </div>
 354
 355                     <div class="long">
 356
 357
 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-isGecko" name=".isGecko"></a>
 378                <div class="fixedFont">
 379                     <span class="attributes">Roo.</span><b  class="itemname">isGecko</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
 389
 390
 391
 392                    </div>
 393
 394                     <div class="long">
 395
 396
 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-isIE" name=".isIE"></a>
 417                <div class="fixedFont">
 418                     <span class="attributes">Roo.</span><b  class="itemname">isIE</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-isIE7" name=".isIE7"></a>
 456                <div class="fixedFont">
 457                     <span class="attributes">Roo.</span><b  class="itemname">isIE7</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-isLinux" name=".isLinux"></a>
 495                <div class="fixedFont">
 496                     <span class="attributes">Roo.</span><b  class="itemname">isLinux</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-isMac" name=".isMac"></a>
 534                <div class="fixedFont">
 535                     <span class="attributes">Roo.</span><b  class="itemname">isMac</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-isOpera" name=".isOpera"></a>
 573                <div class="fixedFont">
 574                     <span class="attributes">Roo.</span><b  class="itemname">isOpera</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-isReady" name=".isReady"></a>
 612                <div class="fixedFont">
 613                     <span class="attributes">Roo.</span><b  class="itemname">isReady</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                         True when the document is fully initialized and ready for action
 623
 624
 625
 626                    </div>
 627
 628                     <div class="long">
 629
 630                         True when the document is fully initialized and ready for action
 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-isSafari" name=".isSafari"></a>
 651                <div class="fixedFont">
 652                     <span class="attributes">Roo.</span><b  class="itemname">isSafari</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-isSecure" name=".isSecure"></a>
 690                <div class="fixedFont">
 691                     <span class="attributes">Roo.</span><b  class="itemname">isSecure</b> :
 692                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 693                      </div>
 694             </td>
 695             <td class="sig">
 696                 <div class="mdesc">
 697
 698
 699                    <div class="short">
 700                         True if the page is running over SSL
 701
 702
 703
 704                    </div>
 705
 706                     <div class="long">
 707
 708                         True if the page is running over SSL
 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-isStrict" name=".isStrict"></a>
 729                <div class="fixedFont">
 730                     <span class="attributes">Roo.</span><b  class="itemname">isStrict</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                         True if the browser is in strict mode
 740
 741
 742
 743                    </div>
 744
 745                     <div class="long">
 746
 747                         True if the browser is in strict mode
 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-isWindows" name=".isWindows"></a>
 768                <div class="fixedFont">
 769                     <span class="attributes">Roo.</span><b  class="itemname">isWindows</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-useShims" name=".useShims"></a>
 807                <div class="fixedFont">
 808                     <span class="attributes">Roo.</span><b  class="itemname">useShims</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                         By default, Ext intelligently decides whether floating elements should be shimmed.
 818
 819
 820
 821                    </div>
 822
 823                     <div class="long">
 824
 825                         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.
 826
 827                 </div>
 828                 </div>
 829             </td>
 830
 831             <td class="msource">
 832             Roo
 833             </td>
 834
 835           </tr>
 836
 837
 838
 839
 840
 841         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 842         <tr class="property-row alt">
 843
 844         -->
 845
 846     </table>
 847
 848
 849   <!-- ============================== methods summary / details ======================== -->
 850
 851
 852   <a id="Roo-methods"></a>
 853         <!-- constructor?? -->
 854
 855         <!-- static's first
 856
 857
 858         -->
 859
 860         <!-- then dynamics first -->
 861
 862
 863
 864
 865
 866
 867       <table cellspacing="0" class="member-table">
 868       <caption>Public Methods</caption>
 869         <tr>
 870             <th class="sig-header" colspan="2">Method</th>
 871             <th class="msource-header">Defined By</th>
 872
 873         </tr>
 874
 875
 876
 877
 878
 879
 880
 881           <tr class="method-row config-row-alt0 expandable notInherited">
 882             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 883
 884
 885             <td class="sig">
 886                 <a id="Roo-method-addBehaviors"   name=".addBehaviors"></a>
 887                 <div class="fixedFont">
 888                         <span class="attributes">Roo.</span><b class="itemname">addBehaviors</b>
 889
 890                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>obj</i></B>)
 891
 892
 893
 894                 </div>
 895                 <div class="mdesc">
 896
 897                    <div class="short">Applies event listeners to elements by selectors when the document is ready.</div>
 898
 899
 900
 901                     <div class="long">
 902
 903                                 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>
 904
 905
 906
 907
 908
 909
 910                                 <dl class="detailList">
 911                                 <dt class="heading">Parameters:</dt>
 912
 913                                         <dt>
 914                                                 <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>
 915
 916                                         </dt>
 917                                         <dd>The list of behaviors to apply</dd>
 918
 919                                 </dl>
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931                     </div>
 932                 </div>
 933
 934             </td>
 935             <td class="msource">
 936
 937                         Roo
 938                 &nbsp;
 939             </td>
 940         </tr>
 941
 942
 943           <tr class="method-row config-row-alt1 expandable notInherited">
 944             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 945
 946
 947             <td class="sig">
 948                 <a id="Roo-method-apply"   name=".apply"></a>
 949                 <div class="fixedFont">
 950                         <span class="attributes">Roo.</span><b class="itemname">apply</b>
 951
 952                                  (<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>)
 953
 954
 955                                          :
 956
 957
 958                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 959
 960
 961
 962
 963
 964                 </div>
 965                 <div class="mdesc">
 966
 967                    <div class="short">Copies all the properties of config to obj.</div>
 968
 969
 970
 971                     <div class="long">
 972
 973                                 Copies all the properties of config to obj.
 974
 975
 976
 977
 978
 979
 980                                 <dl class="detailList">
 981                                 <dt class="heading">Parameters:</dt>
 982
 983                                         <dt>
 984                                                 <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>
 985
 986                                         </dt>
 987                                         <dd>The receiver of the properties</dd>
 988
 989                                         <dt>
 990                                                 <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>
 991
 992                                         </dt>
 993                                         <dd>The source of the properties</dd>
 994
 995                                         <dt>
 996                                                 <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>
 997
 998                                         </dt>
 999                                         <dd>A different object that will also be applied for default values</dd>
1000
1001                                 </dl>
1002
1003
1004
1005
1006
1007                                 <dl class="detailList">
1008                                 <dt class="heading">Returns:</dt>
1009
1010                                         <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>
1011
1012                                 </dl>
1013
1014
1015
1016
1017
1018
1019
1020                     </div>
1021                 </div>
1022
1023             </td>
1024             <td class="msource">
1025
1026                         Roo
1027                 &nbsp;
1028             </td>
1029         </tr>
1030
1031
1032           <tr class="method-row config-row-alt0 expandable notInherited">
1033             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1034
1035
1036             <td class="sig">
1037                 <a id="Roo-method-applyIf"   name=".applyIf"></a>
1038                 <div class="fixedFont">
1039                         <span class="attributes">Roo.</span><b class="itemname">applyIf</b>
1040
1041                                  (<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>)
1042
1043
1044                                          :
1045
1046
1047                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1048
1049
1050
1051
1052
1053                 </div>
1054                 <div class="mdesc">
1055
1056                    <div class="short">Copies all the properties of config to obj if they don't already exist.</div>
1057
1058
1059
1060                     <div class="long">
1061
1062                                 Copies all the properties of config to obj if they don't already exist.
1063
1064
1065
1066
1067
1068
1069                                 <dl class="detailList">
1070                                 <dt class="heading">Parameters:</dt>
1071
1072                                         <dt>
1073                                                 <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>
1074
1075                                         </dt>
1076                                         <dd>The receiver of the properties</dd>
1077
1078                                         <dt>
1079                                                 <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>
1080
1081                                         </dt>
1082                                         <dd>The source of the properties</dd>
1083
1084                                 </dl>
1085
1086
1087
1088
1089
1090                                 <dl class="detailList">
1091                                 <dt class="heading">Returns:</dt>
1092
1093                                         <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>
1094
1095                                 </dl>
1096
1097
1098
1099
1100
1101
1102
1103                     </div>
1104                 </div>
1105
1106             </td>
1107             <td class="msource">
1108
1109                         Roo
1110                 &nbsp;
1111             </td>
1112         </tr>
1113
1114
1115           <tr class="method-row config-row-alt1 expandable notInherited">
1116             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1117
1118
1119             <td class="sig">
1120                 <a id="Roo-method-decode"   name=".decode"></a>
1121                 <div class="fixedFont">
1122                         <span class="attributes">Roo.</span><b class="itemname">decode</b>
1123
1124                                  ()
1125
1126
1127
1128                 </div>
1129                 <div class="mdesc">
1130
1131                    <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}</div>
1132
1133
1134
1135                     <div class="long">
1136
1137                                 Shorthand for {<b>link</b> Roo.util.JSON<b>decode</b>}
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154                     </div>
1155                 </div>
1156
1157             </td>
1158             <td class="msource">
1159
1160                         Roo
1161                 &nbsp;
1162             </td>
1163         </tr>
1164
1165
1166           <tr class="method-row config-row-alt0 expandable notInherited">
1167             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1168
1169
1170             <td class="sig">
1171                 <a id="Roo-method-each"   name=".each"></a>
1172                 <div class="fixedFont">
1173                         <span class="attributes">Roo.</span><b class="itemname">each</b>
1174
1175                                  (<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>)
1176
1177
1178
1179                 </div>
1180                 <div class="mdesc">
1181
1182                    <div class="short">Iterates an array calling the passed function with each item, stopping if your function returns false.</div>
1183
1184
1185
1186                     <div class="long">
1187
1188                                 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).
1189
1190
1191
1192
1193
1194
1195                                 <dl class="detailList">
1196                                 <dt class="heading">Parameters:</dt>
1197
1198                                         <dt>
1199                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/NodeList/Mixed</span>  <b>array</b>
1200
1201                                         </dt>
1202                                         <dd></dd>
1203
1204                                         <dt>
1205                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
1206
1207                                         </dt>
1208                                         <dd></dd>
1209
1210                                         <dt>
1211                                                 <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>
1212
1213                                         </dt>
1214                                         <dd></dd>
1215
1216                                 </dl>
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228                     </div>
1229                 </div>
1230
1231             </td>
1232             <td class="msource">
1233
1234                         Roo
1235                 &nbsp;
1236             </td>
1237         </tr>
1238
1239
1240           <tr class="method-row config-row-alt1 expandable notInherited">
1241             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1242
1243
1244             <td class="sig">
1245                 <a id="Roo-method-encode"   name=".encode"></a>
1246                 <div class="fixedFont">
1247                         <span class="attributes">Roo.</span><b class="itemname">encode</b>
1248
1249                                  ()
1250
1251
1252
1253                 </div>
1254                 <div class="mdesc">
1255
1256                    <div class="short">Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}</div>
1257
1258
1259
1260                     <div class="long">
1261
1262                                 Shorthand for {<b>link</b> Roo.util.JSON<b>encode</b>}
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279                     </div>
1280                 </div>
1281
1282             </td>
1283             <td class="msource">
1284
1285                         Roo
1286                 &nbsp;
1287             </td>
1288         </tr>
1289
1290
1291           <tr class="method-row config-row-alt0 expandable notInherited">
1292             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1293
1294
1295             <td class="sig">
1296                 <a id="Roo-method-escapeRe"   name=".escapeRe"></a>
1297                 <div class="fixedFont">
1298                         <span class="attributes">Roo.</span><b class="itemname">escapeRe</b>
1299
1300                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>str</i></B>)
1301
1302
1303                                          :
1304
1305
1306                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1307
1308
1309
1310
1311
1312                 </div>
1313                 <div class="mdesc">
1314
1315                    <div class="short">Escapes the passed string for use in a regular expression</div>
1316
1317
1318
1319                     <div class="long">
1320
1321                                 Escapes the passed string for use in a regular expression
1322
1323
1324
1325
1326
1327
1328                                 <dl class="detailList">
1329                                 <dt class="heading">Parameters:</dt>
1330
1331                                         <dt>
1332                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>str</b>
1333
1334                                         </dt>
1335                                         <dd></dd>
1336
1337                                 </dl>
1338
1339
1340
1341
1342
1343                                 <dl class="detailList">
1344                                 <dt class="heading">Returns:</dt>
1345
1346                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
1347
1348                                 </dl>
1349
1350
1351
1352
1353
1354
1355
1356                     </div>
1357                 </div>
1358
1359             </td>
1360             <td class="msource">
1361
1362                         Roo
1363                 &nbsp;
1364             </td>
1365         </tr>
1366
1367
1368           <tr class="method-row config-row-alt1 expandable notInherited">
1369             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1370
1371
1372             <td class="sig">
1373                 <a id="Roo-method-extend"   name=".extend"></a>
1374                 <div class="fixedFont">
1375                         <span class="attributes">Roo.</span><b class="itemname">extend</b>
1376
1377                                  (<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>)
1378
1379
1380
1381                 </div>
1382                 <div class="mdesc">
1383
1384                    <div class="short">Extends one class with another class and optionally overrides members with the passed literal.</div>
1385
1386
1387
1388                     <div class="long">
1389
1390                                 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.
1391
1392
1393
1394
1395
1396
1397                                 <dl class="detailList">
1398                                 <dt class="heading">Parameters:</dt>
1399
1400                                         <dt>
1401                                                 <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>
1402
1403                                         </dt>
1404                                         <dd>The class inheriting the functionality</dd>
1405
1406                                         <dt>
1407                                                 <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>
1408
1409                                         </dt>
1410                                         <dd>The class being extended</dd>
1411
1412                                         <dt>
1413                                                 <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>
1414
1415                                         </dt>
1416                                         <dd>(optional) A literal with members</dd>
1417
1418                                 </dl>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430                     </div>
1431                 </div>
1432
1433             </td>
1434             <td class="msource">
1435
1436                         Roo
1437                 &nbsp;
1438             </td>
1439         </tr>
1440
1441
1442           <tr class="method-row config-row-alt0 expandable notInherited">
1443             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1444
1445
1446             <td class="sig">
1447                 <a id="Roo-method-factory"   name=".factory"></a>
1448                 <div class="fixedFont">
1449                         <span class="attributes">Roo.</span><b class="itemname">factory</b>
1450
1451                                  (<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>)
1452
1453
1454
1455                 </div>
1456                 <div class="mdesc">
1457
1458                    <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
1459
1460
1461
1462                     <div class="long">
1463
1464                                 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>
1465
1466
1467
1468
1469
1470
1471                                 <dl class="detailList">
1472                                 <dt class="heading">Parameters:</dt>
1473
1474                                         <dt>
1475                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>classname</b>
1476
1477                                         </dt>
1478                                         <dd></dd>
1479
1480                                         <dt>
1481                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace</b>
1482
1483                                         </dt>
1484                                         <dd>(optional)</dd>
1485
1486                                 </dl>
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498                     </div>
1499                 </div>
1500
1501             </td>
1502             <td class="msource">
1503
1504                         Roo
1505                 &nbsp;
1506             </td>
1507         </tr>
1508
1509
1510           <tr class="method-row config-row-alt1 expandable notInherited">
1511             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1512
1513
1514             <td class="sig">
1515                 <a id="Roo-method-fly"   name=".fly"></a>
1516                 <div class="fixedFont">
1517                         <span class="attributes">Roo.</span><b class="itemname">fly</b>
1518
1519                                  (<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>)
1520
1521
1522                                          :
1523
1524
1525                                                 Element
1526
1527
1528
1529
1530
1531                 </div>
1532                 <div class="mdesc">
1533
1534                    <div class="short">Gets the globally shared flyweight Element, with the passed node as the active element.</div>
1535
1536
1537
1538                     <div class="long">
1539
1540                                 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>}
1541
1542
1543
1544
1545
1546
1547                                 <dl class="detailList">
1548                                 <dt class="heading">Parameters:</dt>
1549
1550                                         <dt>
1551                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
1552
1553                                         </dt>
1554                                         <dd>The dom node or id</dd>
1555
1556                                         <dt>
1557                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>named</b>
1558
1559                                         </dt>
1560                                         <dd>(optional) Allows for creation of named reusable flyweights to<br/>                                 prevent conflicts (e.g. internally Roo uses "_internal")</dd>
1561
1562                                 </dl>
1563
1564
1565
1566
1567
1568                                 <dl class="detailList">
1569                                 <dt class="heading">Returns:</dt>
1570
1571                                         <dd><span class="fixedFont">Element</span>  The shared Element object</dd>
1572
1573                                 </dl>
1574
1575
1576
1577
1578
1579
1580
1581                     </div>
1582                 </div>
1583
1584             </td>
1585             <td class="msource">
1586
1587                         Roo
1588                 &nbsp;
1589             </td>
1590         </tr>
1591
1592
1593           <tr class="method-row config-row-alt0 expandable notInherited">
1594             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1595
1596
1597             <td class="sig">
1598                 <a id="Roo-method-get"   name=".get"></a>
1599                 <div class="fixedFont">
1600                         <span class="attributes">Roo.</span><b class="itemname">get</b>
1601
1602                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1603
1604
1605                                          :
1606
1607
1608                                                 Element
1609
1610
1611
1612
1613
1614                 </div>
1615                 <div class="mdesc">
1616
1617                    <div class="short">Static method to retrieve Element objects.</div>
1618
1619
1620
1621                     <div class="long">
1622
1623                                 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>}
1624
1625
1626
1627
1628
1629
1630                                 <dl class="detailList">
1631                                 <dt class="heading">Parameters:</dt>
1632
1633                                         <dt>
1634                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
1635
1636                                         </dt>
1637                                         <dd>The id of the node, a DOM Node or an existing Element.</dd>
1638
1639                                 </dl>
1640
1641
1642
1643
1644
1645                                 <dl class="detailList">
1646                                 <dt class="heading">Returns:</dt>
1647
1648                                         <dd><span class="fixedFont">Element</span>  The Element object</dd>
1649
1650                                 </dl>
1651
1652
1653
1654
1655
1656
1657
1658                     </div>
1659                 </div>
1660
1661             </td>
1662             <td class="msource">
1663
1664                         Roo
1665                 &nbsp;
1666             </td>
1667         </tr>
1668
1669
1670           <tr class="method-row config-row-alt1 expandable notInherited">
1671             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1672
1673
1674             <td class="sig">
1675                 <a id="Roo-method-getCmp"   name=".getCmp"></a>
1676                 <div class="fixedFont">
1677                         <span class="attributes">Roo.</span><b class="itemname">getCmp</b>
1678
1679                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1680
1681
1682                                          :
1683
1684
1685
1686
1687
1688
1689
1690
1691                 </div>
1692                 <div class="mdesc">
1693
1694                    <div class="short">Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}</div>
1695
1696
1697
1698                     <div class="long">
1699
1700                                 Shorthand for {<b>link</b> Roo.ComponentMgr<b>get</b>}
1701
1702
1703
1704
1705
1706
1707                                 <dl class="detailList">
1708                                 <dt class="heading">Parameters:</dt>
1709
1710                                         <dt>
1711                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1712
1713                                         </dt>
1714                                         <dd></dd>
1715
1716                                 </dl>
1717
1718
1719
1720
1721
1722                                 <dl class="detailList">
1723                                 <dt class="heading">Returns:</dt>
1724
1725                                         <dd> Roo.Component</dd>
1726
1727                                 </dl>
1728
1729
1730
1731
1732
1733
1734
1735                     </div>
1736                 </div>
1737
1738             </td>
1739             <td class="msource">
1740
1741                         Roo
1742                 &nbsp;
1743             </td>
1744         </tr>
1745
1746
1747           <tr class="method-row config-row-alt0 expandable notInherited">
1748             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1749
1750
1751             <td class="sig">
1752                 <a id="Roo-method-getDom"   name=".getDom"></a>
1753                 <div class="fixedFont">
1754                         <span class="attributes">Roo.</span><b class="itemname">getDom</b>
1755
1756                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>)
1757
1758
1759                                          :
1760
1761
1762
1763
1764
1765
1766
1767
1768                 </div>
1769                 <div class="mdesc">
1770
1771                    <div class="short">Return the dom node for the passed string (id), dom node, or Roo.Element</div>
1772
1773
1774
1775                     <div class="long">
1776
1777                                 Return the dom node for the passed string (id), dom node, or Roo.Element
1778
1779
1780
1781
1782
1783
1784                                 <dl class="detailList">
1785                                 <dt class="heading">Parameters:</dt>
1786
1787                                         <dt>
1788                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
1789
1790                                         </dt>
1791                                         <dd></dd>
1792
1793                                 </dl>
1794
1795
1796
1797
1798
1799                                 <dl class="detailList">
1800                                 <dt class="heading">Returns:</dt>
1801
1802                                         <dd> HTMLElement</dd>
1803
1804                                 </dl>
1805
1806
1807
1808
1809
1810
1811
1812                     </div>
1813                 </div>
1814
1815             </td>
1816             <td class="msource">
1817
1818                         Roo
1819                 &nbsp;
1820             </td>
1821         </tr>
1822
1823
1824           <tr class="method-row config-row-alt1 expandable notInherited">
1825             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1826
1827
1828             <td class="sig">
1829                 <a id="Roo-method-id"   name=".id"></a>
1830                 <div class="fixedFont">
1831                         <span class="attributes">Roo.</span><b class="itemname">id</b>
1832
1833                                  (<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>)
1834
1835
1836                                          :
1837
1838
1839                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1840
1841
1842
1843
1844
1845                 </div>
1846                 <div class="mdesc">
1847
1848                    <div class="short">Generates unique ids.</div>
1849
1850
1851
1852                     <div class="long">
1853
1854                                 Generates unique ids. If the element already has an id, it is unchanged
1855
1856
1857
1858
1859
1860
1861                                 <dl class="detailList">
1862                                 <dt class="heading">Parameters:</dt>
1863
1864                                         <dt>
1865                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
1866
1867                                         </dt>
1868                                         <dd>(optional) The element to generate an id for</dd>
1869
1870                                         <dt>
1871                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>prefix</b>
1872
1873                                         </dt>
1874                                         <dd>(optional) Id prefix (defaults "Roo-gen")</dd>
1875
1876                                 </dl>
1877
1878
1879
1880
1881
1882                                 <dl class="detailList">
1883                                 <dt class="heading">Returns:</dt>
1884
1885                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The generated Id.</dd>
1886
1887                                 </dl>
1888
1889
1890
1891
1892
1893
1894
1895                     </div>
1896                 </div>
1897
1898             </td>
1899             <td class="msource">
1900
1901                         Roo
1902                 &nbsp;
1903             </td>
1904         </tr>
1905
1906
1907           <tr class="method-row config-row-alt0 expandable notInherited">
1908             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1909
1910
1911             <td class="sig">
1912                 <a id="Roo-method-isEmpty"   name=".isEmpty"></a>
1913                 <div class="fixedFont">
1914                         <span class="attributes">Roo.</span><b class="itemname">isEmpty</b>
1915
1916                                  (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>)
1917
1918
1919                                          :
1920
1921
1922                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1923
1924
1925
1926
1927
1928                 </div>
1929                 <div class="mdesc">
1930
1931                    <div class="short">Returns true if the passed value is null, undefined or an empty string (optional).</div>
1932
1933
1934
1935                     <div class="long">
1936
1937                                 Returns true if the passed value is null, undefined or an empty string (optional).
1938
1939
1940
1941
1942
1943
1944                                 <dl class="detailList">
1945                                 <dt class="heading">Parameters:</dt>
1946
1947                                         <dt>
1948                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
1949
1950                                         </dt>
1951                                         <dd>The value to test</dd>
1952
1953                                         <dt>
1954                                                 <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>
1955
1956                                         </dt>
1957                                         <dd>(optional) Pass true if an empty string is not considered empty</dd>
1958
1959                                 </dl>
1960
1961
1962
1963
1964
1965                                 <dl class="detailList">
1966                                 <dt class="heading">Returns:</dt>
1967
1968                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1969
1970                                 </dl>
1971
1972
1973
1974
1975
1976
1977
1978                     </div>
1979                 </div>
1980
1981             </td>
1982             <td class="msource">
1983
1984                         Roo
1985                 &nbsp;
1986             </td>
1987         </tr>
1988
1989
1990           <tr class="method-row config-row-alt1 expandable notInherited">
1991             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1992
1993
1994             <td class="sig">
1995                 <a id="Roo-method-namespace"   name=".namespace"></a>
1996                 <div class="fixedFont">
1997                         <span class="attributes">Roo.</span><b class="itemname">namespace</b>
1998
1999                                  (<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>)
2000
2001
2002
2003                 </div>
2004                 <div class="mdesc">
2005
2006                    <div class="short">Creates namespaces to be used for scoping variables and classes so that they are not global.</div>
2007
2008
2009
2010                     <div class="long">
2011
2012                                 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>
2013
2014
2015
2016
2017
2018
2019                                 <dl class="detailList">
2020                                 <dt class="heading">Parameters:</dt>
2021
2022                                         <dt>
2023                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace1</b>
2024
2025                                         </dt>
2026                                         <dd></dd>
2027
2028                                         <dt>
2029                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>namespace2</b>
2030
2031                                         </dt>
2032                                         <dd></dd>
2033
2034                                         <dt>
2035                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>etc</b>
2036
2037                                         </dt>
2038                                         <dd></dd>
2039
2040                                 </dl>
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052                     </div>
2053                 </div>
2054
2055             </td>
2056             <td class="msource">
2057
2058                         Roo
2059                 &nbsp;
2060             </td>
2061         </tr>
2062
2063
2064           <tr class="method-row config-row-alt0 expandable notInherited">
2065             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2066
2067
2068             <td class="sig">
2069                 <a id="Roo-method-onReady"   name=".onReady"></a>
2070                 <div class="fixedFont">
2071                         <span class="attributes">Roo.</span><b class="itemname">onReady</b>
2072
2073                                  (<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>)
2074
2075
2076
2077                 </div>
2078                 <div class="mdesc">
2079
2080                    <div class="short">Fires when the document is ready (before onload and before images are loaded).</div>
2081
2082
2083
2084                     <div class="long">
2085
2086                                 Fires when the document is ready (before onload and before images are loaded).  Shorthand of {<b>link</b> Roo.EventManager<b>onDocumentReady</b>}.
2087
2088
2089
2090
2091
2092
2093                                 <dl class="detailList">
2094                                 <dt class="heading">Parameters:</dt>
2095
2096                                         <dt>
2097                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
2098
2099                                         </dt>
2100                                         <dd>The method the event invokes</dd>
2101
2102                                         <dt>
2103                                                 <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>
2104
2105                                         </dt>
2106                                         <dd>An  object that becomes the scope of the handler</dd>
2107
2108                                         <dt>
2109                                                 <span class="fixedFont">boolean</span>  <b>override</b>
2110
2111                                         </dt>
2112                                         <dd>If true, the obj passed in becomes<br/>                            the execution scope of the listener</dd>
2113
2114                                 </dl>
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126                     </div>
2127                 </div>
2128
2129             </td>
2130             <td class="msource">
2131
2132                         Roo
2133                 &nbsp;
2134             </td>
2135         </tr>
2136
2137
2138           <tr class="method-row config-row-alt1 expandable notInherited">
2139             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2140
2141
2142             <td class="sig">
2143                 <a id="Roo-method-override"   name=".override"></a>
2144                 <div class="fixedFont">
2145                         <span class="attributes">Roo.</span><b class="itemname">override</b>
2146
2147                                  (<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>)
2148
2149
2150
2151                 </div>
2152                 <div class="mdesc">
2153
2154                    <div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.</div>
2155
2156
2157
2158                     <div class="long">
2159
2160                                 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>
2161
2162
2163
2164
2165
2166
2167                                 <dl class="detailList">
2168                                 <dt class="heading">Parameters:</dt>
2169
2170                                         <dt>
2171                                                 <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>
2172
2173                                         </dt>
2174                                         <dd>The class to override</dd>
2175
2176                                         <dt>
2177                                                 <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>
2178
2179                                         </dt>
2180                                         <dd>The list of functions to add to origClass.  This should be specified as an object literal<br/>containing one or more methods.</dd>
2181
2182                                 </dl>
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194                     </div>
2195                 </div>
2196
2197             </td>
2198             <td class="msource">
2199
2200                         Roo
2201                 &nbsp;
2202             </td>
2203         </tr>
2204
2205
2206           <tr class="method-row config-row-alt0 expandable notInherited">
2207             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2208
2209
2210             <td class="sig">
2211                 <a id="Roo-method-query"   name=".query"></a>
2212                 <div class="fixedFont">
2213                         <span class="attributes">Roo.</span><b class="itemname">query</b>
2214
2215                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, Node <B><i>root</i></B>)
2216
2217
2218                                          :
2219
2220
2221                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2222
2223
2224
2225
2226
2227                 </div>
2228                 <div class="mdesc">
2229
2230                    <div class="short">Selects an array of DOM nodes by CSS/XPath selector.</div>
2231
2232
2233
2234                     <div class="long">
2235
2236                                 Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {<b>link</b> Roo.DomQuery<b>select</b>}
2237
2238
2239
2240
2241
2242
2243                                 <dl class="detailList">
2244                                 <dt class="heading">Parameters:</dt>
2245
2246                                         <dt>
2247                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>path</b>
2248
2249                                         </dt>
2250                                         <dd>The selector/xpath query</dd>
2251
2252                                         <dt>
2253                                                 <span class="fixedFont">Node</span>  <b>root</b>
2254
2255                                         </dt>
2256                                         <dd>(optional) The start of the query (defaults to document).</dd>
2257
2258                                 </dl>
2259
2260
2261
2262
2263
2264                                 <dl class="detailList">
2265                                 <dt class="heading">Returns:</dt>
2266
2267                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  </dd>
2268
2269                                 </dl>
2270
2271
2272
2273
2274
2275
2276
2277                     </div>
2278                 </div>
2279
2280             </td>
2281             <td class="msource">
2282
2283                         Roo
2284                 &nbsp;
2285             </td>
2286         </tr>
2287
2288
2289           <tr class="method-row config-row-alt1 expandable notInherited">
2290             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2291
2292
2293             <td class="sig">
2294                 <a id="Roo-method-select"   name=".select"></a>
2295                 <div class="fixedFont">
2296                         <span class="attributes">Roo.</span><b class="itemname">select</b>
2297
2298                                  (<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>)
2299
2300
2301                                          :
2302
2303
2304                                                 CompositeElementLite/CompositeElement
2305
2306
2307
2308
2309
2310                 </div>
2311                 <div class="mdesc">
2312
2313                    <div class="short">Selects elements based on the passed CSS selector to enable working on them as 1.</div>
2314
2315
2316
2317                     <div class="long">
2318
2319                                 Selects elements based on the passed CSS selector to enable working on them as 1.
2320
2321
2322
2323
2324
2325
2326                                 <dl class="detailList">
2327                                 <dt class="heading">Parameters:</dt>
2328
2329                                         <dt>
2330                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>selector</b>
2331
2332                                         </dt>
2333                                         <dd>The CSS selector or an array of elements</dd>
2334
2335                                         <dt>
2336                                                 <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>
2337
2338                                         </dt>
2339                                         <dd>(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)</dd>
2340
2341                                         <dt>
2342                                                 <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>
2343
2344                                         </dt>
2345                                         <dd>(optional) The root element of the query or id of the root</dd>
2346
2347                                 </dl>
2348
2349
2350
2351
2352
2353                                 <dl class="detailList">
2354                                 <dt class="heading">Returns:</dt>
2355
2356                                         <dd><span class="fixedFont">CompositeElementLite/CompositeElement</span>  </dd>
2357
2358                                 </dl>
2359
2360
2361
2362
2363
2364
2365
2366                     </div>
2367                 </div>
2368
2369             </td>
2370             <td class="msource">
2371
2372                         Roo
2373                 &nbsp;
2374             </td>
2375         </tr>
2376
2377
2378           <tr class="method-row config-row-alt0 expandable notInherited">
2379             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2380
2381
2382             <td class="sig">
2383                 <a id="Roo-method-type"   name=".type"></a>
2384                 <div class="fixedFont">
2385                         <span class="attributes">Roo.</span><b class="itemname">type</b>
2386
2387                                  (Mixed <B><i>object</i></B>)
2388
2389
2390                                          :
2391
2392
2393                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2394
2395
2396
2397
2398
2399                 </div>
2400                 <div class="mdesc">
2401
2402                    <div class="short">Returns the type of object that is passed in.</div>
2403
2404
2405
2406                     <div class="long">
2407
2408                                 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>
2409
2410
2411
2412
2413
2414
2415                                 <dl class="detailList">
2416                                 <dt class="heading">Parameters:</dt>
2417
2418                                         <dt>
2419                                                 <span class="fixedFont">Mixed</span>  <b>object</b>
2420
2421                                         </dt>
2422                                         <dd></dd>
2423
2424                                 </dl>
2425
2426
2427
2428
2429
2430                                 <dl class="detailList">
2431                                 <dt class="heading">Returns:</dt>
2432
2433                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
2434
2435                                 </dl>
2436
2437
2438
2439
2440
2441
2442
2443                     </div>
2444                 </div>
2445
2446             </td>
2447             <td class="msource">
2448
2449                         Roo
2450                 &nbsp;
2451             </td>
2452         </tr>
2453
2454
2455           <tr class="method-row config-row-alt1 expandable notInherited">
2456             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2457
2458
2459             <td class="sig">
2460                 <a id="Roo-method-urlDecode"   name=".urlDecode"></a>
2461                 <div class="fixedFont">
2462                         <span class="attributes">Roo.</span><b class="itemname">urlDecode</b>
2463
2464                                  (<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>)
2465
2466
2467                                          :
2468
2469
2470                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2471
2472
2473
2474
2475
2476                 </div>
2477                 <div class="mdesc">
2478
2479                    <div class="short">Takes an encoded URL and and converts it to an object.</div>
2480
2481
2482
2483                     <div class="long">
2484
2485                                 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]}.
2486
2487
2488
2489
2490
2491
2492                                 <dl class="detailList">
2493                                 <dt class="heading">Parameters:</dt>
2494
2495                                         <dt>
2496                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>string</b>
2497
2498                                         </dt>
2499                                         <dd></dd>
2500
2501                                         <dt>
2502                                                 <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>
2503
2504                                         </dt>
2505                                         <dd>(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).</dd>
2506
2507                                 </dl>
2508
2509
2510
2511
2512
2513                                 <dl class="detailList">
2514                                 <dt class="heading">Returns:</dt>
2515
2516                                         <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>
2517
2518                                 </dl>
2519
2520
2521
2522
2523
2524
2525
2526                     </div>
2527                 </div>
2528
2529             </td>
2530             <td class="msource">
2531
2532                         Roo
2533                 &nbsp;
2534             </td>
2535         </tr>
2536
2537
2538           <tr class="method-row config-row-alt0 expandable notInherited">
2539             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2540
2541
2542             <td class="sig">
2543                 <a id="Roo-method-urlEncode"   name=".urlEncode"></a>
2544                 <div class="fixedFont">
2545                         <span class="attributes">Roo.</span><b class="itemname">urlEncode</b>
2546
2547                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
2548
2549
2550                                          :
2551
2552
2553                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2554
2555
2556
2557
2558
2559                 </div>
2560                 <div class="mdesc">
2561
2562                    <div class="short">Takes an object and converts it to an encoded URL.</div>
2563
2564
2565
2566                     <div class="long">
2567
2568                                 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.
2569
2570
2571
2572
2573
2574
2575                                 <dl class="detailList">
2576                                 <dt class="heading">Parameters:</dt>
2577
2578                                         <dt>
2579                                                 <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>
2580
2581                                         </dt>
2582                                         <dd></dd>
2583
2584                                 </dl>
2585
2586
2587
2588
2589
2590                                 <dl class="detailList">
2591                                 <dt class="heading">Returns:</dt>
2592
2593                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
2594
2595                                 </dl>
2596
2597
2598
2599
2600
2601
2602
2603                     </div>
2604                 </div>
2605
2606             </td>
2607             <td class="msource">
2608
2609                         Roo
2610                 &nbsp;
2611             </td>
2612         </tr>
2613
2614
2615     </table>
2616
2617
2618   <!-- ============================== events summary / details ======================== -->
2619
2620
2621   <a id="Roo-events"></a>
2622
2623
2624
2625
2626
2627      <table cellspacing="0" class="member-table">
2628       <caption class="Empty">Events - Has None</caption>
2629      </table>
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639 <!-- ============================== footer ================================= -->
2640                 <div class="fineprint" style="clear:both">
2641
2642                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:42 GMT+0800 (HKT)
2643                         Based on
2644                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
2645                 </div>
2646         </body>
2647 </html>