docs/output/Ext.CompositeElement.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.CompositeElement-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.CompositeElement-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.CompositeElement-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.CompositeElement"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.CompositeElementLite.html" ext:member="" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">CompositeElement</pre></div><h1>Class <a href="source/CompositeElement.html#cls-Ext.CompositeElement">Ext.CompositeElement</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/CompositeElement.html#cls-Ext.CompositeElement">CompositeElement.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CompositeElement.html#cls-Ext.CompositeElement">CompositeElement</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.CompositeElementLite.html" ext:cls="Ext.CompositeElementLite" ext:member="">CompositeElementLite</a></td></tr></table><div class="description"><p>This class encapsulates a <i>collection</i> of DOM elements, providing methods to filter
   2 members, or to perform collective actions upon the whole set.</p>
   3 <p>Although they are not listed, this class supports all of the methods of <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> and
   4 <a href="output/Ext.Fx.html" ext:cls="Ext.Fx">Ext.Fx</a>. The methods from these classes will be performed on all the elements in this collection.</p>
   5 <p>All methods return <i>this</i> and can be chained.</p>
   6 Usage:
   7 <pre><code><b>var</b> els = Ext.select(<em>"#some-el div.some-class"</em>, true);
   8 <i>// or select directly from an existing element</i>
   9 <b>var</b> el = Ext.get(<em>'some-el'</em>);
  10 el.select(<em>'div.some-class'</em>, true);
  11
  12 els.setWidth(100); <i>// all elements become 100 width</i>
  13 els.hide(true); <i>// all elements fade out and hide</i>
  14 <i>// or</i>
  15 els.setWidth(100).hide(true);</code></pre></div><div class="hr"></div><a id="Ext.CompositeElement-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-elements"></a><b><a href="source/CompositeElementLite.html#prop-Ext.CompositeElementLite-elements">elements</a></b> : Array<div class="mdesc"><div class="short">The Array of DOM elements which this CompositeElement encapsulates. Read-only.
  16 This will not usually be accessed in d...</div><div class="long"><p>The Array of DOM elements which this CompositeElement encapsulates. Read-only.</p>
  17 <p>This will not <i>usually</i> be accessed in developers' code, but developers wishing
  18 to augment the capabilities of the CompositeElementLite class may use it when adding
  19 methods to the class.</p>
  20 <p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all
  21 following siblings of selected elements, the code would be</p><code><pre>
  22 Ext.override(Ext.CompositeElementLite, {
  23     nextAll: <b>function</b>() {
  24         <b>var</b> els = this.elements, i, l = els.length, n, r = [], ri = -1;
  25
  26 <i>//      Loop through all elements <b>in</b> this Composite, accumulating</i>
  27 <i>//      an Array of all siblings.</i>
  28         <b>for</b> (i = 0; i < l; i++) {
  29             <b>for</b> (n = els[i].nextSibling; n; n = n.nextSibling) {
  30                 r[++ri] = n;
  31             }
  32         }
  33
  34 <i>//      Add all found siblings to this Composite</i>
  35         <b>return</b> this.add(r);
  36     }
  37 });</pre></code></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#elements" ext:member="#elements" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr></tbody></table><a id="Ext.CompositeElement-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElement-"></a><b><a href="source/CompositeElement.html#method-Ext.CompositeElement-"></a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
  38     :
  39                                         CompositeElement<div class="mdesc"><div class="short">Iterates each element in this composite
  40 calling the supplied function using Ext.each.</div><div class="long">Iterates each <code>element</code> in this <code>composite</code>
  41 calling the supplied function using <a href="output/Ext.html#Ext-each" ext:member="each" ext:cls="Ext">Ext.each</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called with each
  42 <code>element</code>. If the supplied function returns <tt>false</tt>,
  43 iteration stops. This function is called with the following arguments:
  44 <div class="mdetail-params"><ul>
  45 <li><code>element</code> : <i>Ext.Element</i><div class="sub-desc">The element at the current <code>index</code>
  46 in the <code>composite</code></div></li>
  47 <li><code>composite</code> : <i>Object</i> <div class="sub-desc">This composite.</div></li>
  48 <li><code>index</code> : <i>Number</i> <div class="sub-desc">The current index within the <code>composite</code> </div></li>
  49 </ul></div></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><this</code> reference) in which the specified function is executed.
  50 Defaults to the <code>element</code> at the current <code>index</code>
  51 within the composite.</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">CompositeElement</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-add"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-add">add</a></b>(&nbsp;<code>Mixed&nbsp;els</code>&nbsp;)
  52     :
  53                                         CompositeElement<div class="mdesc"><div class="short">Adds elements to this Composite object.</div><div class="long">Adds elements to this Composite object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>els</code> : Mixed<div class="sub-desc">Either an Array of DOM elements to add, or another Composite object who's elements should be added.</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">This Composite object.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#add" ext:member="#add" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-clear"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-clear">clear</a></b>()
  54     :
  55                                         void<div class="mdesc"><div class="short">Removes all elements.</div><div class="long">Removes all elements.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#clear" ext:member="#clear" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-contains"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-contains">contains</a></b>(&nbsp;<code>el&nbsp;{Mixed}</code>&nbsp;)
  56     :
  57                                         Boolean<div class="mdesc"><div class="short">Returns true if this composite contains the passed element</div><div class="long">Returns true if this composite contains the passed element<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#contains" ext:member="#contains" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-each"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-each">each</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
  58     :
  59                                         CompositeElement<div class="mdesc"><div class="short">Calls the passed function for each element in this composite.</div><div class="long"><p>Calls the passed function for each element in this composite.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to call. The function is passed the following parameters:<ul>
  60 <li><b>el</b> : Element<div class="sub-desc">The current Element in the iteration.
  61 <b>This is the flyweight (shared) Ext.Element instance, so if you require a
  62 a reference to the dom node, use el.dom.</b></div></li>
  63 <li><b>c</b> : Composite<div class="sub-desc">This Composite object.</div></li>
  64 <li><b>idx</b> : Number<div class="sub-desc">The zero-based index in the iteration.</div></li>
  65 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<i>this</i> reference) in which the function is executed. (defaults to the Element)</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#each" ext:member="#each" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-fill"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-fill">fill</a></b>(&nbsp;<code>Mixed&nbsp;els</code>&nbsp;)
  66     :
  67                                         CompositeElement<div class="mdesc"><div class="short">Clears this Composite and adds the elements passed.</div><div class="long">Clears this Composite and adds the elements passed.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>els</code> : Mixed<div class="sub-desc">Either an array of DOM elements, or another Composite from which to fill this Composite.</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#fill" ext:member="#fill" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-filter"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-filter">filter</a></b>(&nbsp;<code>String/Function&nbsp;selector</code>&nbsp;)
  68     :
  69                                         CompositeElement<div class="mdesc"><div class="short">Filters this composite to only elements that match the passed selector.</div><div class="long">Filters this composite to only elements that match the passed selector.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String/Function<div class="sub-desc">A string CSS selector or a comparison function.
  70 The comparison function will be called with the following arguments:<ul>
  71 <li><code>el</code> : Ext.Element<div class="sub-desc">The current DOM element.</div></li>
  72 <li><code>index</code> : Number<div class="sub-desc">The current index within the collection.</div></li>
  73 </ul></div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#filter" ext:member="#filter" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-first"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-first">first</a></b>()
  74     :
  75                                         Ext.Element<div class="mdesc"><div class="short">Returns the first Element</div><div class="long">Returns the first Element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#first" ext:member="#first" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-getCount"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-getCount">getCount</a></b>()
  76     :
  77                                         Number<div class="mdesc"><div class="short">Returns the number of elements in this Composite.</div><div class="long">Returns the number of elements in this Composite.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#getCount" ext:member="#getCount" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-indexOf"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-indexOf">indexOf</a></b>(&nbsp;<code>el&nbsp;{Mixed}</code>&nbsp;)
  78     :
  79                                         Number<div class="mdesc"><div class="short">Find the index of the passed element within the composite collection.</div><div class="long">Find the index of the passed element within the composite collection.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><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></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#indexOf" ext:member="#indexOf" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-item"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-item">item</a></b>(&nbsp;<code>Number&nbsp;index</code>&nbsp;)
  80     :
  81                                         Ext.Element<div class="mdesc"><div class="short">Returns a flyweight Element of the dom element object at the specified index</div><div class="long">Returns a flyweight Element of the dom element object at the specified index<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#item" ext:member="#item" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-last"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-last">last</a></b>()
  82     :
  83                                         Ext.Element<div class="mdesc"><div class="short">Returns the last Element</div><div class="long">Returns the last Element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#last" ext:member="#last" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-removeElement"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-removeElement">removeElement</a></b>(&nbsp;<code>Mixed&nbsp;el</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;removeDom</code>]</span>&nbsp;)
  84     :
  85                                         CompositeElement<div class="mdesc"><div class="short">Removes the specified element(s).</div><div class="long">Removes the specified element(s).<div class="mdetail-params"><strong>Parameters:</strong><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
  86 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><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#removeElement" ext:member="#removeElement" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-replaceElement"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-replaceElement">replaceElement</a></b>(&nbsp;<code>Mixed&nbsp;el</code>,&nbsp;<code>Mixed&nbsp;replacement</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;domReplace</code>]</span>&nbsp;)
  87     :
  88                                         CompositeElement<div class="mdesc"><div class="short">Replaces the specified element with the passed element.</div><div class="long">Replaces the specified element with the passed element.<div class="mdetail-params"><strong>Parameters:</strong><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
  89 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><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.CompositeElementLite.html#replaceElement" ext:member="#replaceElement" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a></td></tr></tbody></table><a id="Ext.CompositeElement-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>