Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / source / Element.insertion.html
1 <html>
2 <head>
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
4   <title>The source code</title>
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 </head>
8 <body  onload="prettyPrint();">
9     <pre class="prettyprint lang-js">/*!
10  * Ext JS Library 3.2.0
11  * Copyright(c) 2006-2010 Ext JS, Inc.
12  * licensing@extjs.com
13  * http://www.extjs.com/license
14  */
15 /**
16  * @class Ext.Element
17  */
18 Ext.Element.addMethods(
19 function() {
20         var GETDOM = Ext.getDom,
21                 GET = Ext.get,
22                 DH = Ext.DomHelper;
23         
24         return {
25             <div id="method-Ext.Element-appendChild"></div>/**
26              * Appends the passed element(s) to this element
27              * @param {String/HTMLElement/Array/Element/CompositeElement} el
28              * @return {Ext.Element} this
29              */
30             appendChild: function(el){        
31                 return GET(el).appendTo(this);        
32             },
33         
34             <div id="method-Ext.Element-appendTo"></div>/**
35              * Appends this element to the passed element
36              * @param {Mixed} el The new parent element
37              * @return {Ext.Element} this
38              */
39             appendTo: function(el){        
40                 GETDOM(el).appendChild(this.dom);        
41                 return this;
42             },
43         
44             <div id="method-Ext.Element-insertBefore"></div>/**
45              * Inserts this element before the passed element in the DOM
46              * @param {Mixed} el The element before which this element will be inserted
47              * @return {Ext.Element} this
48              */
49             insertBefore: function(el){                   
50                 (el = GETDOM(el)).parentNode.insertBefore(this.dom, el);
51                 return this;
52             },
53         
54             <div id="method-Ext.Element-insertAfter"></div>/**
55              * Inserts this element after the passed element in the DOM
56              * @param {Mixed} el The element to insert after
57              * @return {Ext.Element} this
58              */
59             insertAfter: function(el){
60                 (el = GETDOM(el)).parentNode.insertBefore(this.dom, el.nextSibling);
61                 return this;
62             },
63         
64             <div id="method-Ext.Element-insertFirst"></div>/**
65              * Inserts (or creates) an element (or DomHelper config) as the first child of this element
66              * @param {Mixed/Object} el The id or element to insert or a DomHelper config to create and insert
67              * @return {Ext.Element} The new child
68              */
69             insertFirst: function(el, returnDom){
70             el = el || {};
71             if(el.nodeType || el.dom || typeof el == 'string'){ // element
72                 el = GETDOM(el);
73                 this.dom.insertBefore(el, this.dom.firstChild);
74                 return !returnDom ? GET(el) : el;
75             }else{ // dh config
76                 return this.createChild(el, this.dom.firstChild, returnDom);
77             }
78         },
79         
80             <div id="method-Ext.Element-replace"></div>/**
81              * Replaces the passed element with this element
82              * @param {Mixed} el The element to replace
83              * @return {Ext.Element} this
84              */
85             replace: function(el){
86                 el = GET(el);
87                 this.insertBefore(el);
88                 el.remove();
89                 return this;
90             },
91         
92             <div id="method-Ext.Element-replaceWith"></div>/**
93              * Replaces this element with the passed element
94              * @param {Mixed/Object} el The new element or a DomHelper config of an element to create
95              * @return {Ext.Element} this
96              */
97             replaceWith: function(el){
98                     var me = this;
99                 
100             if(el.nodeType || el.dom || typeof el == 'string'){
101                 el = GETDOM(el);
102                 me.dom.parentNode.insertBefore(el, me.dom);
103             }else{
104                 el = DH.insertBefore(me.dom, el);
105             }
106                 
107                 delete Ext.elCache[me.id];
108                 Ext.removeNode(me.dom);      
109                 me.id = Ext.id(me.dom = el);
110                 Ext.Element.addToCache(me.isFlyweight ? new Ext.Element(me.dom) : me);     
111             return me;
112             },
113             
114                 <div id="method-Ext.Element-createChild"></div>/**
115                  * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
116                  * @param {Object} config DomHelper element config object.  If no tag is specified (e.g., {tag:'input'}) then a div will be
117                  * automatically generated with the specified attributes.
118                  * @param {HTMLElement} insertBefore (optional) a child element of this element
119                  * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element
120                  * @return {Ext.Element} The new child element
121                  */
122                 createChild: function(config, insertBefore, returnDom){
123                     config = config || {tag:'div'};
124                     return insertBefore ? 
125                            DH.insertBefore(insertBefore, config, returnDom !== true) :  
126                            DH[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config,  returnDom !== true);
127                 },
128                 
129                 <div id="method-Ext.Element-wrap"></div>/**
130                  * Creates and wraps this element with another element
131                  * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div
132                  * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Ext.Element
133                  * @return {HTMLElement/Element} The newly created wrapper element
134                  */
135                 wrap: function(config, returnDom){        
136                     var newEl = DH.insertBefore(this.dom, config || {tag: "div"}, !returnDom);
137                     newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom);
138                     return newEl;
139                 },
140                 
141                 <div id="method-Ext.Element-insertHtml"></div>/**
142                  * Inserts an html fragment into this element
143                  * @param {String} where Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
144                  * @param {String} html The HTML fragment
145                  * @param {Boolean} returnEl (optional) True to return an Ext.Element (defaults to false)
146                  * @return {HTMLElement/Ext.Element} The inserted node (or nearest related if more than 1 inserted)
147                  */
148                 insertHtml : function(where, html, returnEl){
149                     var el = DH.insertHtml(where, this.dom, html);
150                     return returnEl ? Ext.get(el) : el;
151                 }
152         }
153 }());</pre>    
154 </body>
155 </html>