tvheadend/vendor/ext-3.4.1/docs/source/CompositeElement.html
Adam Sutton bafcfff42d webui: restructure webui/extjs source files
I want to keep the 3rd-party packages away from the main source
where possible.
2013-06-03 17:11:01 +01:00

129 lines
5.9 KiB
HTML

<!DOCTYPE html>
<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>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-CompositeElement'>/**
</span> * @class Ext.CompositeElement
* @extends Ext.CompositeElementLite
* &lt;p&gt;This class encapsulates a &lt;i&gt;collection&lt;/i&gt; of DOM elements, providing methods to filter
* members, or to perform collective actions upon the whole set.&lt;/p&gt;
* &lt;p&gt;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.&lt;/p&gt;
* &lt;p&gt;All methods return &lt;i&gt;this&lt;/i&gt; and can be chained.&lt;/p&gt;
* Usage:
&lt;pre&gt;&lt;code&gt;
var els = Ext.select(&quot;#some-el div.some-class&quot;, 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);
&lt;/code&gt;&lt;/pre&gt;
*/
Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, {
<span id='Ext-CompositeElement-method-constructor'> constructor : function(els, root){
</span> this.elements = [];
this.add(els, root);
},
<span id='Ext-CompositeElement-method-getElement'> // private
</span> getElement : function(el){
// In this case just return it, since we already have a reference to it
return el;
},
<span id='Ext-CompositeElement-method-transformElement'> // private
</span> transformElement : function(el){
return Ext.get(el);
}
<span id='global-method-'> /**
</span> * Adds elements to this composite.
* @param {String/Array} els A string CSS selector, an array of elements or an element
* @return {CompositeElement} this
* @ignore
*/
<span id='global-method-'> /**
</span> * Returns the Element object at the specified index
* @param {Number} index
* @return {Ext.Element}
* @ignore
*/
<span id='global-method-'> /**
</span> * Iterates each &lt;code&gt;element&lt;/code&gt; in this &lt;code&gt;composite&lt;/code&gt;
* calling the supplied function using {@link Ext#each}.
* @param {Function} fn The function to be called with each
* &lt;code&gt;element&lt;/code&gt;. If the supplied function returns &lt;tt&gt;false&lt;/tt&gt;,
* iteration stops. This function is called with the following arguments:
* &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
* &lt;li&gt;&lt;code&gt;element&lt;/code&gt; : &lt;i&gt;Ext.Element&lt;/i&gt;&lt;div class=&quot;sub-desc&quot;&gt;The element at the current &lt;code&gt;index&lt;/code&gt;
* in the &lt;code&gt;composite&lt;/code&gt;&lt;/div&gt;&lt;/li&gt;
* &lt;li&gt;&lt;code&gt;composite&lt;/code&gt; : &lt;i&gt;Object&lt;/i&gt; &lt;div class=&quot;sub-desc&quot;&gt;This composite.&lt;/div&gt;&lt;/li&gt;
* &lt;li&gt;&lt;code&gt;index&lt;/code&gt; : &lt;i&gt;Number&lt;/i&gt; &lt;div class=&quot;sub-desc&quot;&gt;The current index within the &lt;code&gt;composite&lt;/code&gt; &lt;/div&gt;&lt;/li&gt;
* &lt;/ul&gt;&lt;/div&gt;
* @param {Object} scope (optional) The scope (&lt;code&gt;&lt;this&lt;/code&gt; reference) in which the specified function is executed.
* Defaults to the &lt;code&gt;element&lt;/code&gt; at the current &lt;code&gt;index&lt;/code&gt;
* within the composite.
* @return {CompositeElement} this
* @ignore
*/
});
<span id='Ext-Element-static-method-select'>/**
</span> * 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
* @static
*/
Ext.Element.select = function(selector, unique, root){
var els;
if(typeof selector == &quot;string&quot;){
els = Ext.Element.selectorFunction(selector, root);
}else if(selector.length !== undefined){
els = selector;
}else{
throw &quot;Invalid selector&quot;;
}
return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);
};
<span id='Ext-method-select'>/**
</span> * 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>