Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / src / core / src / dom / Element.insertion.js
diff --git a/src/core/src/dom/Element.insertion.js b/src/core/src/dom/Element.insertion.js
new file mode 100644 (file)
index 0000000..f419804
--- /dev/null
@@ -0,0 +1,180 @@
+/**
+ * @class Ext.core.Element
+ */
+Ext.core.Element.addMethods({
+    /**
+     * Appends the passed element(s) to this element
+     * @param {String/HTMLElement/Array/Element/CompositeElement} el
+     * @return {Ext.core.Element} this
+     */
+    appendChild : function(el) {
+        return Ext.get(el).appendTo(this);
+    },
+
+    /**
+     * Appends this element to the passed element
+     * @param {Mixed} el The new parent element
+     * @return {Ext.core.Element} this
+     */
+    appendTo : function(el) {
+        Ext.getDom(el).appendChild(this.dom);
+        return this;
+    },
+
+    /**
+     * Inserts this element before the passed element in the DOM
+     * @param {Mixed} el The element before which this element will be inserted
+     * @return {Ext.core.Element} this
+     */
+    insertBefore : function(el) {
+        el = Ext.getDom(el);
+        el.parentNode.insertBefore(this.dom, el);
+        return this;
+    },
+
+    /**
+     * Inserts this element after the passed element in the DOM
+     * @param {Mixed} el The element to insert after
+     * @return {Ext.core.Element} this
+     */
+    insertAfter : function(el) {
+        el = Ext.getDom(el);
+        el.parentNode.insertBefore(this.dom, el.nextSibling);
+        return this;
+    },
+
+    /**
+     * 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.core.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);
+        }
+    },
+
+    /**
+     * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
+     * @param {Mixed/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.core.Element
+     * @return {Ext.core.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);
+            }
+        }else{
+            if (isAfter && !me.dom.nextSibling) {
+                rt = Ext.core.DomHelper.append(me.dom.parentNode, el, !returnDom);
+            } else {
+                rt = Ext.core.DomHelper[isAfter ? 'insertAfter' : 'insertBefore'](me.dom, el, !returnDom);
+            }
+        }
+        return rt;
+    },
+
+    /**
+     * Replaces the passed element with this element
+     * @param {Mixed} el The element to replace
+     * @return {Ext.core.Element} this
+     */
+    replace : function(el) {
+        el = Ext.get(el);
+        this.insertBefore(el);
+        el.remove();
+        return this;
+    },
+    
+    /**
+     * 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.core.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.core.DomHelper.insertBefore(me.dom, el);
+        }
+        
+        delete Ext.cache[me.id];
+        Ext.removeNode(me.dom);      
+        me.id = Ext.id(me.dom = el);
+        Ext.core.Element.addToCache(me.isFlyweight ? new Ext.core.Element(me.dom) : me);     
+        return me;
+    },
+    
+    /**
+     * 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.core.Element} The new child element
+     */
+    createChild : function(config, insertBefore, returnDom) {
+        config = config || {tag:'div'};
+        if (insertBefore) {
+            return Ext.core.DomHelper.insertBefore(insertBefore, config, returnDom !== true);
+        }
+        else {
+            return Ext.core.DomHelper[!this.dom.firstChild ? 'insertFirst' : 'append'](this.dom, config,  returnDom !== true);
+        }
+    },
+
+    /**
+     * 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.core.Element
+     * @return {HTMLElement/Element} The newly created wrapper element
+     */
+    wrap : function(config, returnDom) {
+        var newEl = Ext.core.DomHelper.insertBefore(this.dom, config || {tag: "div"}, !returnDom),
+            d = newEl.dom || newEl;
+
+        d.appendChild(this.dom);
+        return newEl;
+    },
+
+    /**
+     * 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.core.Element (defaults to false)
+     * @return {HTMLElement/Ext.core.Element} The inserted node (or nearest related if more than 1 inserted)
+     */
+    insertHtml : function(where, html, returnEl) {
+        var el = Ext.core.DomHelper.insertHtml(where, this.dom, html);
+        return returnEl ? Ext.get(el) : el;
+    }
+});