1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.CompositeElementLite</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.CompositeElementLite-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.CompositeElementLite-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.CompositeElementLite-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.CompositeElementLite-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>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.CompositeElementLite
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.CompositeElementLite
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_CompositeElementLite.js.html">Roo/CompositeElementLite.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">CompositeElementLite</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Flyweight composite class. Reuses the same Roo.Element for element operations.<br/> <pre><code><br/> var els = Roo.select("<b>some</b>-el div.some-class");<br/> // or select directly from an existing element<br/> var el = Roo.get('some-el');<br/> el.select('div.some-class');<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><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>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.CompositeElementLite';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.CompositeElementLite.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.CompositeElementLite-configs"></a>
111 <table cellspacing="0" class="member-table">
112 <caption class="Empty">Config Options - Has None</caption>
126 <!-- ============================== public properties ==================== -->
130 <a id="Roo.CompositeElementLite-props"></a>
136 <table cellspacing="0" class="member-table">
137 <caption class="Empty">Public Properties - Has None</caption>
143 <!-- ============================== methods summary / details ======================== -->
146 <a id="Roo.CompositeElementLite-methods"></a>
147 <!-- constructor?? -->
154 <!-- then dynamics first -->
161 <table cellspacing="0" class="member-table">
162 <caption>Public Methods</caption>
164 <th class="sig-header" colspan="2">Method</th>
165 <th class="msource-header">Defined By</th>
175 <tr class="method-row config-row-alt0 notInherited">
176 <td class="micon"><a class="exi" href="#expand"> </a></td>
180 <a id="Roo-method-CompositeElementLite" name=".CompositeElementLite"></a>
181 <div class="fixedFont">
182 <span class="attributes">new <B>Roo.</B></span><b class="itemname">CompositeElementLite</b>
192 <div class="short">Create a new Roo.CompositeElementLite</div>
199 Create a new Roo.CompositeElementLite
222 <tr class="method-row config-row-alt1 expandable">
223 <td class="micon"><a class="exi" href="#expand"> </a></td>
227 <a id="Roo.CompositeElement-method-add" name=".add"></a>
228 <div class="fixedFont">
229 <span class="attributes"></span><b class="itemname">add</b>
231 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>els</i></B>)
246 <div class="short">Adds elements to this composite.</div>
252 Adds elements to this composite.
259 <dl class="detailList">
260 <dt class="heading">Parameters:</dt>
263 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span> <b>els</b>
266 <dd>A string CSS selector, an array of elements or an element</dd>
274 <dl class="detailList">
275 <dt class="heading">Returns:</dt>
277 <dd><span class="fixedFont">CompositeElement</span> this</dd>
293 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
299 <tr class="method-row config-row-alt0 expandable">
300 <td class="micon"><a class="exi" href="#expand"> </a></td>
304 <a id="Roo.CompositeElement-method-clear" name=".clear"></a>
305 <div class="fixedFont">
306 <span class="attributes"></span><b class="itemname">clear</b>
315 <div class="short">Removes all elements.</div>
321 Removes all elements.
344 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
350 <tr class="method-row config-row-alt1 expandable">
351 <td class="micon"><a class="exi" href="#expand"> </a></td>
355 <a id="Roo.CompositeElement-method-contains" name=".contains"></a>
356 <div class="fixedFont">
357 <span class="attributes"></span><b class="itemname">contains</b>
374 <div class="short">Returns true if this composite contains the passed element</div>
380 Returns true if this composite contains the passed element
391 <dl class="detailList">
392 <dt class="heading">Returns:</dt>
410 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
416 <tr class="method-row config-row-alt0 expandable notInherited">
417 <td class="micon"><a class="exi" href="#expand"> </a></td>
421 <a id="Roo.CompositeElementLite-method-each" name=".each"></a>
422 <div class="fixedFont">
423 <span class="attributes"></span><b class="itemname">each</b>
425 (<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>)
440 <div class="short">Calls the passed function passing (el, this, index) for each element in this composite.</div>
446 Calls the passed function passing (el, this, index) for each element in this composite. <b>The element<br/>passed is the flyweight (shared) Roo.Element instance, so if you require a<br/>a reference to the dom node, use el.dom.</b>
453 <dl class="detailList">
454 <dt class="heading">Parameters:</dt>
457 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
460 <dd>The function to call</dd>
463 <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>
466 <dd>(optional) The <i>this</i> object (defaults to the element)</dd>
474 <dl class="detailList">
475 <dt class="heading">Returns:</dt>
477 <dd><span class="fixedFont">CompositeElement</span> this</dd>
493 Roo.CompositeElementLite
499 <tr class="method-row config-row-alt1 expandable">
500 <td class="micon"><a class="exi" href="#expand"> </a></td>
504 <a id="Roo.CompositeElement-method-fill" name=".fill"></a>
505 <div class="fixedFont">
506 <span class="attributes"></span><b class="itemname">fill</b>
508 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>els</i></B>)
523 <div class="short">Clears this composite and adds the elements returned by the passed selector.</div>
529 Clears this composite and adds the elements returned by the passed selector.
536 <dl class="detailList">
537 <dt class="heading">Parameters:</dt>
540 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span> <b>els</b>
543 <dd>A string CSS selector, an array of elements or an element</dd>
551 <dl class="detailList">
552 <dt class="heading">Returns:</dt>
554 <dd><span class="fixedFont">CompositeElement</span> this</dd>
570 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
576 <tr class="method-row config-row-alt0 expandable">
577 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.CompositeElement-method-filter" name=".filter"></a>
582 <div class="fixedFont">
583 <span class="attributes"></span><b class="itemname">filter</b>
585 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>selector</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>inverse</i></B>)
600 <div class="short">Filters this composite to only elements that match the passed selector.</div>
606 Filters this composite to only elements that match the passed selector.
613 <dl class="detailList">
614 <dt class="heading">Parameters:</dt>
617 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>selector</b>
620 <dd>A string CSS selector</dd>
623 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>inverse</b>
626 <dd>return inverse filter (not matches)</dd>
634 <dl class="detailList">
635 <dt class="heading">Returns:</dt>
637 <dd><span class="fixedFont">CompositeElement</span> this</dd>
653 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
659 <tr class="method-row config-row-alt1 expandable">
660 <td class="micon"><a class="exi" href="#expand"> </a></td>
664 <a id="Roo.CompositeElement-method-first" name=".first"></a>
665 <div class="fixedFont">
666 <span class="attributes"></span><b class="itemname">first</b>
674 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
683 <div class="short">Returns the first Element</div>
689 Returns the first Element
700 <dl class="detailList">
701 <dt class="heading">Returns:</dt>
703 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
719 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
725 <tr class="method-row config-row-alt0 expandable">
726 <td class="micon"><a class="exi" href="#expand"> </a></td>
730 <a id="Roo.CompositeElement-method-getCount" name=".getCount"></a>
731 <div class="fixedFont">
732 <span class="attributes"></span><b class="itemname">getCount</b>
749 <div class="short">Returns the number of elements in this composite</div>
755 Returns the number of elements in this composite
766 <dl class="detailList">
767 <dt class="heading">Returns:</dt>
785 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
791 <tr class="method-row config-row-alt1 expandable">
792 <td class="micon"><a class="exi" href="#expand"> </a></td>
796 <a id="Roo.CompositeElement-method-indexOf" name=".indexOf"></a>
797 <div class="fixedFont">
798 <span class="attributes"></span><b class="itemname">indexOf</b>
815 <div class="short">Returns true if this composite contains the passed element</div>
821 Returns true if this composite contains the passed element
832 <dl class="detailList">
833 <dt class="heading">Returns:</dt>
851 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
857 <tr class="method-row config-row-alt0 expandable notInherited">
858 <td class="micon"><a class="exi" href="#expand"> </a></td>
862 <a id="Roo.CompositeElementLite-method-item" name=".item"></a>
863 <div class="fixedFont">
864 <span class="attributes"></span><b class="itemname">item</b>
866 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
872 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
881 <div class="short">Returns a flyweight Element of the dom element object at the specified index</div>
887 Returns a flyweight Element of the dom element object at the specified index
894 <dl class="detailList">
895 <dt class="heading">Parameters:</dt>
898 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
909 <dl class="detailList">
910 <dt class="heading">Returns:</dt>
912 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
928 Roo.CompositeElementLite
934 <tr class="method-row config-row-alt1 expandable">
935 <td class="micon"><a class="exi" href="#expand"> </a></td>
939 <a id="Roo.CompositeElement-method-last" name=".last"></a>
940 <div class="fixedFont">
941 <span class="attributes"></span><b class="itemname">last</b>
949 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
958 <div class="short">Returns the last Element</div>
964 Returns the last Element
975 <dl class="detailList">
976 <dt class="heading">Returns:</dt>
978 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
994 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
1000 <tr class="method-row config-row-alt0 expandable">
1001 <td class="micon"><a class="exi" href="#expand"> </a></td>
1005 <a id="Roo.CompositeElement-method-removeElement" name=".removeElement"></a>
1006 <div class="fixedFont">
1007 <span class="attributes"></span><b class="itemname">removeElement</b>
1009 (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>)
1024 <div class="short">Removes the specified element(s).</div>
1030 Removes the specified element(s).
1037 <dl class="detailList">
1038 <dt class="heading">Parameters:</dt>
1041 <span class="fixedFont">Mixed</span> <b>el</b>
1044 <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>
1047 <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>
1050 <dd>(optional) True to also remove the element from the document</dd>
1058 <dl class="detailList">
1059 <dt class="heading">Returns:</dt>
1061 <dd><span class="fixedFont">CompositeElement</span> this</dd>
1075 <td class="msource">
1077 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
1083 <tr class="method-row config-row-alt1 expandable">
1084 <td class="micon"><a class="exi" href="#expand"> </a></td>
1088 <a id="Roo.CompositeElement-method-replaceElement" name=".replaceElement"></a>
1089 <div class="fixedFont">
1090 <span class="attributes"></span><b class="itemname">replaceElement</b>
1092 (<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>)
1107 <div class="short">Replaces the specified element with the passed element.</div>
1113 Replaces the specified element with the passed element.
1120 <dl class="detailList">
1121 <dt class="heading">Parameters:</dt>
1124 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element/Number</span> <b>el</b>
1127 <dd>The id of an element, the Element itself, the index of the element in this composite<br/>to replace.</dd>
1130 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>replacement</b>
1133 <dd>The id of an element or the Element itself.</dd>
1136 <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>
1139 <dd>(Optional) True to remove and replace the element in the document too.</dd>
1147 <dl class="detailList">
1148 <dt class="heading">Returns:</dt>
1150 <dd><span class="fixedFont">CompositeElement</span> this</dd>
1164 <td class="msource">
1166 <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
1175 <!-- ============================== events summary / details ======================== -->
1178 <a id="Roo.CompositeElementLite-events"></a>
1184 <table cellspacing="0" class="member-table">
1185 <caption class="Empty">Events - Has None</caption>
1196 <!-- ============================== footer ================================= -->
1197 <div class="fineprint" style="clear:both">
1199 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Apr 25 2016 14:57:00 GMT+0800 (HKT)
1201 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>