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="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../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.core.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 <span id='Ext-CompositeElement-property-'>    /**
  58 </span>    * Adds elements to this composite.
  59     * @param {String/Array} els A string CSS selector, an array of elements or an element
  60     * @return {CompositeElement} this
  61     */
  62
  63 <span id='Ext-CompositeElement-property-'>    /**
  64 </span>     * Returns the Element object at the specified index
  65      * @param {Number} index
  66      * @return {Ext.core.Element}
  67      */
  68
  69 <span id='Ext-CompositeElement-property-'>    /**
  70 </span>     * Iterates each `element` in this `composite` calling the supplied function using {@link Ext#each Ext.each}.
  71      * @param {Function} fn
  72
  73 The function to be called with each
  74 `element`. If the supplied function returns &lt;tt&gt;false&lt;/tt&gt;,
  75 iteration stops. This function is called with the following arguments:
  76
  77 - `element` : __Ext.core.Element++
  78     The element at the current `index` in the `composite`
  79
  80 - `composite` : __Object__
  81     This composite.
  82
  83 - `index` : __Number__
  84     The current index within the `composite`
  85
  86      * @param {Object} scope (optional) The scope (&lt;code&gt;this&lt;/code&gt; reference) in which the specified function is executed.
  87      * Defaults to the &lt;code&gt;element&lt;/code&gt; at the current &lt;code&gt;index&lt;/code&gt;
  88      * within the composite.
  89      * @return {CompositeElement} this
  90      * @markdown
  91      */
  92 });
  93
  94 <span id='Ext-core-Element-method-select'>/**
  95 </span> * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods
  96  * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
  97  * {@link Ext.CompositeElementLite CompositeElementLite} object.
  98  * @param {String/Array} selector The CSS selector or an array of elements
  99  * @param {Boolean} unique (optional) true to create a unique Ext.core.Element for each element (defaults to a shared flyweight object)
 100  * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
 101  * @return {CompositeElementLite/CompositeElement}
 102  * @member Ext.core.Element
 103  * @method select
 104  */
 105 Ext.core.Element.select = function(selector, unique, root){
 106     var els;
 107     if(typeof selector == &quot;string&quot;){
 108         els = Ext.core.Element.selectorFunction(selector, root);
 109     }else if(selector.length !== undefined){
 110         els = selector;
 111     }else{
 112         //&lt;debug&gt;
 113         Ext.Error.raise({
 114             sourceClass: &quot;Ext.core.Element&quot;,
 115             sourceMethod: &quot;select&quot;,
 116             selector: selector,
 117             unique: unique,
 118             root: root,
 119             msg: &quot;Invalid selector specified: &quot; + selector
 120         });
 121         //&lt;/debug&gt;
 122     }
 123     return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);
 124 };
 125
 126 <span id='Ext-method-select'>/**
 127 </span> * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods
 128  * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
 129  * {@link Ext.CompositeElementLite CompositeElementLite} object.
 130  * @param {String/Array} selector The CSS selector or an array of elements
 131  * @param {Boolean} unique (optional) true to create a unique Ext.core.Element for each element (defaults to a shared flyweight object)
 132  * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
 133  * @return {CompositeElementLite/CompositeElement}
 134  * @member Ext
 135  * @method select
 136  */
 137 Ext.select = Ext.core.Element.select;</pre>
 138 </body>
 139 </html>