git.roojs.org Git - roojs1/blob - docs/symbols/Roo.CompositeElement.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.CompositeElement</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.CompositeElement-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.CompositeElement-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.CompositeElement-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.CompositeElement-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.CompositeElement
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_CompositeElement.js.html">Roo/CompositeElement.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">CompositeElement</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Standard composite class. Creates a Roo.Element for every element in the collection.<br/><br><br><br/><b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element<br/>actions will be performed on all the elements in this collection.</b><br/><br><br><br/>All methods return <i>this</i> and can be chained.<br/> <pre><code><br/> var els = Roo.select("<b>some</b>-el div.some-class", true);<br/> // or select directly from an existing element<br/> var el = Roo.get('some-el');<br/> el.select('div.some-class', true);<br/><br/> els.setWidth(100); // all elements become 100 width<br/> els.hide(true); // all elements fade out and hide<br/> // or<br/> els.setWidth(100).hide(true);<br/> </code></pre>
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.CompositeElement';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.CompositeElement.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.CompositeElement-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.CompositeElement-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.CompositeElement-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo-method-CompositeElement"   name=".CompositeElement"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">CompositeElement</b>
 170
 171                                  ()
 172
 173
 174
 175                 </div>
 176                 <div class="mdesc">
 177
 178
 179                         <div class="short">Create a new Roo.CompositeElement</div>
 180
 181
 182                     <div class="long">
 183
 184
 185
 186                                 Create a new Roo.CompositeElement
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199                     </div>
 200                 </div>
 201
 202             </td>
 203             <td class="msource">
 204                 &nbsp;
 205             </td>
 206         </tr>
 207
 208
 209           <tr class="method-row config-row-alt1 expandable notInherited">
 210             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 211
 212
 213             <td class="sig">
 214                 <a id="Roo.CompositeElement-method-add"   name=".add"></a>
 215                 <div class="fixedFont">
 216                         <span class="attributes"></span><b class="itemname">add</b>
 217
 218                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>els</i></B>)
 219
 220
 221                                          :
 222
 223
 224                                                 CompositeElement
 225
 226
 227
 228
 229
 230                 </div>
 231                 <div class="mdesc">
 232
 233                    <div class="short">Adds elements to this composite.</div>
 234
 235
 236
 237                     <div class="long">
 238
 239                                 Adds elements to this composite.
 240
 241
 242
 243
 244
 245
 246                                 <dl class="detailList">
 247                                 <dt class="heading">Parameters:</dt>
 248
 249                                         <dt>
 250                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>els</b>
 251
 252                                         </dt>
 253                                         <dd>A string CSS selector, an array of elements or an element</dd>
 254
 255                                 </dl>
 256
 257
 258
 259
 260
 261                                 <dl class="detailList">
 262                                 <dt class="heading">Returns:</dt>
 263
 264                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
 265
 266                                 </dl>
 267
 268
 269
 270
 271
 272
 273
 274                     </div>
 275                 </div>
 276
 277             </td>
 278             <td class="msource">
 279
 280                         Roo.CompositeElement
 281                 &nbsp;
 282             </td>
 283         </tr>
 284
 285
 286           <tr class="method-row config-row-alt0 expandable notInherited">
 287             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 288
 289
 290             <td class="sig">
 291                 <a id="Roo.CompositeElement-method-clear"   name=".clear"></a>
 292                 <div class="fixedFont">
 293                         <span class="attributes"></span><b class="itemname">clear</b>
 294
 295                                  ()
 296
 297
 298
 299                 </div>
 300                 <div class="mdesc">
 301
 302                    <div class="short">Removes all elements.</div>
 303
 304
 305
 306                     <div class="long">
 307
 308                                 Removes all elements.
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325                     </div>
 326                 </div>
 327
 328             </td>
 329             <td class="msource">
 330
 331                         Roo.CompositeElement
 332                 &nbsp;
 333             </td>
 334         </tr>
 335
 336
 337           <tr class="method-row config-row-alt1 expandable notInherited">
 338             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 339
 340
 341             <td class="sig">
 342                 <a id="Roo.CompositeElement-method-contains"   name=".contains"></a>
 343                 <div class="fixedFont">
 344                         <span class="attributes"></span><b class="itemname">contains</b>
 345
 346                                  ()
 347
 348
 349                                          :
 350
 351
 352
 353
 354
 355
 356
 357
 358                 </div>
 359                 <div class="mdesc">
 360
 361                    <div class="short">Returns true if this composite contains the passed element</div>
 362
 363
 364
 365                     <div class="long">
 366
 367                                 Returns true if this composite contains the passed element
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378                                 <dl class="detailList">
 379                                 <dt class="heading">Returns:</dt>
 380
 381                                         <dd> Boolean</dd>
 382
 383                                 </dl>
 384
 385
 386
 387
 388
 389
 390
 391                     </div>
 392                 </div>
 393
 394             </td>
 395             <td class="msource">
 396
 397                         Roo.CompositeElement
 398                 &nbsp;
 399             </td>
 400         </tr>
 401
 402
 403           <tr class="method-row config-row-alt0 expandable notInherited">
 404             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 405
 406
 407             <td class="sig">
 408                 <a id="Roo.CompositeElement-method-each"   name=".each"></a>
 409                 <div class="fixedFont">
 410                         <span class="attributes"></span><b class="itemname">each</b>
 411
 412                                  (<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>)
 413
 414
 415                                          :
 416
 417
 418                                                 CompositeElement
 419
 420
 421
 422
 423
 424                 </div>
 425                 <div class="mdesc">
 426
 427                    <div class="short">Calls the passed function passing (el, this, index) for each element in this composite.</div>
 428
 429
 430
 431                     <div class="long">
 432
 433                                 Calls the passed function passing (el, this, index) for each element in this composite.
 434
 435
 436
 437
 438
 439
 440                                 <dl class="detailList">
 441                                 <dt class="heading">Parameters:</dt>
 442
 443                                         <dt>
 444                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 445
 446                                         </dt>
 447                                         <dd>The function to call</dd>
 448
 449                                         <dt>
 450                                                 <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>
 451
 452                                         </dt>
 453                                         <dd>(optional) The <i>this</i> object (defaults to the element)</dd>
 454
 455                                 </dl>
 456
 457
 458
 459
 460
 461                                 <dl class="detailList">
 462                                 <dt class="heading">Returns:</dt>
 463
 464                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
 465
 466                                 </dl>
 467
 468
 469
 470
 471
 472
 473
 474                     </div>
 475                 </div>
 476
 477             </td>
 478             <td class="msource">
 479
 480                         Roo.CompositeElement
 481                 &nbsp;
 482             </td>
 483         </tr>
 484
 485
 486           <tr class="method-row config-row-alt1 expandable notInherited">
 487             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 488
 489
 490             <td class="sig">
 491                 <a id="Roo.CompositeElement-method-fill"   name=".fill"></a>
 492                 <div class="fixedFont">
 493                         <span class="attributes"></span><b class="itemname">fill</b>
 494
 495                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>els</i></B>)
 496
 497
 498                                          :
 499
 500
 501                                                 CompositeElement
 502
 503
 504
 505
 506
 507                 </div>
 508                 <div class="mdesc">
 509
 510                    <div class="short">Clears this composite and adds the elements returned by the passed selector.</div>
 511
 512
 513
 514                     <div class="long">
 515
 516                                 Clears this composite and adds the elements returned by the passed selector.
 517
 518
 519
 520
 521
 522
 523                                 <dl class="detailList">
 524                                 <dt class="heading">Parameters:</dt>
 525
 526                                         <dt>
 527                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>els</b>
 528
 529                                         </dt>
 530                                         <dd>A string CSS selector, an array of elements or an element</dd>
 531
 532                                 </dl>
 533
 534
 535
 536
 537
 538                                 <dl class="detailList">
 539                                 <dt class="heading">Returns:</dt>
 540
 541                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
 542
 543                                 </dl>
 544
 545
 546
 547
 548
 549
 550
 551                     </div>
 552                 </div>
 553
 554             </td>
 555             <td class="msource">
 556
 557                         Roo.CompositeElement
 558                 &nbsp;
 559             </td>
 560         </tr>
 561
 562
 563           <tr class="method-row config-row-alt0 expandable notInherited">
 564             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 565
 566
 567             <td class="sig">
 568                 <a id="Roo.CompositeElement-method-filter"   name=".filter"></a>
 569                 <div class="fixedFont">
 570                         <span class="attributes"></span><b class="itemname">filter</b>
 571
 572                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>selector</i></B>)
 573
 574
 575                                          :
 576
 577
 578                                                 CompositeElement
 579
 580
 581
 582
 583
 584                 </div>
 585                 <div class="mdesc">
 586
 587                    <div class="short">Filters this composite to only elements that match the passed selector.</div>
 588
 589
 590
 591                     <div class="long">
 592
 593                                 Filters this composite to only elements that match the passed selector.
 594
 595
 596
 597
 598
 599
 600                                 <dl class="detailList">
 601                                 <dt class="heading">Parameters:</dt>
 602
 603                                         <dt>
 604                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>selector</b>
 605
 606                                         </dt>
 607                                         <dd>A string CSS selector</dd>
 608
 609                                 </dl>
 610
 611
 612
 613
 614
 615                                 <dl class="detailList">
 616                                 <dt class="heading">Returns:</dt>
 617
 618                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
 619
 620                                 </dl>
 621
 622
 623
 624
 625
 626
 627
 628                     </div>
 629                 </div>
 630
 631             </td>
 632             <td class="msource">
 633
 634                         Roo.CompositeElement
 635                 &nbsp;
 636             </td>
 637         </tr>
 638
 639
 640           <tr class="method-row config-row-alt1 expandable notInherited">
 641             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 642
 643
 644             <td class="sig">
 645                 <a id="Roo.CompositeElement-method-first"   name=".first"></a>
 646                 <div class="fixedFont">
 647                         <span class="attributes"></span><b class="itemname">first</b>
 648
 649                                  ()
 650
 651
 652                                          :
 653
 654
 655                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 656
 657
 658
 659
 660
 661                 </div>
 662                 <div class="mdesc">
 663
 664                    <div class="short">Returns the first Element</div>
 665
 666
 667
 668                     <div class="long">
 669
 670                                 Returns the first Element
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681                                 <dl class="detailList">
 682                                 <dt class="heading">Returns:</dt>
 683
 684                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 685
 686                                 </dl>
 687
 688
 689
 690
 691
 692
 693
 694                     </div>
 695                 </div>
 696
 697             </td>
 698             <td class="msource">
 699
 700                         Roo.CompositeElement
 701                 &nbsp;
 702             </td>
 703         </tr>
 704
 705
 706           <tr class="method-row config-row-alt0 expandable notInherited">
 707             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 708
 709
 710             <td class="sig">
 711                 <a id="Roo.CompositeElement-method-getCount"   name=".getCount"></a>
 712                 <div class="fixedFont">
 713                         <span class="attributes"></span><b class="itemname">getCount</b>
 714
 715                                  ()
 716
 717
 718                                          :
 719
 720
 721
 722
 723
 724
 725
 726
 727                 </div>
 728                 <div class="mdesc">
 729
 730                    <div class="short">Returns the number of elements in this composite</div>
 731
 732
 733
 734                     <div class="long">
 735
 736                                 Returns the number of elements in this composite
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747                                 <dl class="detailList">
 748                                 <dt class="heading">Returns:</dt>
 749
 750                                         <dd> Number</dd>
 751
 752                                 </dl>
 753
 754
 755
 756
 757
 758
 759
 760                     </div>
 761                 </div>
 762
 763             </td>
 764             <td class="msource">
 765
 766                         Roo.CompositeElement
 767                 &nbsp;
 768             </td>
 769         </tr>
 770
 771
 772           <tr class="method-row config-row-alt1 expandable notInherited">
 773             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 774
 775
 776             <td class="sig">
 777                 <a id="Roo.CompositeElement-method-indexOf"   name=".indexOf"></a>
 778                 <div class="fixedFont">
 779                         <span class="attributes"></span><b class="itemname">indexOf</b>
 780
 781                                  ()
 782
 783
 784                                          :
 785
 786
 787
 788
 789
 790
 791
 792
 793                 </div>
 794                 <div class="mdesc">
 795
 796                    <div class="short">Returns true if this composite contains the passed element</div>
 797
 798
 799
 800                     <div class="long">
 801
 802                                 Returns true if this composite contains the passed element
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813                                 <dl class="detailList">
 814                                 <dt class="heading">Returns:</dt>
 815
 816                                         <dd> Boolean</dd>
 817
 818                                 </dl>
 819
 820
 821
 822
 823
 824
 825
 826                     </div>
 827                 </div>
 828
 829             </td>
 830             <td class="msource">
 831
 832                         Roo.CompositeElement
 833                 &nbsp;
 834             </td>
 835         </tr>
 836
 837
 838           <tr class="method-row config-row-alt0 expandable notInherited">
 839             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 840
 841
 842             <td class="sig">
 843                 <a id="Roo.CompositeElement-method-item"   name=".item"></a>
 844                 <div class="fixedFont">
 845                         <span class="attributes"></span><b class="itemname">item</b>
 846
 847                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
 848
 849
 850                                          :
 851
 852
 853                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 854
 855
 856
 857
 858
 859                 </div>
 860                 <div class="mdesc">
 861
 862                    <div class="short">Returns the Element object at the specified index</div>
 863
 864
 865
 866                     <div class="long">
 867
 868                                 Returns the Element object at the specified index
 869
 870
 871
 872
 873
 874
 875                                 <dl class="detailList">
 876                                 <dt class="heading">Parameters:</dt>
 877
 878                                         <dt>
 879                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
 880
 881                                         </dt>
 882                                         <dd></dd>
 883
 884                                 </dl>
 885
 886
 887
 888
 889
 890                                 <dl class="detailList">
 891                                 <dt class="heading">Returns:</dt>
 892
 893                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 894
 895                                 </dl>
 896
 897
 898
 899
 900
 901
 902
 903                     </div>
 904                 </div>
 905
 906             </td>
 907             <td class="msource">
 908
 909                         Roo.CompositeElement
 910                 &nbsp;
 911             </td>
 912         </tr>
 913
 914
 915           <tr class="method-row config-row-alt1 expandable notInherited">
 916             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 917
 918
 919             <td class="sig">
 920                 <a id="Roo.CompositeElement-method-last"   name=".last"></a>
 921                 <div class="fixedFont">
 922                         <span class="attributes"></span><b class="itemname">last</b>
 923
 924                                  ()
 925
 926
 927                                          :
 928
 929
 930                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 931
 932
 933
 934
 935
 936                 </div>
 937                 <div class="mdesc">
 938
 939                    <div class="short">Returns the last Element</div>
 940
 941
 942
 943                     <div class="long">
 944
 945                                 Returns the last Element
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956                                 <dl class="detailList">
 957                                 <dt class="heading">Returns:</dt>
 958
 959                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 960
 961                                 </dl>
 962
 963
 964
 965
 966
 967
 968
 969                     </div>
 970                 </div>
 971
 972             </td>
 973             <td class="msource">
 974
 975                         Roo.CompositeElement
 976                 &nbsp;
 977             </td>
 978         </tr>
 979
 980
 981           <tr class="method-row config-row-alt0 expandable notInherited">
 982             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 983
 984
 985             <td class="sig">
 986                 <a id="Roo.CompositeElement-method-removeElement"   name=".removeElement"></a>
 987                 <div class="fixedFont">
 988                         <span class="attributes"></span><b class="itemname">removeElement</b>
 989
 990                                  (Mixed <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeDom</i></B>)
 991
 992
 993                                          :
 994
 995
 996                                                 CompositeElement
 997
 998
 999
