Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / CompositeElement.html
diff --git a/docs/source/CompositeElement.html b/docs/source/CompositeElement.html
new file mode 100644 (file)
index 0000000..2d26e9c
--- /dev/null
@@ -0,0 +1,139 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><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
+    * Calls the passed function passing (el, this, index) for each element in this composite.\r
+    * @param {Function} fn The function to call\r
+    * @param {Object} scope (optional) The <i>this</i> object (defaults to the element)\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
+<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>    \r
+</body>\r
+</html>
\ No newline at end of file