docs/source/DomHelper.html

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