1000
1001
1002                 </div>
1003                 <div class="mdesc">
1004
1005                    <div class="short">Removes the specified element(s).</div>
1006
1007
1008
1009                     <div class="long">
1010
1011                                 Removes the specified element(s).
1012
1013
1014
1015
1016
1017
1018                                 <dl class="detailList">
1019                                 <dt class="heading">Parameters:</dt>
1020
1021                                         <dt>
1022                                                 <span class="fixedFont">Mixed</span>  <b>el</b>
1023
1024                                         </dt>
1025                                         <dd>The id of an element, the Element itself, the index of the element in this composite<br/>or an array of any of those.</dd>
1026
1027                                         <dt>
1028                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>removeDom</b>
1029
1030                                         </dt>
1031                                         <dd>(optional) True to also remove the element from the document</dd>
1032
1033                                 </dl>
1034
1035
1036
1037
1038
1039                                 <dl class="detailList">
1040                                 <dt class="heading">Returns:</dt>
1041
1042                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
1043
1044                                 </dl>
1045
1046
1047
1048
1049
1050
1051
1052                     </div>
1053                 </div>
1054
1055             </td>
1056             <td class="msource">
1057
1058                         Roo.CompositeElement
1059                 &nbsp;
1060             </td>
1061         </tr>
1062
1063
1064           <tr class="method-row config-row-alt1 expandable notInherited">
1065             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1066
1067
1068             <td class="sig">
1069                 <a id="Roo.CompositeElement-method-replaceElement"   name=".replaceElement"></a>
1070                 <div class="fixedFont">
1071                         <span class="attributes"></span><b class="itemname">replaceElement</b>
1072
1073                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element/Number <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>replacement</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>domReplace</i></B>)
1074
1075
1076                                          :
1077
1078
1079                                                 CompositeElement
1080
1081
1082
1083
1084
1085                 </div>
1086                 <div class="mdesc">
1087
1088                    <div class="short">Replaces the specified element with the passed element.</div>
1089
1090
1091
1092                     <div class="long">
1093
1094                                 Replaces the specified element with the passed element.
1095
1096
1097
1098
1099
1100
1101                                 <dl class="detailList">
1102                                 <dt class="heading">Parameters:</dt>
1103
1104                                         <dt>
1105                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element/Number</span>  <b>el</b>
1106
1107                                         </dt>
1108                                         <dd>The id of an element, the Element itself, the index of the element in this composite<br/>to replace.</dd>
1109
1110                                         <dt>
1111                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>replacement</b>
1112
1113                                         </dt>
1114                                         <dd>The id of an element or the Element itself.</dd>
1115
1116                                         <dt>
1117                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>domReplace</b>
1118
1119                                         </dt>
1120                                         <dd>(Optional) True to remove and replace the element in the document too.</dd>
1121
1122                                 </dl>
1123
1124
1125
1126
1127
1128                                 <dl class="detailList">
1129                                 <dt class="heading">Returns:</dt>
1130
1131                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
1132
1133                                 </dl>
1134
1135
1136
1137
1138
1139
1140
1141                     </div>
1142                 </div>
1143
1144             </td>
1145             <td class="msource">
1146
1147                         Roo.CompositeElement
1148                 &nbsp;
1149             </td>
1150         </tr>
1151
1152
1153     </table>
1154
1155
1156   <!-- ============================== events summary / details ======================== -->
1157
1158
1159   <a id="Roo.CompositeElement-events"></a>
1160
1161
1162
1163
1164
1165      <table cellspacing="0" class="member-table">
1166       <caption class="Empty">Events - Has None</caption>
1167      </table>
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177 <!-- ============================== footer ================================= -->
1178                 <div class="fineprint" style="clear:both">
1179
1180                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:22 GMT+0800 (HKT)
1181                         Based on
1182                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1183                 </div>
1184         </body>
1185 </html>