X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.Template.html diff --git a/docs/api/Ext.Template.html b/docs/api/Ext.Template.html new file mode 100644 index 00000000..42b866d5 --- /dev/null +++ b/docs/api/Ext.Template.html @@ -0,0 +1,158 @@ +Ext.Template | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

Represents an HTML fragment template. Templates may be 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("<div>Hello {0}.</div>");
      +t.append('some-element', ['foo']);
      +   
      +
    • Array :
    • +An Array will be combined with join(''). +
      var t = new Ext.Template([
      +    '<div name="{id}">',
      +        '<span class="{cls}">{name:trim} {value:ellipsis(10)}</span>',
      +    '</div>',
      +]);
      +t.compile();
      +t.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(
    +    '<div name="{id}">',
    +        '<span class="{cls}">{name} {value}</span>',
    +    '</div>',
    +    // a configuration object:
    +    {
    +        compiled: true,      // compile immediately
    +    }
    +);
    +   
    +

    Notes:

    +
      +
    • For a list of available format functions, see Ext.util.Format.
    • +
    • disableFormats reduces apply time +when no formatting is required.
    • +
    +
  • +
+ +
Defined By

Config Options

Other Configs

 
true to disable format functions in the template. If the template doesn't contain format functions, setting +disableFo...

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)

+
Defined By

Methods

 
append( +Mixed el, Object/Array values, [Boolean returnElement]) + : HTMLElement/Ext.core.Element
Applies the supplied values to the template and appends +the new node(s) to the specified el. + +For example usage see t...

Applies the supplied values to the template and appends +the new node(s) to the specified el.

+ +

For example usage see the constructor.

+ +

Parameters

  • el : Mixed

    The context element

    +
  • values : Object/Array

    The template values. Can be an array if the params are numeric (i.e. {0}) +or an object (i.e. {foo: 'bar'}).

    +
  • returnElement : Boolean

    (optional) true to return an Ext.core.Element (defaults to undefined)

    +

Returns

  • HTMLElement/Ext.core.Element   

    The new node or Element

    +
 
apply( +Object/Array values) + : String

Alias for applyTemplate +Returns an HTML fragment of this template with the specified values applied.

+

Alias for applyTemplate +Returns an HTML fragment of this template with the specified values applied.

+

Parameters

  • values : Object/Array

    The template values. Can be an array if the params are numeric (i.e. {0}) +or an object (i.e. {foo: 'bar'}).

    +

Returns

  • String   

    The HTML fragment

    +
 
from( +String/HTMLElement el, Object config) + : Ext.Template

Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.

+

Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.

+

Parameters

  • el : String/HTMLElement

    A DOM element or its id

    +
  • config : Object

    A configuration object

    +

Returns

  • Ext.Template   

    The created template

    +
 
insertAfter( +Mixed el, Object/Array values, [Boolean returnElement]) + : HTMLElement/Ext.core.Element

Applies the supplied values to the template and inserts the new node(s) after el.

+

Applies the supplied values to the template and inserts the new node(s) after el.

+

Parameters

  • el : Mixed

    The context element

    +
  • values : Object/Array

    The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})

    +
  • returnElement : Boolean

    (optional) true to return a Ext.core.Element (defaults to undefined)

    +

Returns

  • HTMLElement/Ext.core.Element   

    The new node or Element

    +
 
insertBefore( +Mixed el, Object/Array values, [Boolean returnElement]) + : HTMLElement/Ext.core.Element

Applies the supplied values to the template and inserts the new node(s) before el.

+

Applies the supplied values to the template and inserts the new node(s) before el.

+

Parameters

  • el : Mixed

    The context element

    +
  • values : Object/Array

    The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})

    +
  • returnElement : Boolean

    (optional) true to return a Ext.core.Element (defaults to undefined)

    +

Returns

  • HTMLElement/Ext.core.Element   

    The new node or Element

    +
 
insertFirst( +Mixed el, Object/Array values, [Boolean returnElement]) + : HTMLElement/Ext.core.Element

Applies the supplied values to the template and inserts the new node(s) as the first child of el.

+

Applies the supplied values to the template and inserts the new node(s) as the first child of el.

+

Parameters

  • el : Mixed

    The context element

    +
  • values : Object/Array

    The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})

    +
  • returnElement : Boolean

    (optional) true to return a Ext.core.Element (defaults to undefined)

    +

Returns

  • HTMLElement/Ext.core.Element   

    The new node or Element

    +
 
overwrite( +Mixed el, Object/Array values, [Boolean returnElement]) + : HTMLElement/Ext.core.Element

Applies the supplied values to the template and overwrites the content of el with the new node(s).

+

Applies the supplied values to the template and overwrites the content of el with the new node(s).

+

Parameters

  • el : Mixed

    The context element

    +
  • values : Object/Array

    The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})

    +
  • returnElement : Boolean

    (optional) true to return a Ext.core.Element (defaults to undefined)

    +

Returns

  • HTMLElement/Ext.core.Element   

    The new node or Element

    +
 
set( +String html, [Boolean compile]) + : Ext.Template

Sets the HTML used as the template and optionally compiles it.

+

Sets the HTML used as the template and optionally compiles it.

+

Parameters

  • html : String
    +
  • compile : Boolean

    (optional) True to compile the template (defaults to undefined)

    +

Returns

  • Ext.Template   

    this

    +
\ No newline at end of file