Upgrade to ExtJS 3.2.1 - Released 04/27/2010
[extjs.git] / docs / source / CompositeElement.html
index 8a932f2..29db01d 100644 (file)
 <html>
 <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
   <title>The source code</title>
     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
 </head>
 <body  onload="prettyPrint();">
     <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
+ * Ext JS Library 3.2.1
+ * Copyright(c) 2006-2010 Ext JS, Inc.
  * licensing@extjs.com
  * http://www.extjs.com/license
  */
-<div id="cls-Ext.CompositeElement"></div>/**\r
- * @class Ext.CompositeElement\r
- * @extends Ext.CompositeElementLite\r
- * Standard composite class. Creates a Ext.Element for every element in the collection.\r
- * <br><br>\r
- * <b>NOTE: Although they are not listed, this class supports all of the set/update methods of Ext.Element. All Ext.Element\r
- * actions will be performed on all the elements in this collection.</b>\r
- * <br><br>\r
- * All methods return <i>this</i> and can be chained.\r
- <pre><code>\r
- var els = Ext.select("#some-el div.some-class", true);\r
- // or select directly from an existing element\r
- var el = Ext.get('some-el');\r
- el.select('div.some-class', true);\r
-\r
- els.setWidth(100); // all elements become 100 width\r
- els.hide(true); // all elements fade out and hide\r
- // or\r
- els.setWidth(100).hide(true);\r
- </code></pre>\r
- */\r
-Ext.CompositeElement = function(els, root){\r
-    this.elements = [];\r
-    this.add(els, root);\r
-};\r
-\r
-Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {\r
-    invoke : function(fn, args){\r
-           Ext.each(this.elements, function(e) {\r
-               Ext.Element.prototype[fn].apply(e, args);\r
-        });\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.CompositeElement-add"></div>/**\r
-    * Adds elements to this composite.\r
-    * @param {String/Array} els A string CSS selector, an array of elements or an element\r
-    * @return {CompositeElement} this\r
-    */\r
-    add : function(els, root){\r
-           if(!els){\r
-            return this;\r
-        }\r
-        if(typeof els == "string"){\r
-            els = Ext.Element.selectorFunction(els, root);\r
-        }\r
-        var yels = this.elements;\r
-           Ext.each(els, function(e) {\r
-               yels.push(Ext.get(e));\r
-        });\r
-        return this;\r
-    },\r
-\r
-    <div id="method-Ext.CompositeElement-item"></div>/**\r
-     * Returns the Element object at the specified index\r
-     * @param {Number} index\r
-     * @return {Ext.Element}\r
-     */\r
-    item : function(index){\r
-        return this.elements[index] || null;\r
-    },\r
-\r
-\r
-    indexOf : function(el){\r
-        return this.elements.indexOf(Ext.get(el));\r
-    },\r
-\r
-    filter : function(selector){\r
-               var me = this,\r
-                       out = [];\r
-\r
-               Ext.each(me.elements, function(el) {\r
-                       if(el.is(selector)){\r
-                               out.push(Ext.get(el));\r
-                       }\r
-               });\r
-               me.elements = out;\r
-               return me;\r
-       },\r
-\r
-    <div id="method-Ext.CompositeElement-each"></div>/**\r
-     * Iterates each <code>element</code> in this <code>composite</code>\r
-     * calling the supplied function using {@link Ext#each}.\r
-     * @param {Function} fn The function to be called with each\r
-     * <code>element</code>. If the supplied function returns <tt>false</tt>,\r
-     * iteration stops. This function is called with the following arguments:\r
-     * <div class="mdetail-params"><ul>\r
-     * <li><code>element</code> : <i>Object</i>\r
-     * <div class="sub-desc">The element at the current <code>index</code>\r
-     * in the <code>composite</code></div></li>\r
-     * <li><code>composite</code> : <i>Object</i>\r
-     * <div class="sub-desc">This composite.</div></li>\r
-     * <li><code>index</code> : <i>Number</i>\r
-     * <div class="sub-desc">The current index within the <code>composite</code>\r
-     * </div></li>\r
-     * </ul></div>\r
-     * @param {Object} scope (optional) The scope to call the specified function.\r
-     * Defaults to the <code>element</code> at the current <code>index</code>\r
-     * within the composite.\r
-     * @return {CompositeElement} this\r
-     */\r
-    each : function(fn, scope){\r
-        Ext.each(this.elements, function(e, i){\r
-            return fn.call(scope || e, e, this, i);\r
-        }, this);\r
-        return this;\r
-    }\r
-});\r
-\r
-/**\r
- * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods\r
- * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or\r
- * {@link Ext.CompositeElementLite CompositeElementLite} object.\r
- * @param {String/Array} selector The CSS selector or an array of elements\r
- * @param {Boolean} unique (optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object)\r
- * @param {HTMLElement/String} root (optional) The root element of the query or id of the root\r
- * @return {CompositeElementLite/CompositeElement}\r
- * @member Ext.Element\r
- * @method select\r
- */\r
-Ext.Element.select = function(selector, unique, root){\r
-    var els;\r
-    if(typeof selector == "string"){\r
-        els = Ext.Element.selectorFunction(selector, root);\r
-    }else if(selector.length !== undefined){\r
-        els = selector;\r
-    }else{\r
-        throw "Invalid selector";\r
-    }\r
-\r
-    return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);\r
-};\r
-\r
-<div id="method-Ext.Element-select"></div>/**\r
- * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods\r
- * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or\r
- * {@link Ext.CompositeElementLite CompositeElementLite} object.\r
- * @param {String/Array} selector The CSS selector or an array of elements\r
- * @param {Boolean} unique (optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object)\r
- * @param {HTMLElement/String} root (optional) The root element of the query or id of the root\r
- * @return {CompositeElementLite/CompositeElement}\r
- * @member Ext.Element\r
- * @method select\r
- */\r
-Ext.select = Ext.Element.select;</pre>
+<div id="cls-Ext.CompositeElement"></div>/**
+ * @class Ext.CompositeElement
+ * @extends Ext.CompositeElementLite
+ * <p>This class encapsulates a <i>collection</i> of DOM elements, providing methods to filter
+ * members, or to perform collective actions upon the whole set.</p>
+ * <p>Although they are not listed, this class supports all of the methods of {@link Ext.Element} and
+ * {@link Ext.Fx}. The methods from these classes will be performed on all the elements in this collection.</p>
+ * <p>All methods return <i>this</i> and can be chained.</p>
+ * Usage:
+<pre><code>
+var els = Ext.select("#some-el div.some-class", true);
+// or select directly from an existing element
+var el = Ext.get('some-el');
+el.select('div.some-class', true);
+
+els.setWidth(100); // all elements become 100 width
+els.hide(true); // all elements fade out and hide
+// or
+els.setWidth(100).hide(true);
+</code></pre>
+ */
+Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, {
+    
+    constructor : function(els, root){
+        this.elements = [];
+        this.add(els, root);
+    },
+    
+    // private
+    getElement : function(el){
+        // In this case just return it, since we already have a reference to it
+        return el;
+    },
+    
+    // private
+    transformElement : function(el){
+        return Ext.get(el);
+    }
+
+    /**
+    * Adds elements to this composite.
+    * @param {String/Array} els A string CSS selector, an array of elements or an element
+    * @return {CompositeElement} this
+    */
+
+    /**
+     * Returns the Element object at the specified index
+     * @param {Number} index
+     * @return {Ext.Element}
+     */
+
+    <div id="method-Ext.CompositeElement-"></div>/**
+     * Iterates each <code>element</code> in this <code>composite</code>
+     * calling the supplied function using {@link Ext#each}.
+     * @param {Function} fn The function to be called with each
+     * <code>element</code>. If the supplied function returns <tt>false</tt>,
+     * iteration stops. This function is called with the following arguments:
+     * <div class="mdetail-params"><ul>
+     * <li><code>element</code> : <i>Ext.Element</i><div class="sub-desc">The element at the current <code>index</code>
+     * in the <code>composite</code></div></li>
+     * <li><code>composite</code> : <i>Object</i> <div class="sub-desc">This composite.</div></li>
+     * <li><code>index</code> : <i>Number</i> <div class="sub-desc">The current index within the <code>composite</code> </div></li>
+     * </ul></div>
+     * @param {Object} scope (optional) The scope (<code><this</code> reference) in which the specified function is executed.
+     * Defaults to the <code>element</code> at the current <code>index</code>
+     * within the composite.
+     * @return {CompositeElement} this
+     */
+});
+
+<div id="method-Ext.Element-select"></div>/**
+ * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
+ * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
+ * {@link Ext.CompositeElementLite CompositeElementLite} object.
+ * @param {String/Array} selector The CSS selector or an array of elements
+ * @param {Boolean} unique (optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object)
+ * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
+ * @return {CompositeElementLite/CompositeElement}
+ * @member Ext.Element
+ * @method select
+ */
+Ext.Element.select = function(selector, unique, root){
+    var els;
+    if(typeof selector == "string"){
+        els = Ext.Element.selectorFunction(selector, root);
+    }else if(selector.length !== undefined){
+        els = selector;
+    }else{
+        throw "Invalid selector";
+    }
+
+    return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);
+};
+
+<div id="method-Ext-select"></div>/**
+ * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
+ * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
+ * {@link Ext.CompositeElementLite CompositeElementLite} object.
+ * @param {String/Array} selector The CSS selector or an array of elements
+ * @param {Boolean} unique (optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object)
+ * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
+ * @return {CompositeElementLite/CompositeElement}
+ * @member Ext
+ * @method select
+ */
+Ext.select = Ext.Element.select;</pre>    
 </body>
 </html>
\ No newline at end of file