Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / src / core / DomHelper-more.js
1 /*!
2  * Ext JS Library 3.1.0
3  * Copyright(c) 2006-2009 Ext JS, LLC
4  * licensing@extjs.com
5  * http://www.extjs.com/license
6  */
7 /**\r
8  * @class Ext.DomHelper\r
9  */\r
10 Ext.apply(Ext.DomHelper,\r
11 function(){\r
12         var pub,\r
13                 afterbegin = 'afterbegin',\r
14         afterend = 'afterend',\r
15         beforebegin = 'beforebegin',\r
16         beforeend = 'beforeend';\r
17 \r
18         // private\r
19     function doInsert(el, o, returnElement, pos, sibling, append){\r
20         el = Ext.getDom(el);\r
21         var newNode;\r
22         if (pub.useDom) {\r
23             newNode = createDom(o, null);\r
24             if (append) {\r
25                     el.appendChild(newNode);\r
26             } else {\r
27                         (sibling == 'firstChild' ? el : el.parentNode).insertBefore(newNode, el[sibling] || el);\r
28             }\r
29         } else {\r
30             newNode = Ext.DomHelper.insertHtml(pos, el, Ext.DomHelper.createHtml(o));\r
31         }\r
32         return returnElement ? Ext.get(newNode, true) : newNode;\r
33     }\r
34 \r
35         // build as dom\r
36     /** @ignore */\r
37     function createDom(o, parentNode){\r
38         var el,\r
39                 doc = document,\r
40                 useSet,\r
41                 attr,\r
42                 val,\r
43                 cn;\r
44 \r
45         if (Ext.isArray(o)) {                       // Allow Arrays of siblings to be inserted\r
46             el = doc.createDocumentFragment(); // in one shot using a DocumentFragment\r
47                 Ext.each(o, function(v) {\r
48                 createDom(v, el);\r
49             });\r
50         } else if (Ext.isString(o)) {         // Allow a string as a child spec.\r
51             el = doc.createTextNode(o);\r
52         } else {\r
53             el = doc.createElement( o.tag || 'div' );\r
54             useSet = !!el.setAttribute; // In IE some elements don't have setAttribute\r
55             Ext.iterate(o, function(attr, val){\r
56                 if(!/tag|children|cn|html|style/.test(attr)){\r
57                         if(attr == 'cls'){\r
58                             el.className = val;\r
59                         }else{\r
60                         if(useSet){\r
61                             el.setAttribute(attr, val);\r
62                         }else{\r
63                             el[attr] = val;\r
64                         }\r
65                         }\r
66                 }\r
67             });\r
68             Ext.DomHelper.applyStyles(el, o.style);\r
69 \r
70             if ((cn = o.children || o.cn)) {\r
71                 createDom(cn, el);\r
72             } else if (o.html) {\r
73                 el.innerHTML = o.html;\r
74             }\r
75         }\r
76         if(parentNode){\r
77            parentNode.appendChild(el);\r
78         }\r
79         return el;\r
80     }\r
81 \r
82         pub = {\r
83                 /**\r
84              * Creates a new Ext.Template from the DOM object spec.\r
85              * @param {Object} o The DOM object spec (and children)\r
86              * @return {Ext.Template} The new template\r
87              */\r
88             createTemplate : function(o){\r
89                 var html = Ext.DomHelper.createHtml(o);\r
90                 return new Ext.Template(html);\r
91             },\r
92 \r
93                 /** True to force the use of DOM instead of html fragments @type Boolean */\r
94             useDom : false,\r
95 \r
96             /**\r
97              * Creates new DOM element(s) and inserts them before el.\r
98              * @param {Mixed} el The context element\r
99              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob\r
100              * @param {Boolean} returnElement (optional) true to return a Ext.Element\r
101              * @return {HTMLElement/Ext.Element} The new node\r
102          * @hide (repeat)\r
103              */\r
104             insertBefore : function(el, o, returnElement){\r
105                 return doInsert(el, o, returnElement, beforebegin);\r
106             },\r
107 \r
108             /**\r
109              * Creates new DOM element(s) and inserts them after el.\r
110              * @param {Mixed} el The context element\r
111              * @param {Object} o The DOM object spec (and children)\r
112              * @param {Boolean} returnElement (optional) true to return a Ext.Element\r
113              * @return {HTMLElement/Ext.Element} The new node\r
114          * @hide (repeat)\r
115              */\r
116             insertAfter : function(el, o, returnElement){\r
117                 return doInsert(el, o, returnElement, afterend, 'nextSibling');\r
118             },\r
119 \r
120             /**\r
121              * Creates new DOM element(s) and inserts them as the first child of el.\r
122              * @param {Mixed} el The context element\r
123              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob\r
124              * @param {Boolean} returnElement (optional) true to return a Ext.Element\r
125              * @return {HTMLElement/Ext.Element} The new node\r
126          * @hide (repeat)\r
127              */\r
128             insertFirst : function(el, o, returnElement){\r
129                 return doInsert(el, o, returnElement, afterbegin, 'firstChild');\r
130             },\r
131 \r
132             /**\r
133              * Creates new DOM element(s) and appends them to el.\r
134              * @param {Mixed} el The context element\r
135              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob\r
136              * @param {Boolean} returnElement (optional) true to return a Ext.Element\r
137              * @return {HTMLElement/Ext.Element} The new node\r
138          * @hide (repeat)\r
139              */\r
140             append: function(el, o, returnElement){\r
141             return doInsert(el, o, returnElement, beforeend, '', true);\r
142         },\r
143 \r
144             /**\r
145              * Creates new DOM element(s) without inserting them to the document.\r
146              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob\r
147              * @return {HTMLElement} The new uninserted node\r
148              */\r
149         createDom: createDom\r
150         };\r
151         return pub;\r
152 }());