Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / CompositeElement2.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><span id='Ext-CompositeElement'>/**
19 </span> * @class Ext.CompositeElement
20  * @extends Ext.CompositeElementLite
21  * &lt;p&gt;This class encapsulates a &lt;i&gt;collection&lt;/i&gt; of DOM elements, providing methods to filter
22  * members, or to perform collective actions upon the whole set.&lt;/p&gt;
23  * &lt;p&gt;Although they are not listed, this class supports all of the methods of {@link Ext.Element} and
24  * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection.&lt;/p&gt;
25  * &lt;p&gt;All methods return &lt;i&gt;this&lt;/i&gt; and can be chained.&lt;/p&gt;
26  * Usage:
27 &lt;pre&gt;&lt;code&gt;
28 var els = Ext.select(&quot;#some-el div.some-class&quot;, true);
29 // or select directly from an existing element
30 var el = Ext.get('some-el');
31 el.select('div.some-class', true);
32
33 els.setWidth(100); // all elements become 100 width
34 els.hide(true); // all elements fade out and hide
35 // or
36 els.setWidth(100).hide(true);
37 &lt;/code&gt;&lt;/pre&gt;
38  */
39 Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, {
40
41     constructor : function(els, root){
42         this.elements = [];
43         this.add(els, root);
44     },
45
46     // private
47     getElement : function(el){
48         // In this case just return it, since we already have a reference to it
49         return el;
50     },
51
52     // private
53     transformElement : function(el){
54         return Ext.get(el);
55     }
56 });
57
58 <span id='Ext-Element-method-select'>/**
59 </span> * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
60  * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
61  * {@link Ext.CompositeElementLite CompositeElementLite} object.
62  * @param {String/HTMLElement[]} selector The CSS selector or an array of elements
63  * @param {Boolean} [unique] true to create a unique Ext.Element for each element (defaults to a shared flyweight object)
64  * @param {HTMLElement/String} [root] The root element of the query or id of the root
65  * @return {Ext.CompositeElementLite/Ext.CompositeElement}
66  * @member Ext.Element
67  * @method select
68  */
69 Ext.Element.select = function(selector, unique, root){
70     var els;
71     if(typeof selector == &quot;string&quot;){
72         els = Ext.Element.selectorFunction(selector, root);
73     }else if(selector.length !== undefined){
74         els = selector;
75     }else{
76         //&lt;debug&gt;
77         Ext.Error.raise({
78             sourceClass: &quot;Ext.Element&quot;,
79             sourceMethod: &quot;select&quot;,
80             selector: selector,
81             unique: unique,
82             root: root,
83             msg: &quot;Invalid selector specified: &quot; + selector
84         });
85         //&lt;/debug&gt;
86     }
87     return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);
88 };
89
90 <span id='Ext-method-select'>/**
91 </span> * Shorthand of {@link Ext.Element#select}.
92  * @member Ext
93  * @method select
94  * @alias Ext.Element#select
95  */
96 Ext.select = Ext.Element.select;</pre>
97 </body>
98 </html>