git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Template2.html
diff --git a/docs/source/Template2.html b/docs/source/Template2.html
index e3d8a87..6074bd9 100644 (file)
--- a/docs/source/Template2.html
+++ b/docs/source/Template2.html
@@ -1,67 +1,80 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-Template'>/**
-</span> * @class Ext.Template
- * &lt;p&gt;Represents an HTML fragment template. Templates may be {@link #compile precompiled}
- * for greater performance.&lt;/p&gt;
- * An instance of this class may be created by passing to the constructor either
- * a single argument, or multiple arguments:
- * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
- * &lt;li&gt;&lt;b&gt;single argument&lt;/b&gt; : String/Array
- * &lt;div class=&quot;sub-desc&quot;&gt;
- * The single argument may be either a String or an Array:&lt;ul&gt;
- * &lt;li&gt;&lt;tt&gt;String&lt;/tt&gt; : &lt;/li&gt;&lt;pre&gt;&lt;code&gt;
-var t = new Ext.Template(&quot;&amp;lt;div&gt;Hello {0}.&amp;lt;/div&gt;&quot;);
-t.{@link #append}('some-element', ['foo']);
-   &lt;/code&gt;&lt;/pre&gt;
- * &lt;li&gt;&lt;tt&gt;Array&lt;/tt&gt; : &lt;/li&gt;
- * An Array will be combined with &lt;code&gt;join('')&lt;/code&gt;.
-&lt;pre&gt;&lt;code&gt;
-var t = new Ext.Template([
-    '&amp;lt;div name=&quot;{id}&quot;&amp;gt;',
-        '&amp;lt;span class=&quot;{cls}&quot;&amp;gt;{name:trim} {value:ellipsis(10)}&amp;lt;/span&amp;gt;',
-    '&amp;lt;/div&amp;gt;',
-]);
-t.{@link #compile}();
-t.{@link #append}('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});
-   &lt;/code&gt;&lt;/pre&gt;
- * &lt;/ul&gt;&lt;/div&gt;&lt;/li&gt;
- * &lt;li&gt;&lt;b&gt;multiple arguments&lt;/b&gt; : String, Object, Array, ...
- * &lt;div class=&quot;sub-desc&quot;&gt;
- * Multiple arguments will be combined with &lt;code&gt;join('')&lt;/code&gt;.
- * &lt;pre&gt;&lt;code&gt;
-var t = new Ext.Template(
-    '&amp;lt;div name=&quot;{id}&quot;&amp;gt;',
-        '&amp;lt;span class=&quot;{cls}&quot;&amp;gt;{name} {value}&amp;lt;/span&amp;gt;',
-    '&amp;lt;/div&amp;gt;',
-    // a configuration object:
-    {
-        compiled: true,      // {@link #compile} immediately
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
     }
     }
-);
-   &lt;/code&gt;&lt;/pre&gt;
- * &lt;p&gt;&lt;b&gt;Notes&lt;/b&gt;:&lt;/p&gt;
- * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
- * &lt;li&gt;For a list of available format functions, see {@link Ext.util.Format}.&lt;/li&gt;
- * &lt;li&gt;&lt;code&gt;disableFormats&lt;/code&gt; reduces &lt;code&gt;{@link #apply}&lt;/code&gt; time
- * when no formatting is required.&lt;/li&gt;
- * &lt;/ul&gt;&lt;/div&gt;
- * &lt;/div&gt;&lt;/li&gt;
- * &lt;/ul&gt;&lt;/div&gt;
- * @param {Mixed} config
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-Template'>/**
+</span> * Represents an HTML fragment template. Templates may be {@link #compile precompiled} for greater performance.
+ *
+ * An instance of this class may be created by passing to the constructor either a single argument, or multiple
+ * arguments:
+ *
+ * # Single argument: String/Array
+ *
+ * The single argument may be either a String or an Array:
+ *
+ * - String:
+ *
+ *       var t = new Ext.Template(&quot;&lt;div&gt;Hello {0}.&lt;/div&gt;&quot;);
+ *       t.{@link #append}('some-element', ['foo']);
+ *
+ * - Array:
+ *
+ *   An Array will be combined with `join('')`.
+ *
+ *       var t = new Ext.Template([
+ *           '&lt;div name=&quot;{id}&quot;&gt;',
+ *               '&lt;span class=&quot;{cls}&quot;&gt;{name:trim} {value:ellipsis(10)}&lt;/span&gt;',
+ *           '&lt;/div&gt;',
+ *       ]);
+ *       t.{@link #compile}();
+ *       t.{@link #append}('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});
+ *
+ * # Multiple arguments: String, Object, Array, ...
+ *
+ * Multiple arguments will be combined with `join('')`.
+ *
+ *     var t = new Ext.Template(
+ *         '&lt;div name=&quot;{id}&quot;&gt;',
+ *             '&lt;span class=&quot;{cls}&quot;&gt;{name} {value}&lt;/span&gt;',
+ *         '&lt;/div&gt;',
+ *         // a configuration object:
+ *         {
+ *             compiled: true,      // {@link #compile} immediately
+ *         }
+ *     );
+ *
+ * # Notes
+ *
+ * - For a list of available format functions, see {@link Ext.util.Format}.
+ * - `disableFormats` reduces `{@link #apply}` time when no formatting is required.
  */
  */
-
 Ext.define('Ext.Template', {
 
     /* Begin Definitions */
 
 Ext.define('Ext.Template', {
 
     /* Begin Definitions */
 
-    requires: ['Ext.core.DomHelper', 'Ext.util.Format'],
+    requires: ['Ext.DomHelper', 'Ext.util.Format'],
 
 
-    statics: {
-<span id='Ext-Template-method-from'>        /**
-</span>         * Creates a template from the passed element's value (&lt;i&gt;display:none&lt;/i&gt; textarea, preferred) or innerHTML.
+    inheritableStatics: {
+<span id='Ext-Template-static-method-from'>        /**
+</span>         * Creates a template from the passed element's value (_display:none_ textarea, preferred) or innerHTML.
          * @param {String/HTMLElement} el A DOM element or its id
          * @param {String/HTMLElement} el A DOM element or its id
-         * @param {Object} config A configuration object
+         * @param {Object} config (optional) Config object
          * @return {Ext.Template} The created template
          * @static
          * @return {Ext.Template} The created template
          * @static
+         * @inheritable
          */
         from: function(el, config) {
             el = Ext.getDom(el);
          */
         from: function(el, config) {
             el = Ext.getDom(el);
@@ -71,6 +84,13 @@ Ext.define('Ext.Template', {
 
     /* End Definitions */
 
 
     /* End Definitions */
 
+<span id='Ext-Template-method-constructor'>    /**
+</span>     * Creates new template.
+     * 
+     * @param {String...} html List of strings to be concatenated into template.
+     * Alternatively an array of strings can be given, but then no config object may be passed.
+     * @param {Object} config (optional) Config object
+     */
     constructor: function(html) {
         var me = this,
             args = arguments,
     constructor: function(html) {
         var me = this,
             args = arguments,
@@ -107,19 +127,37 @@ Ext.define('Ext.Template', {
             me.compile();
         }
     },
             me.compile();
         }
     },
+
     isTemplate: true,
     isTemplate: true,
+
+<span id='Ext-Template-cfg-compiled'>    /**
+</span>     * @cfg {Boolean} compiled
+     * True to immediately compile the template. Defaults to false.
+     */
+
 <span id='Ext-Template-cfg-disableFormats'>    /**
 <span id='Ext-Template-cfg-disableFormats'>    /**
-</span>     * @cfg {Boolean} disableFormats true to disable format functions in the template. If the template doesn't contain format functions, setting
-     * disableFormats to true will reduce apply time (defaults to false)
+</span>     * @cfg {Boolean} disableFormats
+     * True to disable format functions in the template. If the template doesn't contain
+     * format functions, setting disableFormats to true will reduce apply time. Defaults to false.
      */
     disableFormats: false,
 
     re: /\{([\w\-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
      */
     disableFormats: false,
 
     re: /\{([\w\-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
+
 <span id='Ext-Template-method-applyTemplate'>    /**
 </span>     * Returns an HTML fragment of this template with the specified values applied.
 <span id='Ext-Template-method-applyTemplate'>    /**
 </span>     * Returns an HTML fragment of this template with the specified values applied.
-     * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
+     *
+     * @param {Object/Array} values The template values. Can be an array if your params are numeric:
+     *
+     *     var tpl = new Ext.Template('Name: {0}, Age: {1}');
+     *     tpl.applyTemplate(['John', 25]);
+     *
+     * or an object:
+     *
+     *     var tpl = new Ext.Template('Name: {name}, Age: {age}');
+     *     tpl.applyTemplate({name: 'John', age: 25});
+     *
      * @return {String} The HTML fragment
      * @return {String} The HTML fragment
-     * @hide repeat doc
      */
     applyTemplate: function(values) {
         var me = this,
      */
     applyTemplate: function(values) {
         var me = this,
@@ -154,7 +192,7 @@ Ext.define('Ext.Template', {
 <span id='Ext-Template-method-set'>    /**
 </span>     * Sets the HTML used as the template and optionally compiles it.
      * @param {String} html
 <span id='Ext-Template-method-set'>    /**
 </span>     * Sets the HTML used as the template and optionally compiles it.
      * @param {String} html
-     * @param {Boolean} compile (optional) True to compile the template (defaults to undefined)
+     * @param {Boolean} compile (optional) True to compile the template.
      * @return {Ext.Template} this
      */
     set: function(html, compile) {
      * @return {Ext.Template} this
      */
     set: function(html, compile) {
@@ -167,10 +205,10 @@ Ext.define('Ext.Template', {
     compileARe: /\\/g,
     compileBRe: /(\r\n|\n)/g,
     compileCRe: /'/g,
     compileARe: /\\/g,
     compileBRe: /(\r\n|\n)/g,
     compileCRe: /'/g,
+
 <span id='Ext-Template-method-compile'>    /**
 </span>     * Compiles the template into an internal function, eliminating the RegEx overhead.
      * @return {Ext.Template} this
 <span id='Ext-Template-method-compile'>    /**
 </span>     * Compiles the template into an internal function, eliminating the RegEx overhead.
      * @return {Ext.Template} this
-     * @hide repeat doc
      */
     compile: function() {
         var me = this,
      */
     compile: function() {
         var me = this,
@@ -203,10 +241,11 @@ Ext.define('Ext.Template', {
 
 <span id='Ext-Template-method-insertFirst'>    /**
 </span>     * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 
 <span id='Ext-Template-method-insertFirst'>    /**
 </span>     * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
-     * @param {Mixed} el The context element
-     * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
-     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
-     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     *
+     * @param {String/HTMLElement/Ext.Element} el The context element
+     * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
+     * @param {Boolean} returnElement (optional) true to return a Ext.Element.
+     * @return {HTMLElement/Ext.Element} The new node or Element
      */
     insertFirst: function(el, values, returnElement) {
         return this.doInsert('afterBegin', el, values, returnElement);
      */
     insertFirst: function(el, values, returnElement) {
         return this.doInsert('afterBegin', el, values, returnElement);
@@ -214,10 +253,11 @@ Ext.define('Ext.Template', {
 
 <span id='Ext-Template-method-insertBefore'>    /**
 </span>     * Applies the supplied values to the template and inserts the new node(s) before el.
 
 <span id='Ext-Template-method-insertBefore'>    /**
 </span>     * Applies the supplied values to the template and inserts the new node(s) before el.
-     * @param {Mixed} el The context element
-     * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
-     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
-     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     *
+     * @param {String/HTMLElement/Ext.Element} el The context element
+     * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
+     * @param {Boolean} returnElement (optional) true to return a Ext.Element.
+     * @return {HTMLElement/Ext.Element} The new node or Element
      */
     insertBefore: function(el, values, returnElement) {
         return this.doInsert('beforeBegin', el, values, returnElement);
      */
     insertBefore: function(el, values, returnElement) {
         return this.doInsert('beforeBegin', el, values, returnElement);
@@ -225,25 +265,25 @@ Ext.define('Ext.Template', {
 
 <span id='Ext-Template-method-insertAfter'>    /**
 </span>     * Applies the supplied values to the template and inserts the new node(s) after el.
 
 <span id='Ext-Template-method-insertAfter'>    /**
 </span>     * Applies the supplied values to the template and inserts the new node(s) after el.
-     * @param {Mixed} el The context element
-     * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
-     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
-     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     *
+     * @param {String/HTMLElement/Ext.Element} el The context element
+     * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
+     * @param {Boolean} returnElement (optional) true to return a Ext.Element.
+     * @return {HTMLElement/Ext.Element} The new node or Element
      */
     insertAfter: function(el, values, returnElement) {
         return this.doInsert('afterEnd', el, values, returnElement);
     },
 
 <span id='Ext-Template-method-append'>    /**
      */
     insertAfter: function(el, values, returnElement) {
         return this.doInsert('afterEnd', el, values, returnElement);
     },
 
 <span id='Ext-Template-method-append'>    /**
-</span>     * Applies the supplied &lt;code&gt;values&lt;/code&gt; to the template and appends
-     * the new node(s) to the specified &lt;code&gt;el&lt;/code&gt;.
-     * &lt;p&gt;For example usage {@link #Template see the constructor}.&lt;/p&gt;
-     * @param {Mixed} el The context element
-     * @param {Object/Array} values
-     * The template values. Can be an array if the params are numeric (i.e. &lt;code&gt;{0}&lt;/code&gt;)
-     * or an object (i.e. &lt;code&gt;{foo: 'bar'}&lt;/code&gt;).
-     * @param {Boolean} returnElement (optional) true to return an Ext.core.Element (defaults to undefined)
-     * @return {HTMLElement/Ext.core.Element} The new node or Element
+</span>     * Applies the supplied `values` to the template and appends the new node(s) to the specified `el`.
+     *
+     * For example usage see {@link Ext.Template Ext.Template class docs}.
+     *
+     * @param {String/HTMLElement/Ext.Element} el The context element
+     * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
+     * @param {Boolean} returnElement (optional) true to return an Ext.Element.
+     * @return {HTMLElement/Ext.Element} The new node or Element
      */
     append: function(el, values, returnElement) {
         return this.doInsert('beforeEnd', el, values, returnElement);
      */
     append: function(el, values, returnElement) {
         return this.doInsert('beforeEnd', el, values, returnElement);
@@ -251,16 +291,17 @@ Ext.define('Ext.Template', {
 
     doInsert: function(where, el, values, returnEl) {
         el = Ext.getDom(el);
 
     doInsert: function(where, el, values, returnEl) {
         el = Ext.getDom(el);
-        var newNode = Ext.core.DomHelper.insertHtml(where, el, this.applyTemplate(values));
+        var newNode = Ext.DomHelper.insertHtml(where, el, this.applyTemplate(values));
         return returnEl ? Ext.get(newNode, true) : newNode;
     },
 
 <span id='Ext-Template-method-overwrite'>    /**
 </span>     * Applies the supplied values to the template and overwrites the content of el with the new node(s).
         return returnEl ? Ext.get(newNode, true) : newNode;
     },
 
 <span id='Ext-Template-method-overwrite'>    /**
 </span>     * Applies the supplied values to the template and overwrites the content of el with the new node(s).
-     * @param {Mixed} el The context element
-     * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
-     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
-     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     *
+     * @param {String/HTMLElement/Ext.Element} el The context element
+     * @param {Object/Array} values The template values. See {@link #applyTemplate} for details.
+     * @param {Boolean} returnElement (optional) true to return a Ext.Element.
+     * @return {HTMLElement/Ext.Element} The new node or Element
      */
     overwrite: function(el, values, returnElement) {
         el = Ext.getDom(el);
      */
     overwrite: function(el, values, returnElement) {
         el = Ext.getDom(el);
@@ -270,15 +311,13 @@ Ext.define('Ext.Template', {
 }, function() {
 
 <span id='Ext-Template-method-apply'>    /**
 }, function() {
 
 <span id='Ext-Template-method-apply'>    /**
-</span>     * Alias for {@link #applyTemplate}
-     * Returns an HTML fragment of this template with the specified &lt;code&gt;values&lt;/code&gt; applied.
-     * @param {Object/Array} values
-     * The template values. Can be an array if the params are numeric (i.e. &lt;code&gt;{0}&lt;/code&gt;)
-     * or an object (i.e. &lt;code&gt;{foo: 'bar'}&lt;/code&gt;).
-     * @return {String} The HTML fragment
+</span>     * @method apply
      * @member Ext.Template
      * @member Ext.Template
-     * @method apply
+     * Alias for {@link #applyTemplate}.
+     * @alias Ext.Template#applyTemplate
      */
     this.createAlias('apply', 'applyTemplate');
 });
      */
     this.createAlias('apply', 'applyTemplate');
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.