+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.DomHelper-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.DomHelper-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.DomHelper-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.DomHelper"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.DomHelper</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DomHelper.js" target="_blank">DomHelper.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">DomHelper</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- *
-Utility class for working with DOM and/or Templates. It transparently supports using HTML fragments or DOM.<br>
-This is an example, where an unordered list with 5 children items is appended to an existing element with id 'my-div':<br>\r
- <pre><code>var dh = Ext.DomHelper;
-<b>var</b> list = dh.append(<em>'my-div'</em>, {
- id: <em>'my-ul'</em>, tag: <em>'ul'</em>, cls: <em>'my-list'</em>, children: [
- {tag: <em>'li'</em>, id: <em>'item0'</em>, html: <em>'List Item 0'</em>},
- {tag: <em>'li'</em>, id: <em>'item1'</em>, html: <em>'List Item 1'</em>},
- {tag: <em>'li'</em>, id: <em>'item2'</em>, html: <em>'List Item 2'</em>},
- {tag: <em>'li'</em>, id: <em>'item3'</em>, html: <em>'List Item 3'</em>},
- {tag: <em>'li'</em>, id: <em>'item4'</em>, html: <em>'List Item 4'</em>}
- ]
-});</code></pre>
-<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(<em>'my-ul'</em>, [
- {tag: <em>'li'</em>, id: <em>'item5'</em>, html: <em>'List Item 5'</em>},
- {tag: <em>'li'</em>, id: <em>'item6'</em>, html: <em>'List Item 6'</em>} ]);</code></pre></p>
-<p>Element creation specification parameters may also be strings. If <a ext:cls="useDom" href="output/useDom.html">useDom</a> is false, then the string is used
-as innerHTML. If <a ext:cls="useDom" href="output/useDom.html">useDom</a> is true, a string specification results in the creation of a text node.</p>
-For more information and examples, see <a href="http://www.jackslocum.com/blog/2006/10/06/domhelper-create-elements-using-dom-html-fragments-or-templates/">the original blog post</a>.<br><br><i>This class is a singleton and cannot be created directly.</i> </div>
-
- <div class="hr"></div>
- <a id="Ext.DomHelper-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-useDom"></a>\r
- <b>useDom</b> : Boolean <div class="mdesc">\r
- True to force the use of DOM instead of html fragments </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- </table>
- <a id="Ext.DomHelper-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-append"></a>\r
- <b>append</b>( <code>Mixed el</code>, <code>Object/String o</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Creates new DOM element(s) and appends them to el.</div>\r
- <div class="long">\r
- Creates new DOM element(s) and appends them to el. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>o</code> : Object/String<div class="sub-desc">The DOM object spec (and children) or raw HTML blob</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-applyStyles"></a>\r
- <b>applyStyles</b>( <code>String/HTMLElement el</code>, <code>String/Object/Function styles</code> ) : void <div class="mdesc">\r
- <div class="short">Applies a style specification to an element.</div>\r
- <div class="long">\r
- Applies a style specification to an element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The element to apply styles to</div></li><li><code>styles</code> : String/Object/Function<div class="sub-desc">A style specification string eg "width:100px", or object in the form {width:"100px"}, or
-a function which returns such a specification.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-createTemplate"></a>\r
- <b>createTemplate</b>( <code>Object o</code> ) : Ext.Template <div class="mdesc">\r
- <div class="short">Creates a new Ext.Template from the DOM object spec.</div>\r
- <div class="long">\r
- Creates a new Ext.Template from the DOM object spec. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The DOM object spec (and children)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Template</code><div class="sub-desc">The new template</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-insertAfter"></a>\r
- <b>insertAfter</b>( <code>Mixed el</code>, <code>Object o</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Creates new DOM element(s) and inserts them after el.</div>\r
- <div class="long">\r
- Creates new DOM element(s) and inserts them after el. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>o</code> : Object<div class="sub-desc">The DOM object spec (and children)</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-insertBefore"></a>\r
- <b>insertBefore</b>( <code>Mixed el</code>, <code>Object/String o</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Creates new DOM element(s) and inserts them before el.</div>\r
- <div class="long">\r
- Creates new DOM element(s) and inserts them before el. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>o</code> : Object/String<div class="sub-desc">The DOM object spec (and children) or raw HTML blob</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-insertFirst"></a>\r
- <b>insertFirst</b>( <code>Mixed el</code>, <code>Object/String o</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Creates new DOM element(s) and inserts them as the first child of el.</div>\r
- <div class="long">\r
- Creates new DOM element(s) and inserts them as the first child of el. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>o</code> : Object/String<div class="sub-desc">The DOM object spec (and children) or raw HTML blob</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-insertHtml"></a>\r
- <b>insertHtml</b>( <code>String where</code>, <code>HTMLElement el</code>, <code>String html</code> ) : HTMLElement <div class="mdesc">\r
- <div class="short">Inserts an HTML fragment into the DOM.</div>\r
- <div class="long">\r
- Inserts an HTML fragment into the DOM. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>where</code> : String<div class="sub-desc">Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.</div></li><li><code>el</code> : HTMLElement<div class="sub-desc">The context element</div></li><li><code>html</code> : String<div class="sub-desc">The HTML fragmenet</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement</code><div class="sub-desc">The new node</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-markup"></a>\r
- <b>markup</b>( <code>Object o</code> ) : String <div class="mdesc">\r
- <div class="short">Returns the markup for the passed Element(s) config.</div>\r
- <div class="long">\r
- Returns the markup for the passed Element(s) config. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The DOM object spec (and children)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomHelper-overwrite"></a>\r
- <b>overwrite</b>( <code>Mixed el</code>, <code>Object/String o</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Creates new DOM element(s) and overwrites the contents of el with them.</div>\r
- <div class="long">\r
- Creates new DOM element(s) and overwrites the contents of el with them. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>o</code> : Object/String<div class="sub-desc">The DOM object spec (and children) or raw HTML blob</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomHelper</td>\r
- </tr>\r
- </table>
- <a id="Ext.DomHelper-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff