src/ext-core/src/core/DomHelper.js

   1 /*!
   2  * Ext JS Library 3.3.1
   3  * Copyright(c) 2006-2010 Sencha Inc.
   4  * licensing@sencha.com
   5  * http://www.sencha.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         confRe = /tag|children|cn|html$/i,
 140         tableElRe = /td|tr|tbody/i,
 141         cssRe = /([a-z0-9-]+)\s*:\s*([^;\s]+(?:\s*[^;\s]+)*);?/gi,
 142         endRe = /end/i,
 143         pub,
 144         // kill repeat to save bytes
 145         afterbegin = 'afterbegin',
 146         afterend = 'afterend',
 147         beforebegin = 'beforebegin',
 148         beforeend = 'beforeend',
 149         ts = '<table>',
 150         te = '</table>',
 151         tbs = ts+'<tbody>',
 152         tbe = '</tbody>'+te,
 153         trs = tbs + '<tr>',
 154         tre = '</tr>'+tbe;
 155
 156     // private
 157     function doInsert(el, o, returnElement, pos, sibling, append){
 158         var newNode = pub.insertHtml(pos, Ext.getDom(el), createHtml(o));
 159         return returnElement ? Ext.get(newNode, true) : newNode;
 160     }
 161
 162     // build as innerHTML where available
 163     function createHtml(o){
 164         var b = '',
 165             attr,
 166             val,
 167             key,
 168             cn;
 169
 170         if(typeof o == "string"){
 171             b = o;
 172         } else if (Ext.isArray(o)) {
 173             for (var i=0; i < o.length; i++) {
 174                 if(o[i]) {
 175                     b += createHtml(o[i]);
 176                 }
 177             };
 178         } else {
 179             b += '<' + (o.tag = o.tag || 'div');
 180             for (attr in o) {
 181                 val = o[attr];
 182                 if(!confRe.test(attr)){
 183                     if (typeof val == "object") {
 184                         b += ' ' + attr + '="';
 185                         for (key in val) {
 186                             b += key + ':' + val[key] + ';';
 187                         };
 188                         b += '"';
 189                     }else{
 190                         b += ' ' + ({cls : 'class', htmlFor : 'for'}[attr] || attr) + '="' + val + '"';
 191                     }
 192                 }
 193             };
 194             // Now either just close the tag or try to add children and close the tag.
 195             if (emptyTags.test(o.tag)) {
 196                 b += '/>';
 197             } else {
 198                 b += '>';
 199                 if ((cn = o.children || o.cn)) {
 200                     b += createHtml(cn);
 201                 } else if(o.html){
 202                     b += o.html;
 203                 }
 204                 b += '</' + o.tag + '>';
 205             }
 206         }
 207         return b;
 208     }
 209
 210     function ieTable(depth, s, h, e){
 211         tempTableEl.innerHTML = [s, h, e].join('');
 212         var i = -1,
 213             el = tempTableEl,
 214             ns;
 215         while(++i < depth){
 216             el = el.firstChild;
 217         }
 218 //      If the result is multiple siblings, then encapsulate them into one fragment.
 219         if(ns = el.nextSibling){
 220             var df = document.createDocumentFragment();
 221             while(el){
 222                 ns = el.nextSibling;
 223                 df.appendChild(el);
 224                 el = ns;
 225             }
 226             el = df;
 227         }
 228         return el;
 229     }
 230
 231     /**
 232      * @ignore
 233      * Nasty code for IE's broken table implementation
 234      */
 235     function insertIntoTable(tag, where, el, html) {
 236         var node,
 237             before;
 238
 239         tempTableEl = tempTableEl || document.createElement('div');
 240
 241         if(tag == 'td' && (where == afterbegin || where == beforeend) ||
 242            !tableElRe.test(tag) && (where == beforebegin || where == afterend)) {
 243             return;
 244         }
 245         before = where == beforebegin ? el :
 246                  where == afterend ? el.nextSibling :
 247                  where == afterbegin ? el.firstChild : null;
 248
 249         if (where == beforebegin || where == afterend) {
 250             el = el.parentNode;
 251         }
 252
 253         if (tag == 'td' || (tag == 'tr' && (where == beforeend || where == afterbegin))) {
 254             node = ieTable(4, trs, html, tre);
 255         } else if ((tag == 'tbody' && (where == beforeend || where == afterbegin)) ||
 256                    (tag == 'tr' && (where == beforebegin || where == afterend))) {
 257             node = ieTable(3, tbs, html, tbe);
 258         } else {
 259             node = ieTable(2, ts, html, te);
 260         }
 261         el.insertBefore(node, before);
 262         return node;
 263     }
 264
 265
 266     pub = {
 267         /**
 268          * Returns the markup for the passed Element(s) config.
 269          * @param {Object} o The DOM object spec (and children)
 270          * @return {String}
 271          */
 272         markup : function(o){
 273             return createHtml(o);
 274         },
 275
 276         /**
 277          * Applies a style specification to an element.
 278          * @param {String/HTMLElement} el The element to apply styles to
 279          * @param {String/Object/Function} styles A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or
 280          * a function which returns such a specification.
 281          */
 282         applyStyles : function(el, styles){
 283             if (styles) {
 284                 var matches;
 285
 286                 el = Ext.fly(el);
 287                 if (typeof styles == "function") {
 288                     styles = styles.call();
 289                 }
 290                 if (typeof styles == "string") {
 291                     /**
 292                      * Since we're using the g flag on the regex, we need to set the lastIndex.
 293                      * This automatically happens on some implementations, but not others, see:
 294                      * http://stackoverflow.com/questions/2645273/javascript-regular-expression-literal-persists-between-function-calls
 295                      * http://blog.stevenlevithan.com/archives/fixing-javascript-regexp
 296                      */
 297                     cssRe.lastIndex = 0;
 298                     while ((matches = cssRe.exec(styles))) {
 299                         el.setStyle(matches[1], matches[2]);
 300                     }
 301                 } else if (typeof styles == "object") {
 302                     el.setStyle(styles);
 303                 }
 304             }
 305         },
 306
 307         /**
 308          * Inserts an HTML fragment into the DOM.
 309          * @param {String} where Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.
 310          * @param {HTMLElement} el The context element
 311          * @param {String} html The HTML fragment
 312          * @return {HTMLElement} The new node
 313          */
 314         insertHtml : function(where, el, html){
 315             var hash = {},
 316                 hashVal,
 317                 setStart,
 318                 range,
 319                 frag,
 320                 rangeEl,
 321                 rs;
 322
 323             where = where.toLowerCase();
 324             // add these here because they are used in both branches of the condition.
 325             hash[beforebegin] = ['BeforeBegin', 'previousSibling'];
 326             hash[afterend] = ['AfterEnd', 'nextSibling'];
 327
 328             if (el.insertAdjacentHTML) {
 329                 if(tableRe.test(el.tagName) && (rs = insertIntoTable(el.tagName.toLowerCase(), where, el, html))){
 330                     return rs;
 331                 }
 332                 // add these two to the hash.
 333                 hash[afterbegin] = ['AfterBegin', 'firstChild'];
 334                 hash[beforeend] = ['BeforeEnd', 'lastChild'];
 335                 if ((hashVal = hash[where])) {
 336                     el.insertAdjacentHTML(hashVal[0], html);
 337                     return el[hashVal[1]];
 338                 }
 339             } else {
 340                 range = el.ownerDocument.createRange();
 341                 setStart = 'setStart' + (endRe.test(where) ? 'After' : 'Before');
 342                 if (hash[where]) {
 343                     range[setStart](el);
 344                     frag = range.createContextualFragment(html);
 345                     el.parentNode.insertBefore(frag, where == beforebegin ? el : el.nextSibling);
 346                     return el[(where == beforebegin ? 'previous' : 'next') + 'Sibling'];
 347                 } else {
 348                     rangeEl = (where == afterbegin ? 'first' : 'last') + 'Child';
 349                     if (el.firstChild) {
 350                         range[setStart](el[rangeEl]);
 351                         frag = range.createContextualFragment(html);
 352                         if(where == afterbegin){
 353                             el.insertBefore(frag, el.firstChild);
 354                         }else{
 355                             el.appendChild(frag);
 356                         }
 357                     } else {
 358                         el.innerHTML = html;
 359                     }
 360                     return el[rangeEl];
 361                 }
 362             }
 363             throw 'Illegal insertion point -> "' + where + '"';
 364         },
 365
 366         /**
 367          * Creates new DOM element(s) and inserts them before el.
 368          * @param {Mixed} el The context element
 369          * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 370          * @param {Boolean} returnElement (optional) true to return a Ext.Element
 371          * @return {HTMLElement/Ext.Element} The new node
 372          */
 373         insertBefore : function(el, o, returnElement){
 374             return doInsert(el, o, returnElement, beforebegin);
 375         },
 376
 377         /**
 378          * Creates new DOM element(s) and inserts them after el.
 379          * @param {Mixed} el The context element
 380          * @param {Object} o The DOM object spec (and children)
 381          * @param {Boolean} returnElement (optional) true to return a Ext.Element
 382          * @return {HTMLElement/Ext.Element} The new node
 383          */
 384         insertAfter : function(el, o, returnElement){
 385             return doInsert(el, o, returnElement, afterend, 'nextSibling');
 386         },
 387
 388         /**
 389          * Creates new DOM element(s) and inserts them as the first child of el.
 390          * @param {Mixed} el The context element
 391          * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 392          * @param {Boolean} returnElement (optional) true to return a Ext.Element
 393          * @return {HTMLElement/Ext.Element} The new node
 394          */
 395         insertFirst : function(el, o, returnElement){
 396             return doInsert(el, o, returnElement, afterbegin, 'firstChild');
 397         },
 398
 399         /**
 400          * Creates new DOM element(s) and appends them to el.
 401          * @param {Mixed} el The context element
 402          * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 403          * @param {Boolean} returnElement (optional) true to return a Ext.Element
 404          * @return {HTMLElement/Ext.Element} The new node
 405          */
 406         append : function(el, o, returnElement){
 407             return doInsert(el, o, returnElement, beforeend, '', true);
 408         },
 409
 410         /**
 411          * Creates new DOM element(s) and overwrites the contents of el with them.
 412          * @param {Mixed} el The context element
 413          * @param {Object/String} o The DOM object spec (and children) or raw HTML blob
 414          * @param {Boolean} returnElement (optional) true to return a Ext.Element
 415          * @return {HTMLElement/Ext.Element} The new node
 416          */
 417         overwrite : function(el, o, returnElement){
 418             el = Ext.getDom(el);
 419             el.innerHTML = createHtml(o);
 420             return returnElement ? Ext.get(el.firstChild) : el.firstChild;
 421         },
 422
 423         createHtml : createHtml
 424     };
 425     return pub;
 426 }();