docs/output/Ext.CompositeElement.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.CompositeElement-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.CompositeElement-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.CompositeElement-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.CompositeElement"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.CompositeElement</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/CompositeElement.js" target="_blank">CompositeElement.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">CompositeElement</td></tr>
  13                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.CompositeElementLite" href="output/Ext.CompositeElementLite.html">CompositeElementLite</a></td></tr>
  14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  15                     </table>
  16         <div class="description">
  17             *
  18 Standard composite class. Creates a Ext.Element for every element in the collection.
  19 <br><br>
  20 <b>NOTE: Although they are not listed, this class supports all of the set/update methods of Ext.Element. All Ext.Element
  21 actions will be performed on all the elements in this collection.</b>
  22 <br><br>
  23 All methods return <i>this</i> and can be chained.\r
  24  <pre><code>var els = Ext.select(<em>"#some-el div.some-class"</em>, true);
  25  <i>// or select directly from an existing element</i>
  26  <b>var</b> el = Ext.get(<em>'some-el'</em>);
  27  el.select(<em>'div.some-class'</em>, true);
  28
  29  els.setWidth(100); <i>// all elements become 100 width</i>
  30  els.hide(true); <i>// all elements fade out and hide</i>
  31  <i>// or</i>
  32  els.setWidth(100).hide(true);</code></pre>        </div>
  33
  34         <div class="hr"></div>
  35                 <a id="Ext.CompositeElement-props"></a>
  36         <h2>Public Properties</h2>
  37         <div class="no-members">This class has no public properties.</div>        <a id="Ext.CompositeElement-methods"></a>
  38         <h2>Public Methods</h2>
  39                 <table cellspacing="0" class="member-table">
  40             <tr>
  41                 <th class="sig-header" colspan="2">Method</th>
  42                 <th class="msource-header">Defined By</th>
  43             </tr>
  44                 <tr class="method-row expandable">\r
  45         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  46         <td class="sig">\r
  47         <a id="Ext.CompositeElement-add"></a>\r
  48             <b>add</b>(&nbsp;<code>String/Array els</code>&nbsp;) : CompositeElement            <div class="mdesc">\r
  49                         <div class="short">Adds elements to this composite.</div>\r
  50             <div class="long">\r
  51                 Adds elements to this composite.    <div class="mdetail-params">\r
  52         <strong>Parameters:</strong>\r
  53         <ul><li><code>els</code> : String/Array<div class="sub-desc">A string CSS selector, an array of elements or an element</div></li>        </ul>\r
  54         <strong>Returns:</strong>\r
  55         <ul>\r
  56             <li><code>CompositeElement</code><div class="sub-desc">this</div></li>\r
  57         </ul>\r
  58     </div>\r
  59                 </div>\r
  60                         </div>\r
  61         </td>\r
  62         <td class="msource">CompositeElement</td>\r
  63     </tr>\r
  64         <tr class="method-row alt expandable">\r
  65         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  66         <td class="sig">\r
  67         <a id="Ext.CompositeElement-clear"></a>\r
  68             <b>clear</b>() : void            <div class="mdesc">\r
  69                         <div class="short">Removes all elements.</div>\r
  70             <div class="long">\r
  71                 Removes all elements.    <div class="mdetail-params">\r
  72         <strong>Parameters:</strong>\r
  73         <ul><li>None.</li>        </ul>\r
  74         <strong>Returns:</strong>\r
  75         <ul>\r
  76             <li><code>void</code></li>\r
  77         </ul>\r
  78     </div>\r
  79                 </div>\r
  80                         </div>\r
  81         </td>\r
  82         <td class="msource">CompositeElement</td>\r
  83     </tr>\r
  84         <tr class="method-row expandable">\r
  85         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  86         <td class="sig">\r
  87         <a id="Ext.CompositeElement-contains"></a>\r
  88             <b>contains</b>(&nbsp;<code>el {Mixed}</code>&nbsp;) : Boolean            <div class="mdesc">\r
  89                         <div class="short">Returns true if this composite contains the passed element</div>\r
  90             <div class="long">\r
  91                 Returns true if this composite contains the passed element    <div class="mdetail-params">\r
  92         <strong>Parameters:</strong>\r
  93         <ul><li><code>{Mixed}</code> : el<div class="sub-desc">The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.</div></li>        </ul>\r
  94         <strong>Returns:</strong>\r
  95         <ul>\r
  96             <li><code>Boolean</code></li>\r
  97         </ul>\r
  98     </div>\r
  99                 </div>\r
 100                         </div>\r
 101         </td>\r
 102         <td class="msource">CompositeElement</td>\r
 103     </tr>\r
 104         <tr class="method-row alt expandable">\r
 105         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 106         <td class="sig">\r
 107         <a id="Ext.CompositeElement-each"></a>\r
 108             <b>each</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : CompositeElement            <div class="mdesc">\r
 109                         <div class="short">Calls the passed function passing (el, this, index) for each element in this composite.</div>\r
 110             <div class="long">\r
 111                 Calls the passed function passing (el, this, index) for each element in this composite.    <div class="mdetail-params">\r
 112         <strong>Parameters:</strong>\r
 113         <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The <i>this</i> object (defaults to the element)</div></li>        </ul>\r
 114         <strong>Returns:</strong>\r
 115         <ul>\r
 116             <li><code>CompositeElement</code><div class="sub-desc">this</div></li>\r
 117         </ul>\r
 118     </div>\r
 119                 </div>\r
 120                         </div>\r
 121         </td>\r
 122         <td class="msource">CompositeElement</td>\r
 123     </tr>\r
 124         <tr class="method-row expandable">\r
 125         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 126         <td class="sig">\r
 127         <a id="Ext.CompositeElement-fill"></a>\r
 128             <b>fill</b>(&nbsp;<code>String/Array els</code>&nbsp;) : CompositeElement            <div class="mdesc">\r
 129                         <div class="short">Clears this composite and adds the elements returned by the passed selector.</div>\r
 130             <div class="long">\r
 131                 Clears this composite and adds the elements returned by the passed selector.    <div class="mdetail-params">\r
 132         <strong>Parameters:</strong>\r
 133         <ul><li><code>els</code> : String/Array<div class="sub-desc">A string CSS selector, an array of elements or an element</div></li>        </ul>\r
 134         <strong>Returns:</strong>\r
 135         <ul>\r
 136             <li><code>CompositeElement</code><div class="sub-desc">this</div></li>\r
 137         </ul>\r
 138     </div>\r
 139                 </div>\r
 140                         </div>\r
 141         </td>\r
 142         <td class="msource">CompositeElement</td>\r
 143     </tr>\r
 144         <tr class="method-row alt expandable">\r
 145         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 146         <td class="sig">\r
 147         <a id="Ext.CompositeElement-filter"></a>\r
 148             <b>filter</b>(&nbsp;<code>String selector</code>&nbsp;) : CompositeElement            <div class="mdesc">\r
 149                         <div class="short">Filters this composite to only elements that match the passed selector.</div>\r
 150             <div class="long">\r
 151                 Filters this composite to only elements that match the passed selector.    <div class="mdetail-params">\r
 152         <strong>Parameters:</strong>\r
 153         <ul><li><code>selector</code> : String<div class="sub-desc">A string CSS selector</div></li>        </ul>\r
 154         <strong>Returns:</strong>\r
 155         <ul>\r
 156             <li><code>CompositeElement</code><div class="sub-desc">this</div></li>\r
 157         </ul>\r
 158     </div>\r
 159                 </div>\r
 160                         </div>\r
 161         </td>\r
 162         <td class="msource">CompositeElement</td>\r
 163     </tr>\r
 164         <tr class="method-row expandable">\r
 165         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 166         <td class="sig">\r
 167         <a id="Ext.CompositeElement-first"></a>\r
 168             <b>first</b>() : Ext.Element            <div class="mdesc">\r
 169                         <div class="short">Returns the first Element</div>\r
 170             <div class="long">\r
 171                 Returns the first Element    <div class="mdetail-params">\r
 172         <strong>Parameters:</strong>\r
 173         <ul><li>None.</li>        </ul>\r
 174         <strong>Returns:</strong>\r
 175         <ul>\r
 176             <li><code>Ext.Element</code></li>\r
 177         </ul>\r
 178     </div>\r
 179                 </div>\r
 180                         </div>\r
 181         </td>\r
 182         <td class="msource">CompositeElement</td>\r
 183     </tr>\r
 184         <tr class="method-row alt expandable">\r
 185         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 186         <td class="sig">\r
 187         <a id="Ext.CompositeElement-getCount"></a>\r
 188             <b>getCount</b>() : Number            <div class="mdesc">\r
 189                         <div class="short">Returns the number of elements in this composite</div>\r
 190             <div class="long">\r
 191                 Returns the number of elements in this composite    <div class="mdetail-params">\r
 192         <strong>Parameters:</strong>\r
 193         <ul><li>None.</li>        </ul>\r
 194         <strong>Returns:</strong>\r
 195         <ul>\r
 196             <li><code>Number</code></li>\r
 197         </ul>\r
 198     </div>\r
 199                 </div>\r
 200                         </div>\r
 201         </td>\r
 202         <td class="msource">CompositeElement</td>\r
 203     </tr>\r
 204         <tr class="method-row expandable">\r
 205         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 206         <td class="sig">\r
 207         <a id="Ext.CompositeElement-indexOf"></a>\r
 208             <b>indexOf</b>(&nbsp;<code>el {Mixed}</code>&nbsp;) : Number            <div class="mdesc">\r
 209                         <div class="short">Find the index of the passed element within the composite collection.</div>\r
 210             <div class="long">\r
 211                 Find the index of the passed element within the composite collection.    <div class="mdetail-params">\r
 212         <strong>Parameters:</strong>\r
 213         <ul><li><code>{Mixed}</code> : el<div class="sub-desc">The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.</div></li>        </ul>\r
 214         <strong>Returns:</strong>\r
 215         <ul>\r
 216             <li><code>Number</code><div class="sub-desc">The index of the passed Ext.Element in the composite collection, or -1 if not found.</div></li>\r
 217         </ul>\r
 218     </div>\r
 219                 </div>\r
 220                         </div>\r
 221         </td>\r
 222         <td class="msource">CompositeElement</td>\r
 223     </tr>\r
 224         <tr class="method-row alt expandable">\r
 225         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 226         <td class="sig">\r
 227         <a id="Ext.CompositeElement-item"></a>\r
 228             <b>item</b>(&nbsp;<code>Number index</code>&nbsp;) : Ext.Element            <div class="mdesc">\r
 229                         <div class="short">Returns the Element object at the specified index</div>\r
 230             <div class="long">\r
 231                 Returns the Element object at the specified index    <div class="mdetail-params">\r
 232         <strong>Parameters:</strong>\r
 233         <ul><li><code>index</code> : Number<div class="sub-desc"></div></li>        </ul>\r
 234         <strong>Returns:</strong>\r
 235         <ul>\r
 236             <li><code>Ext.Element</code></li>\r
 237         </ul>\r
 238     </div>\r
 239                 </div>\r
 240                         </div>\r
 241         </td>\r
 242         <td class="msource">CompositeElement</td>\r
 243     </tr>\r
 244         <tr class="method-row expandable">\r
 245         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 246         <td class="sig">\r
 247         <a id="Ext.CompositeElement-last"></a>\r
 248             <b>last</b>() : Ext.Element            <div class="mdesc">\r
 249                         <div class="short">Returns the last Element</div>\r
 250             <div class="long">\r
 251                 Returns the last Element    <div class="mdetail-params">\r
 252         <strong>Parameters:</strong>\r
 253         <ul><li>None.</li>        </ul>\r
 254         <strong>Returns:</strong>\r
 255         <ul>\r
 256             <li><code>Ext.Element</code></li>\r
 257         </ul>\r
 258     </div>\r
 259                 </div>\r
 260                         </div>\r
 261         </td>\r
 262         <td class="msource">CompositeElement</td>\r
 263     </tr>\r
 264         <tr class="method-row alt expandable">\r
 265         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 266         <td class="sig">\r
 267         <a id="Ext.CompositeElement-removeElement"></a>\r
 268             <b>removeElement</b>(&nbsp;<code>Mixed el</code>, <span class="optional" title="Optional">[<code>Boolean removeDom</code>]</span>&nbsp;) : CompositeElement            <div class="mdesc">\r
 269                         <div class="short">Removes the specified element(s).</div>\r
 270             <div class="long">\r
 271                 Removes the specified element(s).    <div class="mdetail-params">\r
 272         <strong>Parameters:</strong>\r
 273         <ul><li><code>el</code> : Mixed<div class="sub-desc">The id of an element, the Element itself, the index of the element in this composite
 274 or an array of any of those.</div></li><li><code>removeDom</code> : Boolean<div class="sub-desc">(optional) True to also remove the element from the document</div></li>        </ul>\r
 275         <strong>Returns:</strong>\r
 276         <ul>\r
 277             <li><code>CompositeElement</code><div class="sub-desc">this</div></li>\r
 278         </ul>\r
 279     </div>\r
 280                 </div>\r
 281                         </div>\r
 282         </td>\r
 283         <td class="msource">CompositeElement</td>\r
 284     </tr>\r
 285         <tr class="method-row expandable">\r
 286         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 287         <td class="sig">\r
 288         <a id="Ext.CompositeElement-replaceElement"></a>\r
 289             <b>replaceElement</b>(&nbsp;<code>Mixed el</code>, <code>Mixed replacement</code>, <span class="optional" title="Optional">[<code>Boolean domReplace</code>]</span>&nbsp;) : CompositeElement            <div class="mdesc">\r
 290                         <div class="short">Replaces the specified element with the passed element.</div>\r
 291             <div class="long">\r
 292                 Replaces the specified element with the passed element.    <div class="mdetail-params">\r
 293         <strong>Parameters:</strong>\r
 294         <ul><li><code>el</code> : Mixed<div class="sub-desc">The id of an element, the Element itself, the index of the element in this composite
 295 to replace.</div></li><li><code>replacement</code> : Mixed<div class="sub-desc">The id of an element or the Element itself.</div></li><li><code>domReplace</code> : Boolean<div class="sub-desc">(Optional) True to remove and replace the element in the document too.</div></li>        </ul>\r
 296         <strong>Returns:</strong>\r
 297         <ul>\r
 298             <li><code>CompositeElement</code><div class="sub-desc">this</div></li>\r
 299         </ul>\r
 300     </div>\r
 301                 </div>\r
 302                         </div>\r
 303         </td>\r
 304         <td class="msource">CompositeElement</td>\r
 305     </tr>\r
 306             </table>
 307                 <a id="Ext.CompositeElement-events"></a>
 308         <h2>Public Events</h2>
 309         <div class="no-members">This class has no public events.</div>
 310         </div>