extjs 3.0.3

/*! * Ext JS Library 3.0.3 * Copyright(c) 2006-2009 Ext JS, LLC * licensing@extjs.com * http://www.extjs.com/license */ /** * @class Ext.DomHelper * <p>The DomHelper class provides a layer of abstraction from DOM and transparently supports creating * elements via DOM or using HTML fragments. It also has the ability to create HTML fragment templates * from your DOM building code.</p> * * <p><b><u>DomHelper element specification object</u></b></p> * <p>A specification object is used when creating elements. Attributes of this object * are assumed to be element attributes, except for 4 special attributes: * <div class="mdetail-params"><ul> * <li><b><tt>tag</tt></b> : <div class="sub-desc">The tag name of the element</div></li> * <li><b><tt>children</tt></b> : or <tt>cn</tt><div class="sub-desc">An array of the * same kind of element definition objects to be created and appended. These can be nested * as deep as you want.</div></li> * <li><b><tt>cls</tt></b> : <div class="sub-desc">The class attribute of the element. * This will end up being either the "class" attribute on a HTML fragment or className * for a DOM node, depending on whether DomHelper is using fragments or DOM.</div></li> * <li><b><tt>html</tt></b> : <div class="sub-desc">The innerHTML for the element</div></li> * </ul></div></p> * * <p><b><u>Insertion methods</u></b></p> * <p>Commonly used insertion methods: * <div class="mdetail-params"><ul> * <li><b><tt>{@link #append}</tt></b> : <div class="sub-desc"></div></li> * <li><b><tt>{@link #insertBefore}</tt></b> : <div class="sub-desc"></div></li> * <li><b><tt>{@link #insertAfter}</tt></b> : <div class="sub-desc"></div></li> * <li><b><tt>{@link #overwrite}</tt></b> : <div class="sub-desc"></div></li> * <li><b><tt>{@link #createTemplate}</tt></b> : <div class="sub-desc"></div></li> * <li><b><tt>{@link #insertHtml}</tt></b> : <div class="sub-desc"></div></li> * </ul></div></p> * * <p><b><u>Example</u></b></p> * <p>This is an example, where an unordered list with 3 children items is appended to an existing * element with id <tt>'my-div'</tt>:<br> <pre><code> var dh = Ext.DomHelper; // create shorthand alias // specification object var spec = { id: 'my-ul', tag: 'ul', cls: 'my-list', // append children after creating children: [ // may also specify 'cn' instead of 'children' {tag: 'li', id: 'item0', html: 'List Item 0'}, {tag: 'li', id: 'item1', html: 'List Item 1'}, {tag: 'li', id: 'item2', html: 'List Item 2'} ] }; var list = dh.append( 'my-div', // the context element 'my-div' can either be the id or the actual node spec // the specification object ); </code></pre></p> * <p>Element creation specification parameters in this class may also be passed as an Array of * specification objects. This can be used to insert multiple sibling nodes into an existing * container very efficiently. For example, to add more list items to the example above:<pre><code> dh.append('my-ul', [ {tag: 'li', id: 'item3', html: 'List Item 3'}, {tag: 'li', id: 'item4', html: 'List Item 4'} ]); * </code></pre></p> * * <p><b><u>Templating</u></b></p> * <p>The real power is in the built-in templating. Instead of creating or appending any elements, * <tt>{@link #createTemplate}</tt> returns a Template object which can be used over and over to * insert new elements. Revisiting the example above, we could utilize templating this time: * <pre><code> // create the node var list = dh.append('my-div', {tag: 'ul', cls: 'my-list'}); // get template var tpl = dh.createTemplate({tag: 'li', id: 'item{0}', html: 'List Item {0}'}); for(var i = 0; i < 5, i++){ tpl.append(list, [i]); // use template to append to the actual node } * </code></pre></p> * <p>An example using a template:<pre><code> var html = '<a id="{0}" href="{1}" class="nav">{2}</a>'; var tpl = new Ext.DomHelper.createTemplate(html); tpl.append('blog-roll', ['link1', 'http://www.jackslocum.com/', "Jack&#39;s Site"]); tpl.append('blog-roll', ['link2', 'http://www.dustindiaz.com/', "Dustin&#39;s Site"]); * </code></pre></p> * * <p>The same example using named parameters:<pre><code> var html = '<a id="{id}" href="{url}" class="nav">{text}</a>'; var tpl = new Ext.DomHelper.createTemplate(html); tpl.append('blog-roll', { id: 'link1', url: 'http://www.jackslocum.com/', text: "Jack&#39;s Site" }); tpl.append('blog-roll', { id: 'link2', url: 'http://www.dustindiaz.com/', text: "Dustin&#39;s Site" }); * </code></pre></p> * * <p><b><u>Compiling Templates</u></b></p> * <p>Templates are applied using regular expressions. The performance is great, but if * you are adding a bunch of DOM elements using the same template, you can increase * performance even further by {@link Ext.Template#compile "compiling"} the template. * The way "{@link Ext.Template#compile compile()}" works is the template is parsed and * broken up at the different variable points and a dynamic function is created and eval'ed. * The generated function performs string concatenation of these parts and the passed * variables instead of using regular expressions. * <pre><code> var html = '<a id="{id}" href="{url}" class="nav">{text}</a>'; var tpl = new Ext.DomHelper.createTemplate(html); tpl.compile(); //... use template like normal * </code></pre></p> * * <p><b><u>Performance Boost</u></b></p> * <p>DomHelper will transparently create HTML fragments when it can. Using HTML fragments instead * of DOM can significantly boost performance.</p> * <p>Element creation specification parameters may also be strings. If {@link #useDom} is <tt>false</tt>, * then the string is used as innerHTML. If {@link #useDom} is <tt>true</tt>, a string specification * results in the creation of a text node. Usage:</p> * <pre><code> Ext.DomHelper.useDom = true; // force it to use DOM; reduces performance * </code></pre> * @singleton */ Ext.DomHelper = function(){ var tempTableEl = null, emptyTags = /^(?:br|frame|hr|img|input|link|meta|range|spacer|wbr|area|param|col)$/i, tableRe = /^table|tbody|tr|td$/i, pub, // kill repeat to save bytes afterbegin = 'afterbegin', afterend = 'afterend', beforebegin = 'beforebegin', beforeend = 'beforeend', ts = '<table>', te = '</table>', tbs = ts+'<tbody>', tbe = '</tbody>'+te, trs = tbs + '<tr>', tre = '</tr>'+tbe; // private function doInsert(el, o, returnElement, pos, sibling, append){ var newNode = pub.insertHtml(pos, Ext.getDom(el), createHtml(o)); return returnElement ? Ext.get(newNode, true) : newNode; } // build as innerHTML where available function createHtml(o){ var b = '', attr, val, key, keyVal, cn; if(Ext.isString(o)){ b = o; } else if (Ext.isArray(o)) { Ext.each(o, function(v) { b += createHtml(v); }); } else { b += '<' + (o.tag = o.tag || 'div'); Ext.iterate(o, function(attr, val){ if(!/tag|children|cn|html$/i.test(attr)){ if (Ext.isObject(val)) { b += ' ' + attr + '="'; Ext.iterate(val, function(key, keyVal){ b += key + ':' + keyVal + ';'; }); b += '"'; }else{ b += ' ' + ({cls : 'class', htmlFor : 'for'}[attr] || attr) + '="' + val + '"'; } } }); // Now either just close the tag or try to add children and close the t