X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/f5240829880f87e0cf581c6a296e436fdef0ef80..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/source/CompositeElementLite.html?ds=sidebyside diff --git a/docs/source/CompositeElementLite.html b/docs/source/CompositeElementLite.html index 5074a4f4..4e661bc6 100644 --- a/docs/source/CompositeElementLite.html +++ b/docs/source/CompositeElementLite.html @@ -1,25 +1,11 @@ - -
- -/*! - * Ext JS Library 3.3.0 - * Copyright(c) 2006-2010 Ext JS, Inc. - * licensing@extjs.com - * http://www.extjs.com/license - */ -/** - * @class Ext.CompositeElementLite - *\ No newline at end of fileThis class encapsulates a collection of DOM elements, providing methods to filter - * members, or to perform collective actions upon the whole set.
- *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.
- * Example:- - \ No newline at end of file +Ext.select = Ext.core.Element.select; +-var els = Ext.select("#some-el div.some-class"); +
+</code></pre> */ Ext.CompositeElementLite = function(els, root){ - /** - *Sencha Documentation Project /** + * @class 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.core.Element} and + * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection.</p> + * Example:<pre><code> +var els = Ext.select("#some-el div.some-class"); // or select directly from an existing element var el = Ext.get('some-el'); el.select('div.some-class'); @@ -28,23 +14,23 @@ els.setWidth(100); // all elements become 100 width els.hide(true); // all elements fade out and hide // or els.setWidth(100).hide(true); -
The Array of DOM elements which this CompositeElement encapsulates. Read-only.
- *This will not usually be accessed in developers' code, but developers wishing + /** + * <p>The Array of DOM elements which this CompositeElement encapsulates. Read-only.</p> + * <p>This will not <i>usually</i> be accessed in developers' code, but developers wishing * to augment the capabilities of the CompositeElementLite class may use it when adding - * methods to the class.
- *For example to add the
nextAll
method to the class to add all - * following siblings of selected elements, the code would be+});</pre></code> * @type Array * @property elements */ this.elements = []; this.add(els, root); - this.el = new Ext.Element.Flyweight(); + this.el = new Ext.core.Element.Flyweight(); }; Ext.CompositeElementLite.prototype = { @@ -79,15 +65,15 @@ Ext.CompositeElementLite.prototype = { return Ext.getDom(el); }, - /** - * Returns the number of elements in this Composite. + /** + * Returns the number of elements in this Composite. * @return Number */ getCount : function(){ return this.elements.length; }, - /** - * Adds elements to this Composite object. + /** + * Adds elements to this Composite object. * @param {Mixed} els Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @return {CompositeElement} This Composite object. */ @@ -97,15 +83,15 @@ Ext.CompositeElementLite.prototype = { if(!els){ return this; } - if(typeof els == "string"){ - els = Ext.Element.selectorFunction(els, root); + if(typeof els == "string"){ + els = Ext.core.Element.selectorFunction(els, root); }else if(els.isComposite){ els = els.elements; }else if(!Ext.isIterable(els)){ els = [els]; } - for(var i = 0, len = els.length; i < len; ++i){ + for(var i = 0, len = els.length; i < len; ++i){ elements.push(me.transformElement(els[i])); } return me; @@ -118,18 +104,18 @@ Ext.CompositeElementLite.prototype = { e, i; - for(i = 0; i < len; i++) { + for(i = 0; i < len; i++) { e = els[i]; if(e){ - Ext.Element.prototype[fn].apply(me.getElement(e), args); + Ext.core.Element.prototype[fn].apply(me.getElement(e), args); } } return me; }, - /** - * Returns a flyweight Element of the dom element object at the specified index + /** + * Returns a flyweight Element of the dom element object at the specified index * @param {Number} index - * @return {Ext.Element} + * @return {Ext.core.Element} */ item : function(index){ var me = this, @@ -148,7 +134,7 @@ Ext.CompositeElementLite.prototype = { len = els.length, i, e; - for(i = 0; i
+ * methods to the class.</p> + * <p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all + * following siblings of selected elements, the code would be</p><code><pre> Ext.override(Ext.CompositeElementLite, { nextAll: function() { var els = this.elements, i, l = els.length, n, r = [], ri = -1; // Loop through all elements in this Composite, accumulating // an Array of all siblings. - for (i = 0; i < l; i++) { + for (i = 0; i < l; i++) { for (n = els[i].nextSibling; n; n = n.nextSibling) { r[++ri] = n; } @@ -53,13 +39,13 @@ Ext.override(Ext.CompositeElementLite, { // Add all found siblings to this Composite return this.add(r); } -});/** - * Calls the passed function for each element in this composite.
- * @param {Function} fn The function to call. The function is passed the following parameters:- *
- * @param {Object} scope (optional) The scope (this reference) in which the function is executed. (defaults to the Element) + /** + * <p>Calls the passed function for each element in this composite.</p> + * @param {Function} fn The function to call. The function is passed the following parameters:<ul> + * <li><b>el</b> : Element<div class="sub-desc">The current Element in the iteration. + * <b>This is the flyweight (shared) Ext.core.Element instance, so if you require a + * a reference to the dom node, use el.dom.</b></div></li> + * <li><b>c</b> : Composite<div class="sub-desc">This Composite object.</div></li> + * <li><b>idx</b> : Number<div class="sub-desc">The zero-based index in the iteration.</div></li> + * </ul> + * @param {Object} scope (optional) The scope (<i>this</i> reference) in which the function is executed. (defaults to the Element) * @return {CompositeElement} this */ each : function(fn, scope){ @@ -174,7 +160,7 @@ Ext.CompositeElementLite.prototype = { len = els.length, i, e; - for(i = 0; i- el : Element
- *The current Element in the iteration. - * This is the flyweight (shared) Ext.Element instance, so if you require a - * a reference to the dom node, use el.dom.- c : Composite
- *This Composite object.- idx : Number
- *The zero-based index in the iteration./** - * Clears this Composite and adds the elements passed. + /** + * Clears this Composite and adds the elements passed. * @param {Mixed} els Either an array of DOM elements, or another Composite from which to fill this Composite. * @return {CompositeElement} this */ @@ -198,13 +184,13 @@ Ext.CompositeElementLite.prototype = { return me; }, - /** - * Filters this composite to only elements that match the passed selector. + /** + * Filters this composite to only elements that match the passed selector. * @param {String/Function} selector A string CSS selector or a comparison function. - * The comparison function will be called with the following arguments: - *
+ * The comparison function will be called with the following arguments:<ul> + * <li><code>el</code> : Ext.core.Element<div class="sub-desc">The current DOM element.</div></li> + * <li><code>index</code> : Number<div class="sub-desc">The current index within the collection.</div></li> + * </ul> * @return {CompositeElement} this */ filter : function(selector){ @@ -225,17 +211,17 @@ Ext.CompositeElementLite.prototype = { return me; }, - /** - * Find the index of the passed element within the composite collection. - * @param el {Mixed} The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. - * @return Number The index of the passed Ext.Element in the composite collection, or -1 if not found. + /** + * Find the index of the passed element within the composite collection. + * @param el {Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection. + * @return Number The index of the passed Ext.core.Element in the composite collection, or -1 if not found. */ indexOf : function(el){ - return this.elements.indexOf(this.transformElement(el)); + return Ext.Array.indexOf(this.elements, this.transformElement(el)); }, - /** - * Replaces the specified element with the passed element. + /** + * Replaces the specified element with the passed element. * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite * to replace. * @param {Mixed} replacement The id of an element or the Element itself. @@ -245,7 +231,7 @@ Ext.CompositeElementLite.prototype = { replaceElement : function(el, replacement, domReplace){ var index = !isNaN(el) ? el : this.indexOf(el), d; - if(index > -1){ + if(index > -1){ replacement = Ext.getDom(replacement); if(domReplace){ d = this.elements[index]; @@ -257,8 +243,8 @@ Ext.CompositeElementLite.prototype = { return this; }, - /** - * Removes all elements. + /** + * Removes all elements. */ clear : function(){ this.elements = []; @@ -267,15 +253,15 @@ Ext.CompositeElementLite.prototype = { Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addListener; -/** - * @private - * Copies all of the functions from Ext.Element's prototype onto CompositeElementLite's prototype. - * This is called twice - once immediately below, and once again after additional Ext.Element +/** + * @private + * Copies all of the functions from Ext.core.Element's prototype onto CompositeElementLite's prototype. + * This is called twice - once immediately below, and once again after additional Ext.core.Element * are added in Ext JS */ Ext.CompositeElementLite.importElementMethods = function() { var fnName, - ElProto = Ext.Element.prototype, + ElProto = Ext.core.Element.prototype, CelProto = Ext.CompositeElementLite.prototype; for (fnName in ElProto) { @@ -293,32 +279,40 @@ Ext.CompositeElementLite.importElementMethods = function() { Ext.CompositeElementLite.importElementMethods(); if(Ext.DomQuery){ - Ext.Element.selectorFunction = Ext.DomQuery.select; + Ext.core.Element.selectorFunction = Ext.DomQuery.select; } -/** - * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.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 {HTMLElement/String} root (optional) The root element of the query or id of the root * @return {CompositeElementLite/CompositeElement} - * @member Ext.Element + * @member Ext.core.Element * @method select */ -Ext.Element.select = function(selector, root){ +Ext.core.Element.select = function(selector, root){ var els; - if(typeof selector == "string"){ - els = Ext.Element.selectorFunction(selector, root); + if(typeof selector == "string"){ + els = Ext.core.Element.selectorFunction(selector, root); }else if(selector.length !== undefined){ els = selector; }else{ - throw "Invalid selector"; + //<debug> + Ext.Error.raise({ + sourceClass: "Ext.core.Element", + sourceMethod: "select", + selector: selector, + root: root, + msg: "Invalid selector specified: " + selector + }); + //</debug> } return new Ext.CompositeElementLite(els); }; -/** - * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods +/** + * Selects elements based on the passed CSS selector to enable {@link Ext.core.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 @@ -327,7 +321,5 @@ Ext.Element.select = function(selector, root){ * @member Ext * @method select */ -Ext.select = Ext.Element.select; -- - *
el
: Ext.ElementThe current DOM element.- - *
index
: NumberThe current index within the collection.