src/core/core/DomHelper.js

   1 /*!
   2  * Ext JS Library 3.0.0
   3  * Copyright(c) 2006-2009 Ext JS, LLC
   4  * licensing@extjs.com
   5  * http://www.extjs.com/license
   6  */
   7 /**
   8  * @class Ext.DomHelper
   9  * <p>The DomHelper class provides a layer of abstraction from DOM and transparently supports creating
  10  * elements via DOM or using HTML fragments. It also has the ability to create HTML fragment templates
  11  * from your DOM building code.</p>
  12  *
  13  * <p><b><u>DomHelper element specification object</u></b></p>
  14  * <p>A specification object is used when creating elements. Attributes of this object
  15  * are assumed to be element attributes, except for 4 special attributes:
  16  * <div class="mdetail-params"><ul>
  17  * <li><b><tt>tag</tt></b> : <div class="sub-desc">The tag name of the element</div></li>
  18  * <li><b><tt>children</tt></b> : or <tt>cn</tt><div class="sub-desc">An array of the
  19  * same kind of element definition objects to be created and appended. These can be nested
  20  * as deep as you want.</div></li>
  21  * <li><b><tt>cls</tt></b> : <div class="sub-desc">The class attribute of the element.
  22  * This will end up being either the "class" attribute on a HTML fragment or className
  23  * for a DOM node, depending on whether DomHelper is using fragments or DOM.</div></li>
  24  * <li><b><tt>html</tt></b> : <div class="sub-desc">The innerHTML for the element</div></li>
  25  * </ul></div></p>
  26  *
  27  * <p><b><u>Insertion methods</u></b></p>
  28  * <p>Commonly used insertion methods:
  29  * <div class="mdetail-params"><ul>
  30  * <li><b><tt>{@link #append}</tt></b> : <div class="sub-desc"></div></li>
  31  * <li><b><tt>{@link #insertBefore}</tt></b> : <div class="sub-desc"></div></li>
  32  * <li><b><tt>{@link #insertAfter}</tt></b> : <div class="sub-desc"></div></li>
  33  * <li><b><tt>{@link #overwrite}</tt></b> : <div class="sub-desc"></div></li>
  34  * <li><b><tt>{@link #createTemplate}</tt></b> : <div class="sub-desc"></div></li>
  35  * <li><b><tt>{@link #insertHtml}</tt></b> : <div class="sub-desc"></div></li>
  36  * </ul></div></p>
  37  *
  38  * <p><b><u>Example</u></b></p>
  39  * <p>This is an example, where an unordered list with 3 children items is appended to an existing
  40  * element with id <tt>'my-div'</tt>:<br>
  41  <pre><code>
  42 var dh = Ext.DomHelper; // create shorthand alias
  43 // specification object
  44 var spec = {
  45     id: 'my-ul',
  46     tag: 'ul',
  47     cls: 'my-list',
  48     // append children after creating
  49     children: [     // may also specify 'cn' instead of 'children'
  50         {tag: 'li', id: 'item0', html: 'List Item 0'},
  51         {tag: 'li', id: 'item1', html: 'List Item 1'},
  52         {tag: 'li', id: 'item2', html: 'List Item 2'}
  53     ]
  54 };
  55 var list = dh.append(
  56     'my-div', // the context element 'my-div' can either be the id or the actual node
  57     spec      // the specification object
  58 );
  59  </code></pre></p>
  60  * <p>Element creation specification parameters in this class may also be passed as an Array of
  61  * specification objects. This can be used to insert multiple sibling nodes into an existing
  62  * container very efficiently. For example, to add more list items to the example above:<pre><code>
  63 dh.append('my-ul', [
  64     {tag: 'li', id: 'item3', html: 'List Item 3'},
  65     {tag: 'li', id: 'item4', html: 'List Item 4'}
  66 ]);
  67  * </code></pre></p>
  68  *
  69  * <p><b><u>Templating</u></b></p>
  70  * <p>The real power is in the built-in templating. Instead of creating or appending any elements,
  71  * <tt>{@link #createTemplate}</tt> returns a Template object which can be used over and over to
  72  * insert new elements. Revisiting the example above, we could utilize templating this time:
  73  * <pre><code>
  74 // create the node
  75 var list = dh.append('my-div', {tag: 'ul', cls: 'my-list'});
  76 // get template
  77 var tpl = dh.createTemplate({tag: 'li', id: 'item{0}', html: 'List Item {0}'});
  78
  79 for(var i = 0; i < 5, i++){
  80     tpl.append(list, [i]); // use template to append to the actual node
  81 }
  82  * </code></pre></p>
  83  * <p>An example using a template:<pre><code>
  84 var html = '<a id="{0}" href="{1}" class="nav">{2}</a>';
  85
  86 var tpl = new Ext.DomHelper.createTemplate(html);
  87 tpl.append('blog-roll', ['link1', 'http://www.jackslocum.com/', "Jack&#39;s Site"]);
  88 tpl.append('blog-roll', ['link2', 'http://www.dustindiaz.com/', "Dustin&#39;s Site"]);
  89  * </code></pre></p>
  90  *
  91  * <p>The same example using named parameters:<pre><code>
  92 var html = '<a id="{id}" href="{url}" class="nav">{text}</a>';
  93
  94 var tpl = new Ext.DomHelper.createTemplate(html);
  95 tpl.append('blog-roll', {
  96     id: 'link1',
  97     url: 'http://www.jackslocum.com/',
  98     text: "Jack&#39;s Site"
  99 });
 100 tpl.append('blog-roll', {
 101     id: 'link2',
 102     url: 'http://www.dustindiaz.com/',
 103     text: "Dustin&#39;s Site"
 104 });
 105  * </code></pre></p>
 106  *
 107  * <p><b><u>Compiling Templates</u></b></p>
 108  * <p>Templates are applied using regular expressions. The performance is great, but if
 109  * you are adding a bunch of DOM elements using the same template, you can increase
 110  * performance even further by {@link Ext.Template#compile "compiling"} the template.
 111  * The way "{@link Ext.Template#compile compile()}" works is the template is parsed and
 112  * broken up at the different variable points and a dynamic function is created and eval'ed.
 113  * The generated function performs string concatenation of these parts and the passed
 114  * variables instead of using regular expressions.
 115  * <pre><code>
 116 var html = '<a id="{id}" href="{url}" class="nav">{text}</a>';
 117
 118 var tpl = new Ext.DomHelper.createTemplate(html);
 119 tpl.compile();
 120
 121 //... use template like normal
 122  * </code></pre></p>
 123  *
 124  * <p><b><u>Performance Boost</u></b></p>
 125  * <p>DomHelper will transparently create HTML fragments when it can. Using HTML fragments instead
 126  * of DOM can significantly boost performance.</p>
 127  * <p>Element creation specification parameters may also be strings. If {@link #useDom} is <tt>false</tt>,
 128  * then the string is used as innerHTML. If {@link #useDom} is <tt>true</tt>, a string specification
 129  * results in the creation of a text node. Usage:</p>
 130  * <pre><code>
 131 Ext.DomHelper.useDom = true; // force it to use DOM; reduces performance
 132  * </code></pre>
 133  * @singleton
 134  */
 135 Ext.DomHelper = function(){
 136     var tempTableEl = null,
 137         emptyTags = /^(?:br|frame|hr|img|input|link|meta|range|spacer|wbr|area|param|col)$/i,
 138         tableRe = /^table|tbody|tr|td$/i,
 139         pub,
 140         // kill repeat to save bytes
 141         afterbegin = "afterbegin",
 142         afterend = "afterend",
 143         beforebegin = "beforebegin",
 144         beforeend = "beforeend",
 145         ts = '<table>',
 146         te = '</table>',
 147         tbs = ts+'<tbody>',
 148         tbe = '</tbody>'+te,
 149         trs = tbs + '<tr>',
 150         tre = '</tr>'+tbe;
 151
 152     // private
 153     function doInsert(el, o, returnElement, pos, sibling, append){
 154         var newNode = pub.insertHtml(pos, Ext.getDom(el), createHtml(o));
 155         return returnElement ? Ext.get(newNode, true) : newNode;
 156     }
 157
 158     // build as innerHTML where available
 159     function createHtml(o){
 160             var b = "",
 161                 attr,
 162                 val,
 163                 key,
 164                 keyVal,
 165                 cn;
 166
 167         if(typeof o == 'string'){
 168             b = o;
 169         } else if (Ext.isArray(o)) {
 170                 Ext.each(o, function(v) {
 171                 b += createHtml(v);
 172             });
 173         } else {
 174                 b += "<" + (o.tag = o.tag || "div");
 175             Ext.iterate(o, function(attr, val){
 176                 if(!/tag|children|cn|html$/i.test(attr)){
 177                     if (Ext.isObject(val)) {
 178                         b += " " + attr + "='";
 179                         Ext.iterate(val, function(key, keyVal){
 180                             b += key + ":" + keyVal + ";";
 181                         });
 182                         b += "'";
 183                     }else{
 184                         b += " " + ({cls : "class", htmlFor : "for"}[attr] || attr) + "='" + val + "'";
 185                     }
 186                 }
 187             });
 188                 // Now either just close the tag or try to add children and close the tag.
 189                 if (emptyTags.test(o.tag)) {
 190                     b += "/>";
 191                 } else {
 192                     b += ">";
 193                     if ((cn = o.children || o.cn)) {
 194                         b += createHtml(cn);
 195                     } else if(o.html){
 196                         b += o.html;
 197                     }
 198                     b += "</" + o.tag + ">";
 199                 }
 200         }
 201         return b;
 202     }
 203
 204     function ieTable(depth, s, h, e){
 205         tempTableEl.innerHTML = [s, h, e].join('');
 206         var i = -1,
 207                 el = tempTableEl;
 208         while(++i < depth){
 209             el = el.firstChild;
 210         }
 211         return el;
 212     }
 213
 214     /**
 215      * @ignore
 216      * Nasty code for IE's broken table implementation
 217      */
 218     function insertIntoTable(tag, where, el, html) {
 219             var node,
 220                 before;
 221
 222         tempTableEl = tempTableEl || document.createElement('div');
 223
 224             if(tag == 'td' && (where == afterbegin || where == beforeend) ||
 225                !/td|tr|tbody/i.test(tag) && (where == beforebegin || where == afterend)) {
 226             return;
 227         }
 228         before = where == beforebegin ? el :
 229                                  where == afterend ? el.nextSibling :
 230                                  where == afterbegin ? el.firstChild : null;
 231
 232         if (where == beforebegin || where == afterend) {
 233                 el = el.parentNode;
 234         }
 235
 236         if (tag == 'td' || (tag == "tr" && (where == beforeend || where == afterbegin))) {
 237                 node = ieTable(4, trs, html, tre);
 238         } else if ((tag == "tbody" && (where == beforeend || where == afterbegin)) ||
 239                            (tag == "tr" && (where == beforebegin || where == afterend))) {
 240                 node = ieTable(3, tbs, html, tbe);
 241         } else {
 242                 node = ieTable(2, ts, html, te);
 243         }
 244         el.insertBefore(node, before);
 245         return node;
 246     }
 247
 248
 249     pub = {
 250             /**
 251              * Returns the markup for the passed Element(s) config.
 252              * @param {Object} o The DOM object spec (and children)
 253              * @return {String}
 254              */
 255             markup : function(o){
 256                 return createHtml(o);
 257             },
 258
 259             /**
 260              * Inserts an HTML fragment into the DOM.
 261              * @param {String} where Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.
 262              * @param {HTMLElement} el The context element
 263              * @param {String} html The HTML fragmenet
 264              * @return {HTMLElement} The new node
 265              */
 266             insertHtml : function(where, el, html){
 267                 var hash = {},
 268                         hashVal,
 269                         setStart,
 270                         range,
 271                         frag,
 272                         rangeEl,
 273                         rs;
 274
 275                 where = where.toLowerCase();
 276                 // add these here because they are used in both branches of the condition.
 277                 hash[beforebegin] = ['BeforeBegin', 'previousSibling'];
 278                 hash[afterend] = ['AfterEnd', 'nextSibling'];
 279
 280                 if (el.insertAdjacentHTML) {
 281                     if(tableRe.test(el.tagName) && (rs = insertIntoTable(el.tagName.toLowerCase(), where, el, html))){
 282                         return rs;
 283                     }
 284                     // add these two to the hash.
 285                     hash[afterbegin] = ['AfterBegin', 'firstChild'];
 286                     hash[beforeend] = ['BeforeEnd', 'lastChild'];
 287                     if ((hashVal = hash[where])) {
 288                                 el.insertAdjacentHTML(hashVal[0], html);
 289                         return el[hashVal[1]];
 290                     }
 291                 } else {
 292                         range = el.ownerDocument.createRange();
 293                         setStart = "setStart" + (/end/i.test(where) ? "After" : "Before");
 294                         if (hash[where]) {
 295                                 range[setStart](el);
 296                                 frag = range.createContextualFragment(html);
 297                                 el.parentNode.insertBefore(frag, where == beforebegin ? el : el.nextSibling);
 298                                 return el[(where == beforebegin ? "previous" : "next") + "Sibling"];
 299                         } else {
 300                                 rangeEl = (where == afterbegin ? "first" : "last") + "Child";
 301                                 if (el.firstChild) {
 302                                         range[setStart](el[rangeEl]);
 303                                         frag = range.createContextualFragment(html);
 304                         if(where == afterbegin){
 305                             el.insertBefore(frag, el.firstChild);
 306                         }else{
 307                             el.appendChild(frag);
 308                         }
 309                                 } else {
 310                                     el.innerHTML = html;
 311                             }
 312                             return el[rangeEl];
 313                         }
 314                 }
 315                 throw 'Illegal insertion point -> "' + where + '"';
 316             },
 317
 318             /**
 319              * Creates new DOM element(s) and inserts them before el.
 320              * @param {Mixed} el The context element
 321              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 322              * @param {Boolean} returnElement (optional) true to return a Ext.Element
 323              * @return {HTMLElement/Ext.Element} The new node
 324              */
 325             insertBefore : function(el, o, returnElement){
 326                 return doInsert(el, o, returnElement, beforebegin);
 327             },
 328
 329             /**
 330              * Creates new DOM element(s) and inserts them after el.
 331              * @param {Mixed} el The context element
 332              * @param {Object} o The DOM object spec (and children)
 333              * @param {Boolean} returnElement (optional) true to return a Ext.Element
 334              * @return {HTMLElement/Ext.Element} The new node
 335              */
 336             insertAfter : function(el, o, returnElement){
 337                 return doInsert(el, o, returnElement, afterend, "nextSibling");
 338             },
 339
 340             /**
 341              * Creates new DOM element(s) and inserts them as the first child of el.
 342              * @param {Mixed} el The context element
 343              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 344              * @param {Boolean} returnElement (optional) true to return a Ext.Element
 345              * @return {HTMLElement/Ext.Element} The new node
 346              */
 347             insertFirst : function(el, o, returnElement){
 348                 return doInsert(el, o, returnElement, afterbegin, "firstChild");
 349             },
 350
 351             /**
 352              * Creates new DOM element(s) and appends them to el.
 353              * @param {Mixed} el The context element
 354              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 355              * @param {Boolean} returnElement (optional) true to return a Ext.Element
 356              * @return {HTMLElement/Ext.Element} The new node
 357              */
 358             append : function(el, o, returnElement){
 359                     return doInsert(el, o, returnElement, beforeend, "", true);
 360             },
 361
 362             /**
 363              * Creates new DOM element(s) and overwrites the contents of el with them.
 364              * @param {Mixed} el The context element
 365              * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 366              * @param {Boolean} returnElement (optional) true to return a Ext.Element
 367              * @return {HTMLElement/Ext.Element} The new node
 368              */
 369             overwrite : function(el, o, returnElement){
 370                 el = Ext.getDom(el);
 371                 el.innerHTML = createHtml(o);
 372                 return returnElement ? Ext.get(el.firstChild) : el.firstChild;
 373             },
 374
 375             createHtml : createHtml
 376     };
 377     return pub;
 378 }();