docs/output/Ext.CompositeElementLite.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.CompositeElementLite-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.CompositeElementLite-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.CompositeElementLite-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.CompositeElementLite"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/CompositeElementLite.html#cls-Ext.CompositeElementLite">Ext.CompositeElementLite</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/CompositeElementLite.html#cls-Ext.CompositeElementLite">CompositeElementLite.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CompositeElementLite.html#cls-Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.CompositeElement.html" ext:cls="Ext.CompositeElement">CompositeElement</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</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 Example:<pre><code><b>var</b> els = Ext.select(<em>"#some-el div.some-class"</em>);
   6 <i>// or select directly from an existing element</i>
   7 <b>var</b> el = Ext.get(<em>'some-el'</em>);
   8 el.select(<em>'div.some-class'</em>);
   9
  10 els.setWidth(100); <i>// all elements become 100 width</i>
  11 els.hide(true); <i>// all elements fade out and hide</i>
  12 <i>// or</i>
  13 els.setWidth(100).hide(true);
  14 </code></div><div class="hr"></div><a id="Ext.CompositeElementLite-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 "><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.
  15 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>
  16 <p>This will not <i>usually</i> be accessed in developers' code, but developers wishing
  17 to augment the capabilities of the CompositeElementLite class may use it when adding
  18 methods to the class.</p>
  19 <p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all
  20 following siblings of selected elements, the code would be</p><code><pre>
  21 Ext.override(Ext.CompositeElementLite, {
  22     nextAll: <b>function</b>() {
  23         <b>var</b> els = this.elements, i, l = els.length, n, r = [], ri = -1;
  24
  25 <i>//      Loop through all elements <b>in</b> this Composite, accumulating</i>
  26 <i>//      an Array of all siblings.</i>
  27         <b>for</b> (i = 0; i < l; i++) {
  28             <b>for</b> (n = els[i].nextSibling; n; n = n.nextSibling) {
  29                 r[++ri] = n;
  30             }
  31         }
  32
  33 <i>//      Add all found siblings to this Composite</i>
  34         <b>return</b> this.add(r);
  35     }
  36 });</pre></code></div></div></td><td class="msource">CompositeElementLite</td></tr></tbody></table><a id="Ext.CompositeElementLite-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.CompositeElementLite-add"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-add">add</a></b>(&nbsp;<code>Mixed&nbsp;els</code>&nbsp;)
  37     :
  38                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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>()
  39     :
  40                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  41     :
  42                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  43     :
  44                                         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>
  45 <li><b>el</b> : Element<div class="sub-desc">The current Element in the iteration.
  46 <b>This is the flyweight (shared) Ext.Element instance, so if you require a
  47 a reference to the dom node, use el.dom.</b></div></li>
  48 <li><b>c</b> : Composite<div class="sub-desc">This Composite object.</div></li>
  49 <li><b>idx</b> : Number<div class="sub-desc">The zero-based index in the iteration.</div></li>
  50 </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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  51     :
  52                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  53     :
  54                                         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.
  55 The comparison function will be called with the following arguments:<ul>
  56 <li><code>el</code> : Ext.Element<div class="sub-desc">The current DOM element.</div></li>
  57 <li><code>index</code> : Number<div class="sub-desc">The current index within the collection.</div></li>
  58 </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">CompositeElementLite</td></tr><tr class="method-row expandable "><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>()
  59     :
  60                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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>()
  61     :
  62                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  63     :
  64                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  65     :
  66                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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>()
  67     :
  68                                         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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  69     :
  70                                         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
  71 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">CompositeElementLite</td></tr><tr class="method-row expandable "><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;)
  72     :
  73                                         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
  74 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">CompositeElementLite</td></tr></tbody></table><a id="Ext.CompositeElementLite-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>