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