sync
[roojs1] / docs / symbols / Roo.CompositeElementLite.html
index 4b1934d..32d1dc0 100644 (file)
         </tr>
        
          
-          <tr class="method-row config-row-alt1 expandable notInherited">
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-add"   name=".add"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">add</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>els</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               CompositeElement
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Adds elements to this composite.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Adds elements to this composite.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>els</b>
+                                               
+                                       </dt>
+                                       <dd>A string CSS selector, an array of elements or an element</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">CompositeElement</span>  this</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-clear"   name=".clear"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">clear</b>
+                               
+                                () 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Removes all elements.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Removes all elements.
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-contains"   name=".contains"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">contains</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <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
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd> Boolean</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
           
           
         </tr>
        
          
-          <tr class="method-row config-row-alt0 expandable notInherited">
+          <tr class="method-row config-row-alt1 expandable">
             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
           
           
             <td class="sig">
-                <a id="Roo.CompositeElementLite-method-item"   name=".item"></a>
+                <a id="Roo.CompositeElement-method-fill"   name=".fill"></a>
                <div class="fixedFont">
-                       <span class="attributes"></span><b class="itemname">item</b>
+                       <span class="attributes"></span><b class="itemname">fill</b>
                                
-                                (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>) 
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array <B><i>els</i></B>) 
                        
                                
                                         : 
                                        
                                                
-                                               <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+                                               CompositeElement
                                        
                                        
                                        
                </div>
                 <div class="mdesc">
                
-                   <div class="short">Returns a flyweight Element of the dom element object at the specified index</div> 
+                   <div class="short">Clears this composite and adds the elements returned by the passed selector.</div> 
                 
                 
                 
                     <div class="long">
                        
-                               Returns a flyweight Element of the dom element object at the specified index
+                               Clears this composite and adds the elements returned by the passed selector.
                    
                                
                        
                                <dt class="heading">Parameters:</dt>
                                
                                        <dt>
-                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Array</span>  <b>els</b>
                                                
                                        </dt>
-                                       <dd></dd>
+                                       <dd>A string CSS selector, an array of elements or an element</dd>
                                
                                </dl>
                        
                                <dl class="detailList">
                                <dt class="heading">Returns:</dt>
                                
-                                       <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
+                                       <dd><span class="fixedFont">CompositeElement</span>  this</dd>
                                
                                </dl>
                        
             </td>
             <td class="msource">
                
-                       Roo.CompositeElementLite
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-filter"   name=".filter"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">filter</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>selector</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               CompositeElement
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <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.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>selector</b>
+                                               
+                                       </dt>
+                                       <dd>A string CSS selector</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">CompositeElement</span>  this</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-first"   name=".first"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">first</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns the first Element</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns the first Element
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-getCount"   name=".getCount"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">getCount</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <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
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd> Number</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-indexOf"   name=".indexOf"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">indexOf</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <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
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd> Boolean</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElementLite-method-item"   name=".item"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">item</b>
+                               
+                                (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <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
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
+                                               
+                                       </dt>
+                                       <dd></dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.CompositeElementLite
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-last"   name=".last"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">last</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns the last Element</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns the last Element
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-removeElement"   name=".removeElement"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">removeElement</b>
+                               
+                                (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>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               CompositeElement
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Removes the specified element(s).</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Removes the specified element(s).
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Mixed</span>  <b>el</b>
+                                               
+                                       </dt>
+                                       <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>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>(optional) True to also remove the element from the document</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">CompositeElement</span>  this</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.CompositeElement-method-replaceElement"   name=".replaceElement"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">replaceElement</b>
+                               
+                                (<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>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               CompositeElement
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <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.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element/Number</span>  <b>el</b>
+                                               
+                                       </dt>
+                                       <dd>The id of an element, the Element itself, the index of the element in this composite<br/>to replace.</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>replacement</b>
+                                               
+                                       </dt>
+                                       <dd>The id of an element or the Element itself.</dd>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>(Optional) True to remove and replace the element in the document too.</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">CompositeElement</span>  this</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
                &nbsp;
             </td>
         </tr>
 <!-- ============================== footer ================================= -->
                <div class="fineprint" style="clear:both">
                        
-                       Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:05:43 GMT+0800 (HKT)
+                       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)
                        Based on 
                        <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
                </div>