Touch 2.0.2 Sencha Docs

Ext.Template

Hierarchy

Ext.Base
Ext.Template

Requires

Subclasses

Files

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.

Available since: 1.1.0

Defined By

Config options

True to immediately compile the template. ...

True to immediately compile the template. Defaults to false.

Available since: 2.0.0

True to disable format functions in the template. ...

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.

Defaults to: false

Available since: 1.1.0

Properties

Defined By

Instance Properties

Ext.Template
view source
: RegExpprivate
...

Defaults to: /\/g

Available since: 1.1.0

Ext.Template
view source
: RegExpprivate
...

Defaults to: /(\r\n|\n)/g

Available since: 1.1.0

Ext.Template
view source
: RegExpprivate
...

Defaults to: /'/g

Available since: 1.1.0

true in this class to identify an object as an instantiated Template, or subclass thereof. ...

true in this class to identify an object as an instantiated Template, or subclass thereof.

Defaults to: true

Available since: 1.1.0

Ext.Template
view source
: RegExpprivate
...

Defaults to: /\{([\w\-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g

Available since: 1.1.0

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); / dependentOL on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 2.0.0

Defined By

Static Properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance Methods

Ext.Template
view source
new( html, [config] ) : Ext.Template
Creates new template. ...

Creates new template.

Available since: 1.1.0

Parameters

  • html : String...

    List of strings to be concatenated into template. Alternatively an array of strings can be given, but then no config object may be passed.

  • config : Object (optional)

    Config object

Returns

Ext.Template
view source
( el, values, [returnElement] ) : HTMLElement/Ext.Element
Applies the supplied values to the template and appends the new node(s) to the specified el. ...

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

For example usage see Ext.Template class docs.

Available since: 1.1.0

Parameters

Returns

Ext.Template
view source
( values ) : String
Returns an HTML fragment of this template with the specified values applied. ...

Returns an HTML fragment of this template with the specified values applied.

Available since: 1.1.0

Parameters

  • values : Object/Array

    The template values. Can be an array if your params are numeric:

    var tpl = new Ext.Template('Name: {0}, Age: {1}');
    tpl.apply(['John', 25]);
    

    or an object:

    var tpl = new Ext.Template('Name: {name}, Age: {age}');
    tpl.apply({name: 'John', age: 25});
    

Returns

Ext.Template
view source
( values, out ) : Array
Appends the result of this template to the provided output array. ...

Appends the result of this template to the provided output array.

Available since: 2.0.0

Parameters

Returns

  • Array

    The given out array.

Ext.Template
view source
( values ) : String
Alias for apply. ...

Alias for apply.

Returns an HTML fragment of this template with the specified values applied.

Available since: 2.0.0

Parameters

  • values : Object/Array

    The template values. Can be an array if your params are numeric:

    var tpl = new Ext.Template('Name: {0}, Age: {1}');
    tpl.apply(['John', 25]);
    

    or an object:

    var tpl = new Ext.Template('Name: {name}, Age: {age}');
    tpl.apply({name: 'John', age: 25});
    

Returns

Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 2.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

  • Object

    Returns the result of calling the overridden method

Call the "parent" method of the current method. ...

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

Available since: 2.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result of calling the parent method

Ext.Template
view source
( ) : Ext.Templatechainable
Compiles the template into an internal function, eliminating the RegEx overhead. ...

Compiles the template into an internal function, eliminating the RegEx overhead.

Available since: 2.0.0

Returns

Ext.Template
view source
( where, el, values, returnElement )private
...

Available since: 1.1.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Returns the initial configuration passed to constructor. ...

Returns the initial configuration passed to constructor.

Available since: 2.0.0

Parameters

  • name : String (optional)

    When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

...

Available since: 2.0.0

Parameters

( instanceConfig ) : Objectchainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 2.0.0

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

Ext.Template
view source
( el, values, [returnElement] ) : HTMLElement/Ext.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.

Available since: 1.1.0

Parameters

Returns

Ext.Template
view source
( el, values, [returnElement] ) : HTMLElement/Ext.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.

Available since: 1.1.0

Parameters

Returns

Ext.Template
view source
( el, values, [returnElement] ) : HTMLElement/Ext.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.

Available since: 1.1.0

Parameters

Returns

( names, callback, scope )private
...

Available since: 2.0.0

Parameters

Ext.Template
view source
( el, values, [returnElement] ) : HTMLElement/Ext.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).

Available since: 1.1.0

Parameters

Returns

Ext.Template
view source
( html, [compile] ) : Ext.Templatechainable
Sets the HTML used as the template and optionally compiles it. ...

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

Available since: 1.1.0

Parameters

  • html : String
  • compile : Boolean (optional)

    True to compile the template.

Returns

( config, applyIfNotSet ) : Ext.Basechainableprivate
...

Available since: 2.0.0

Parameters

Returns

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self;                      // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Available since: 2.0.0

Returns

Defined By

Static Methods

( config, fullMerge )privatestatic
...

Available since: 2.0.0

Parameters

( members )chainableprivatestatic
...

Available since: 2.0.0

Parameters

( name, member )chainableprivatestatic
...

Available since: 2.0.0

Parameters

( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.implement({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Available since: 2.0.0

Parameters

( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Available since: 2.0.0

Parameters

Returns

( xtype )chainableprivatestatic
...

Available since: 2.0.0

Parameters

( fromClass, members ) : Ext.Basechainableprivatestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Available since: 2.0.0

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

  • members : Array/String

    The names of the members to borrow

Returns

( args )privatestatic
...

Available since: 2.0.0

Parameters

Create a new instance of this Class. ...

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Available since: 2.0.0

Returns

( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Available since: 2.0.0

Parameters

( parent )privatestatic
...

Available since: 2.0.0

Parameters

Ext.Template
view source
( el, [config] ) : Ext.Templatestatic
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.

Available since: 1.1.0

Parameters

  • el : String/HTMLElement

    A DOM element or its id

  • config : Object (optional)

    Config object

Returns

Get the current class' name in string format. ...

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Available since: 2.0.0

Returns

...

Available since: 2.0.0

( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Available since: 2.0.0

Parameters

( fn, scope )chainableprivatestatic
...

Available since: 2.0.0

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

Override members of this class. Overridden methods can be invoked via callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callParent(arguments);

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callParent(arguments);

        alert("Meeeeoooowwww");

        return instance;
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

This method has been deprecated since 4.1.0

Please use Ext.define instead

Available since: 2.0.0

Parameters

  • members : Object

    The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

...

Available since: 2.0.0