Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Element.insertion.html
index a2913d2..2d40f96 100644 (file)
+<!DOCTYPE html>
 <html>
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <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>
+  <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();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.2
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-Element'>/**
+</span> * @class Ext.Element
  */
-/**
- * @class Ext.Element
- */
-Ext.Element.addMethods(
-function() {
-       var GETDOM = Ext.getDom,
-               GET = Ext.get,
-               DH = Ext.DomHelper;
-       
-       return {
-           <div id="method-Ext.Element-appendChild"></div>/**
-            * Appends the passed element(s) to this element
-            * @param {String/HTMLElement/Array/Element/CompositeElement} el
-            * @return {Ext.Element} this
-            */
-           appendChild: function(el){        
-               return GET(el).appendTo(this);        
-           },
-       
-           <div id="method-Ext.Element-appendTo"></div>/**
-            * Appends this element to the passed element
-            * @param {Mixed} el The new parent element
-            * @return {Ext.Element} this
-            */
-           appendTo: function(el){        
-               GETDOM(el).appendChild(this.dom);        
-               return this;
-           },
-       
-           <div id="method-Ext.Element-insertBefore"></div>/**
-            * Inserts this element before the passed element in the DOM
-            * @param {Mixed} el The element before which this element will be inserted
-            * @return {Ext.Element} this
-            */
-           insertBefore: function(el){                   
-               (el = GETDOM(el)).parentNode.insertBefore(this.dom, el);
-               return this;
-           },
-       
-           <div id="method-Ext.Element-insertAfter"></div>/**
-            * Inserts this element after the passed element in the DOM
-            * @param {Mixed} el The element to insert after
-            * @return {Ext.Element} this
-            */
-           insertAfter: function(el){
-               (el = GETDOM(el)).parentNode.insertBefore(this.dom, el.nextSibling);
-               return this;
-           },
-       
-           <div id="method-Ext.Element-insertFirst"></div>/**
-            * Inserts (or creates) an element (or DomHelper config) as the first child of this element
-            * @param {Mixed/Object} el The id or element to insert or a DomHelper config to create and insert
-            * @return {Ext.Element} The new child
-            */
-           insertFirst: function(el, returnDom){
-            el = el || {};
-            if(el.nodeType || el.dom || typeof el == 'string'){ // element
-                el = GETDOM(el);
-                this.dom.insertBefore(el, this.dom.firstChild);
-                return !returnDom ? GET(el) : el;
-            }else{ // dh config
-                return this.createChild(el, this.dom.firstChild, returnDom);
+Ext.Element.addMethods({
+<span id='Ext-Element-method-appendChild'>    /**
+</span>     * Appends the passed element(s) to this element
+     * @param {String/HTMLElement/Ext.Element} el
+     * The id of the node, a DOM Node or an existing Element.
+     * @return {Ext.Element} this
+     */
+    appendChild : function(el) {
+        return Ext.get(el).appendTo(this);
+    },
+
+<span id='Ext-Element-method-appendTo'>    /**
+</span>     * Appends this element to the passed element
+     * @param {String/HTMLElement/Ext.Element} el The new parent element.
+     * The id of the node, a DOM Node or an existing Element.
+     * @return {Ext.Element} this
+     */
+    appendTo : function(el) {
+        Ext.getDom(el).appendChild(this.dom);
+        return this;
+    },
+
+<span id='Ext-Element-method-insertBefore'>    /**
+</span>     * Inserts this element before the passed element in the DOM
+     * @param {String/HTMLElement/Ext.Element} el The element before which this element will be inserted.
+     * The id of the node, a DOM Node or an existing Element.
+     * @return {Ext.Element} this
+     */
+    insertBefore : function(el) {
+        el = Ext.getDom(el);
+        el.parentNode.insertBefore(this.dom, el);
+        return this;
+    },
+
+<span id='Ext-Element-method-insertAfter'>    /**
+</span>     * Inserts this element after the passed element in the DOM
+     * @param {String/HTMLElement/Ext.Element} el The element to insert after.
+     * The id of the node, a DOM Node or an existing Element.
+     * @return {Ext.Element} this
+     */
+    insertAfter : function(el) {
+        el = Ext.getDom(el);
+        el.parentNode.insertBefore(this.dom, el.nextSibling);
+        return this;
+    },
+
+<span id='Ext-Element-method-insertFirst'>    /**
+</span>     * Inserts (or creates) an element (or DomHelper config) as the first child of this element
+     * @param {String/HTMLElement/Ext.Element/Object} el The id or element to insert or a DomHelper config
+     * to create and insert
+     * @return {Ext.Element} The new child
+     */
+    insertFirst : function(el, returnDom) {
+        el = el || {};
+        if (el.nodeType || el.dom || typeof el == 'string') { // element
+            el = Ext.getDom(el);
+            this.dom.insertBefore(el, this.dom.firstChild);
+            return !returnDom ? Ext.get(el) : el;
+        }
+        else { // dh config
+            return this.createChild(el, this.dom.firstChild, returnDom);
+        }
+    },
+
+<span id='Ext-Element-method-insertSibling'>    /**
+</span>     * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
+     * @param {String/HTMLElement/Ext.Element/Object/Array} el The id, element to insert or a DomHelper config
+     * to create and insert *or* an array of any of those.
+     * @param {String} where (optional) 'before' or 'after' defaults to before
+     * @param {Boolean} returnDom (optional) True to return the .;ll;l,raw DOM element instead of Ext.Element
+     * @return {Ext.Element} The inserted Element. If an array is passed, the last inserted element is returned.
+     */
+    insertSibling: function(el, where, returnDom){
+        var me = this, rt,
+        isAfter = (where || 'before').toLowerCase() == 'after',
+        insertEl;
+
+        if(Ext.isArray(el)){
+            insertEl = me;
+            Ext.each(el, function(e) {
+                rt = Ext.fly(insertEl, '_internal').insertSibling(e, where, returnDom);
+                if(isAfter){
+                    insertEl = rt;
+                }
+            });
+            return rt;
+        }
+
+        el = el || {};
+
+        if(el.nodeType || el.dom){
+            rt = me.dom.parentNode.insertBefore(Ext.getDom(el), isAfter ? me.dom.nextSibling : me.dom);
+            if (!returnDom) {
+                rt = Ext.get(rt);
             }
-        },
-       
-           <div id="method-Ext.Element-replace"></div>/**
-            * Replaces the passed element with this element
-            * @param {Mixed} el The element to replace
-            * @return {Ext.Element} this
-            */
-           replace: function(el){
-               el = GET(el);
-               this.insertBefore(el);
-               el.remove();
-               return this;
-           },
-       
-           <div id="method-Ext.Element-replaceWith"></div>/**
-            * Replaces this element with the passed element
-            * @param {Mixed/Object} el The new element or a DomHelper config of an element to create
-            * @return {Ext.Element} this
-            */
-           replaceWith: function(el){
-                   var me = this;
-                
-            if(el.nodeType || el.dom || typeof el == 'string'){
-                el = GETDOM(el);
-                me.dom.parentNode.insertBefore(el, me.dom);
-            }else{
-                el = DH.insertBefore(me.dom, el);
+        }else{
+            if (isAfter &amp;&amp; !me.dom.nextSibling) {
+                rt = Ext.DomHelper.append(me.dom.parentNode, el, !returnDom);
+            } else {
+                rt = Ext.DomHelper[isAfter ? 'insertAfter' : 'insertBefore'](me.dom, el, !returnDom);
             }
-               
-               delete Ext.elCache[me.id];
-               Ext.removeNode(me.dom);      
-               me.id = Ext.id(me.dom = el);
-               Ext.Element.addToCache(me.isFlyweight ? new Ext.Element(me.dom) : me);     
-            return me;
-           },
-           
-               <div id="method-Ext.Element-createChild"></div>/**
-                * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
-                * @param {Object} config DomHelper element config object.  If no tag is specified (e.g., {tag:'input'}) then a div will be
-                * automatically generated with the specified attributes.
-                * @param {HTMLElement} insertBefore (optional) a child element of this element
-                * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element
-                * @return {Ext.Element} The new child element
-                */
-               createChild: function(config, insertBefore, returnDom){
-                   config = config || {tag:'div'};
-                   return insertBefore ? 
-                          DH.insertBefore(insertBefore, config, returnDom !== true) :  
-                          DH[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config,  returnDom !== true);
-               },
-               
-               <div id="method-Ext.Element-wrap"></div>/**
-                * Creates and wraps this element with another element
-                * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div
-                * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Ext.Element
-                * @return {HTMLElement/Element} The newly created wrapper element
-                */
-               wrap: function(config, returnDom){        
-                   var newEl = DH.insertBefore(this.dom, config || {tag: "div"}, !returnDom);
-                   newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom);
-                   return newEl;
-               },
-               
-               <div id="method-Ext.Element-insertHtml"></div>/**
-                * Inserts an html fragment into this element
-                * @param {String} where Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
-                * @param {String} html The HTML fragment
-                * @param {Boolean} returnEl (optional) True to return an Ext.Element (defaults to false)
-                * @return {HTMLElement/Ext.Element} The inserted node (or nearest related if more than 1 inserted)
-                */
-               insertHtml : function(where, html, returnEl){
-                   var el = DH.insertHtml(where, this.dom, html);
-                   return returnEl ? Ext.get(el) : el;
-               }
-       }
-}());</pre>    
+        }
+        return rt;
+    },
+
+<span id='Ext-Element-method-replace'>    /**
+</span>     * Replaces the passed element with this element
+     * @param {String/HTMLElement/Ext.Element} el The element to replace.
+     * The id of the node, a DOM Node or an existing Element.
+     * @return {Ext.Element} this
+     */
+    replace : function(el) {
+        el = Ext.get(el);
+        this.insertBefore(el);
+        el.remove();
+        return this;
+    },
+    
+<span id='Ext-Element-method-replaceWith'>    /**
+</span>     * Replaces this element with the passed element
+     * @param {String/HTMLElement/Ext.Element/Object} el The new element (id of the node, a DOM Node
+     * or an existing Element) or a DomHelper config of an element to create
+     * @return {Ext.Element} this
+     */
+    replaceWith: function(el){
+        var me = this;
+            
+        if(el.nodeType || el.dom || typeof el == 'string'){
+            el = Ext.get(el);
+            me.dom.parentNode.insertBefore(el, me.dom);
+        }else{
+            el = Ext.DomHelper.insertBefore(me.dom, el);
+        }
+        
+        delete Ext.cache[me.id];
+        Ext.removeNode(me.dom);      
+        me.id = Ext.id(me.dom = el);
+        Ext.Element.addToCache(me.isFlyweight ? new Ext.Element(me.dom) : me);     
+        return me;
+    },
+    
+<span id='Ext-Element-method-createChild'>    /**
+</span>     * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
+     * @param {Object} config DomHelper element config object.  If no tag is specified (e.g., {tag:'input'}) then a div will be
+     * automatically generated with the specified attributes.
+     * @param {HTMLElement} insertBefore (optional) a child element of this element
+     * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element
+     * @return {Ext.Element} The new child element
+     */
+    createChild : function(config, insertBefore, returnDom) {
+        config = config || {tag:'div'};
+        if (insertBefore) {
+            return Ext.DomHelper.insertBefore(insertBefore, config, returnDom !== true);
+        }
+        else {
+            return Ext.DomHelper[!this.dom.firstChild ? 'insertFirst' : 'append'](this.dom, config,  returnDom !== true);
+        }
+    },
+
+<span id='Ext-Element-method-wrap'>    /**
+</span>     * Creates and wraps this element with another element
+     * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div
+     * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Ext.Element
+     * @return {HTMLElement/Ext.Element} The newly created wrapper element
+     */
+    wrap : function(config, returnDom) {
+        var newEl = Ext.DomHelper.insertBefore(this.dom, config || {tag: &quot;div&quot;}, !returnDom),
+            d = newEl.dom || newEl;
+
+        d.appendChild(this.dom);
+        return newEl;
+    },
+
+<span id='Ext-Element-method-insertHtml'>    /**
+</span>     * Inserts an html fragment into this element
+     * @param {String} where Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
+     * See {@link Ext.DomHelper#insertHtml} for details.
+     * @param {String} html The HTML fragment
+     * @param {Boolean} returnEl (optional) True to return an Ext.Element (defaults to false)
+     * @return {HTMLElement/Ext.Element} The inserted node (or nearest related if more than 1 inserted)
+     */
+    insertHtml : function(where, html, returnEl) {
+        var el = Ext.DomHelper.insertHtml(where, this.dom, html);
+        return returnEl ? Ext.get(el) : el;
+    }
+});
+</pre>
 </body>
-</html>
\ No newline at end of file
+</html>