Methods

Events

CompositeElementLite
  CompositeElement

Class CQ.Ext.CompositeElement

Package:	CQ.Ext
Class:	CompositeElement
Extends:	CQ.Ext.CompositeElementLite
Clientlib:	cq.widgets

This 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 CQ.Ext.Element and CQ.Ext.Fx. The methods from these classes will be performed on all the elements in this collection.

All methods return this and can be chained.

Usage:

var els = CQ.Ext.select("#some-el div.some-class", true);
// or select directly from an existing element
var el = CQ.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);

Public Properties

Property		Defined By
	elements : Array The Array of DOM elements which this CompositeElement encapsulates. Read-only. This will not usually be accessed in d... The Array of DOM elements which this CompositeElement encapsulates. Read-only. This will not usually 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 `CQ.Ext.override(CQ.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 (n = els[i].nextSibling; n; n = n.nextSibling) { r[++ri] = n; } } // Add all found siblings to this Composite return this.add(r); } });`	CompositeElementLite

Public Methods

Method		Defined By
	add( `Mixed els` ) : CompositeElement Adds elements to this Composite object. Adds elements to this Composite object. Parameters: `els` : Mixed Either an Array of DOM elements to add, or another Composite object who's elements should be added. Returns: `CompositeElement` This Composite object.	CompositeElementLite
	clear() : void Removes all elements. Removes all elements. Parameters: None. Returns: `void`	CompositeElementLite
	each( `Function fn`, [`Object scope`] ) : CompositeElement Calls the passed function for each element in this composite. Calls the passed function for each element in this composite. Parameters: `fn` : Function The function to call. The function is passed the following parameters: el : Element The current Element in the iteration. This is the flyweight (shared) CQ.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. `scope` : Object (optional) The scope (this reference) in which the function is executed. (defaults to the Element) Returns: `CompositeElement` this	CompositeElementLite
	fill( `Mixed els` ) : CompositeElement Clears this Composite and adds the elements passed. Clears this Composite and adds the elements passed. Parameters: `els` : Mixed Either an array of DOM elements, or another Composite from which to fill this Composite. Returns: `CompositeElement` this	CompositeElementLite
	filter( `String/Function selector` ) : CompositeElement Filters this composite to only elements that match the passed selector. Filters this composite to only elements that match the passed selector. Parameters: `selector` : String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments: `el` : CQ.Ext.Element The current DOM element. `index` : Number The current index within the collection. Returns: `CompositeElement` this	CompositeElementLite
	getCount() : Number Returns the number of elements in this Composite. Returns the number of elements in this Composite. Parameters: None. Returns: `Number`	CompositeElementLite
	indexOf( `Mixed el` ) : Number Find the index of the passed element within the composite collection. Find the index of the passed element within the composite collection. Parameters: `el` : Mixed The id of an element, or an CQ.Ext.Element, or an HtmlElement to find within the composite collection. Returns: `Number` Number The index of the passed CQ.Ext.Element in the composite collection, or -1 if not found.	CompositeElementLite
	item( `Number index` ) : CQ.Ext.Element 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 Parameters: `index` : Number Returns: `CQ.Ext.Element`	CompositeElementLite
	replaceElement( `Mixed el`, `Mixed replacement`, [`Boolean domReplace`] ) : CompositeElement Replaces the specified element with the passed element. Replaces the specified element with the passed element. Parameters: `el` : Mixed The id of an element, the Element itself, the index of the element in this composite to replace. `replacement` : Mixed The id of an element or the Element itself. `domReplace` : Boolean (Optional) True to remove and replace the element in the document too. Returns: `CompositeElement` this	CompositeElementLite

Public Events

This class has no public events.