Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / src / core / core / Element.insertion.js
diff --git a/src/core/core/Element.insertion.js b/src/core/core/Element.insertion.js
new file mode 100644 (file)
index 0000000..07757d8
--- /dev/null
@@ -0,0 +1,147 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**\r
+ * @class Ext.Element\r
+ */\r
+Ext.Element.addMethods(\r
+function() {\r
+       var GETDOM = Ext.getDom,\r
+               GET = Ext.get,\r
+               DH = Ext.DomHelper,\r
+        isEl = function(el){\r
+            return  (el.nodeType || el.dom || typeof el == 'string');  \r
+        };\r
+       \r
+       return {\r
+           /**\r
+            * Appends the passed element(s) to this element\r
+            * @param {String/HTMLElement/Array/Element/CompositeElement} el\r
+            * @return {Ext.Element} this\r
+            */\r
+           appendChild: function(el){        \r
+               return GET(el).appendTo(this);        \r
+           },\r
+       \r
+           /**\r
+            * Appends this element to the passed element\r
+            * @param {Mixed} el The new parent element\r
+            * @return {Ext.Element} this\r
+            */\r
+           appendTo: function(el){        \r
+               GETDOM(el).appendChild(this.dom);        \r
+               return this;\r
+           },\r
+       \r
+           /**\r
+            * Inserts this element before the passed element in the DOM\r
+            * @param {Mixed} el The element before which this element will be inserted\r
+            * @return {Ext.Element} this\r
+            */\r
+           insertBefore: function(el){                   \r
+               (el = GETDOM(el)).parentNode.insertBefore(this.dom, el);\r
+               return this;\r
+           },\r
+       \r
+           /**\r
+            * Inserts this element after the passed element in the DOM\r
+            * @param {Mixed} el The element to insert after\r
+            * @return {Ext.Element} this\r
+            */\r
+           insertAfter: function(el){\r
+               (el = GETDOM(el)).parentNode.insertBefore(this.dom, el.nextSibling);\r
+               return this;\r
+           },\r
+       \r
+           /**\r
+            * Inserts (or creates) an element (or DomHelper config) as the first child of this element\r
+            * @param {Mixed/Object} el The id or element to insert or a DomHelper config to create and insert\r
+            * @return {Ext.Element} The new child\r
+            */\r
+           insertFirst: function(el, returnDom){\r
+            el = el || {};\r
+            if(isEl(el)){ // element\r
+                el = GETDOM(el);\r
+                this.dom.insertBefore(el, this.dom.firstChild);\r
+                return !returnDom ? GET(el) : el;\r
+            }else{ // dh config\r
+                return this.createChild(el, this.dom.firstChild, returnDom);\r
+            }\r
+    },\r
+       \r
+           /**\r
+            * Replaces the passed element with this element\r
+            * @param {Mixed} el The element to replace\r
+            * @return {Ext.Element} this\r
+            */\r
+           replace: function(el){\r
+               el = GET(el);\r
+               this.insertBefore(el);\r
+               el.remove();\r
+               return this;\r
+           },\r
+       \r
+           /**\r
+            * Replaces this element with the passed element\r
+            * @param {Mixed/Object} el The new element or a DomHelper config of an element to create\r
+            * @return {Ext.Element} this\r
+            */\r
+           replaceWith: function(el){\r
+                   var me = this,\r
+                       Element = Ext.Element;\r
+            if(isEl(el)){\r
+                el = GETDOM(el);\r
+                me.dom.parentNode.insertBefore(el, me.dom);\r
+            }else{\r
+                el = DH.insertBefore(me.dom, el);\r
+            }\r
+               \r
+               delete Element.cache[me.id];\r
+               Ext.removeNode(me.dom);      \r
+               me.id = Ext.id(me.dom = el);\r
+               return Element.cache[me.id] = me;        \r
+           },\r
+           \r
+               /**\r
+                * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.\r
+                * @param {Object} config DomHelper element config object.  If no tag is specified (e.g., {tag:'input'}) then a div will be\r
+                * automatically generated with the specified attributes.\r
+                * @param {HTMLElement} insertBefore (optional) a child element of this element\r
+                * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element\r
+                * @return {Ext.Element} The new child element\r
+                */\r
+               createChild: function(config, insertBefore, returnDom){\r
+                   config = config || {tag:'div'};\r
+                   return insertBefore ? \r
+                          DH.insertBefore(insertBefore, config, returnDom !== true) :  \r
+                          DH[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config,  returnDom !== true);\r
+               },\r
+               \r
+               /**\r
+                * Creates and wraps this element with another element\r
+                * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div\r
+                * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Ext.Element\r
+                * @return {HTMLElement/Element} The newly created wrapper element\r
+                */\r
+               wrap: function(config, returnDom){        \r
+                   var newEl = DH.insertBefore(this.dom, config || {tag: "div"}, !returnDom);\r
+                   newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom);\r
+                   return newEl;\r
+               },\r
+               \r
+               /**\r
+                * Inserts an html fragment into this element\r
+                * @param {String} where Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd.\r
+                * @param {String} html The HTML fragment\r
+                * @param {Boolean} returnEl (optional) True to return an Ext.Element (defaults to false)\r
+                * @return {HTMLElement/Ext.Element} The inserted node (or nearest related if more than 1 inserted)\r
+                */\r
+               insertHtml : function(where, html, returnEl){\r
+                   var el = DH.insertHtml(where, this.dom, html);\r
+                   return returnEl ? Ext.get(el) : el;\r
+               }\r
+       }\r
+}());
\ No newline at end of file