Ext.XTemplate
Hierarchy
Ext.BaseExt.TemplateExt.XTemplateFiles
A template class that supports advanced functionality like:
- Autofilling arrays using templates and sub-templates
- Conditional processing with basic comparison operators
- Basic math function support
- Execute arbitrary inline code with special built-in template variables
- Custom member functions
- Many special tags and built-in operators that aren't defined as part of the API, but are supported in the templates that can be created
XTemplate provides the templating mechanism built into:
The Ext.Template describes the acceptable parameters to pass to the constructor. The following examples demonstrate all of the supported features.
Sample Data
This is the data object used for reference in each code example:
var data = {
name: 'Tommy Maintz',
title: 'Lead Developer',
company: 'Sencha Inc.',
email: 'tommy@sencha.com',
address: '5 Cups Drive',
city: 'Palo Alto',
state: 'CA',
zip: '44102',
drinks: ['Coffee', 'Soda', 'Water'],
kids: [
{
name: 'Joshua',
age:3
},
{
name: 'Matthew',
age:2
},
{
name: 'Solomon',
age:0
}
]
};
Auto filling of arrays
The tpl tag and the for operator are used to process the provided data object:
- If the value specified in for is an array, it will auto-fill, repeating the template block inside the tpl tag for each item in the array.
- If for="." is specified, the data object provided is examined.
- While processing an array, the special variable {#} will provide the current array index + 1 (starts at 1, not 0).
Examples:
<tpl for=".">...</tpl> // loop through array at root node
<tpl for="foo">...</tpl> // loop through array at foo node
<tpl for="foo.bar">...</tpl> // loop through array at foo.bar node
Using the sample data above:
var tpl = new Ext.XTemplate(
'<p>Kids: ',
'<tpl for=".">', // process the data.kids node
'<p>{#}. {name}</p>', // use current array index to autonumber
'</tpl></p>'
);
tpl.overwrite(panel.body, data.kids); // pass the kids property of the data object
An example illustrating how the for property can be leveraged to access specified members of the provided data object to populate the template:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Title: {title}</p>',
'<p>Company: {company}</p>',
'<p>Kids: ',
'<tpl for="kids">', // interrogate the kids property within the data
'<p>{name}</p>',
'</tpl></p>'
);
tpl.overwrite(panel.body, data); // pass the root node of the data object
Flat arrays that contain values (and not objects) can be auto-rendered using the special {.} variable inside a
loop. This variable will represent the value of the array at the current index:
var tpl = new Ext.XTemplate(
'<p>{name}\'s favorite beverages:</p>',
'<tpl for="drinks">',
'<div> - {.}</div>',
'</tpl>'
);
tpl.overwrite(panel.body, data);
When processing a sub-template, for example while looping through a child array, you can access the parent object's members via the parent object:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<tpl if="age > 1">',
'<p>{name}</p>',
'<p>Dad: {parent.name}</p>',
'</tpl>',
'</tpl></p>'
);
tpl.overwrite(panel.body, data);
Conditional processing with basic comparison operators
The tpl tag and the if operator are used to provide conditional checks for deciding whether or not to render specific parts of the template. Notes:
- Double quotes must be encoded if used within the conditional
- There is no else operator -- if needed, two opposite if statements should be used.
Examples:
<tpl if="age > 1 && age < 10">Child</tpl>
<tpl if="age >= 10 && age < 18">Teenager</tpl>
<tpl if="this.isGirl(name)">...</tpl>
<tpl if="id==\'download\'">...</tpl>
<tpl if="needsIcon"><img src="{icon}" class="{iconCls}"/></tpl>
// no good:
<tpl if="name == "Tommy"">Hello</tpl>
// encode " if it is part of the condition, e.g.
<tpl if="name == "Tommy"">Hello</tpl>
Using the sample data above:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<tpl if="age > 1">',
'<p>{name}</p>',
'</tpl>',
'</tpl></p>'
);
tpl.overwrite(panel.body, data);
Basic math support
The following basic math operators may be applied directly on numeric data values:
+ - * /
For example:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<tpl if="age > 1">', // <-- Note that the > is encoded
'<p>{#}: {name}</p>', // <-- Auto-number each item
'<p>In 5 Years: {age+5}</p>', // <-- Basic math
'<p>Dad: {parent.name}</p>',
'</tpl>',
'</tpl></p>'
);
tpl.overwrite(panel.body, data);
Execute arbitrary inline code with special built-in template variables
Anything between {[ ... ]} is considered code to be executed in the scope of the template. There are some special
variables available in that code:
- values: The values in the current scope. If you are using scope changing sub-templates, you can change what values is.
- parent: The scope (values) of the ancestor template.
- xindex: If you are in a looping template, the index of the loop you are in (1-based).
- xcount: If you are in a looping template, the total length of the array you are looping.
This example demonstrates basic row striping using an inline code block and the xindex variable:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Company: {[values.company.toUpperCase() + ", " + values.title]}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<div class="{[xindex % 2 === 0 ? "even" : "odd"]}">',
'{name}',
'</div>',
'</tpl></p>'
);
tpl.overwrite(panel.body, data);
Template member functions
One or more member functions can be specified in a configuration object passed into the XTemplate constructor for more complex processing:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<tpl if="this.isGirl(name)">',
'<p>Girl: {name} - {age}</p>',
'</tpl>',
// use opposite if statement to simulate 'else' processing:
'<tpl if="this.isGirl(name) == false">',
'<p>Boy: {name} - {age}</p>',
'</tpl>',
'<tpl if="this.isBaby(age)">',
'<p>{name} is a baby!</p>',
'</tpl>',
'</tpl></p>',
{
// XTemplate configuration:
disableFormats: true,
// member functions:
isGirl: function(name){
return name == 'Sara Grace';
},
isBaby: function(age){
return age < 1;
}
}
);
tpl.overwrite(panel.body, data);
Available since: 1.1.0
Config options
The regular expression used to match code variables. Default: matches {[expression]}.
Defaults to: /\{\[((?:\\]|.|\n)*?)\]\}/g
Available since: 4.0.0
Only applies to Ext.Template, XTemplates are compiled automatically.
Only applies to Ext.Template, XTemplates are compiled automatically.
Available since: 3.4.0
Overrides: Ext.Template.compiled
Properties
End Definitions
Defaults to: /<tpl\b[^>]*>((?:(?=([^<]+))|<(?!tpl\b[^>]*>))*?)<\/tpl>/
Available since: 4.0.0
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); / dependent on 'this'
return 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: 4.0.0
Methods
Instance Methods 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
Overrides: Ext.Template.constructor
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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return an Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
Alias for applyTemplate. ...Alias for applyTemplate.
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.applyTemplate(['John', 25]);
or an object:
var tpl = new Ext.Template('Name: {name}, Age: {age}');
tpl.applyTemplate({name: 'John', age: 25});
Returns
- String
The HTML fragment
applySubTemplate( id, values, parent, xindex, xcount )private inherit docs from Ext.Template
Returns an HTML fragment of this template with the specified values applied. ...inherit docs from Ext.Template
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.applyTemplate(['John', 25]);
or an object:
var tpl = new Ext.Template('Name: {name}, Age: {age}');
tpl.applyTemplate({name: 'John', age: 25});
Returns
- String
The HTML fragment
Overrides: Ext.Template.applyTemplate
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!");
return this;
}
});
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: 4.0.0
Parameters
- args : Array/Arguments
The arguments, either an array or the arguments object
Returns
- Object
Returns the result after calling the overridden method
Call the parent's overridden method. ...Call the parent's overridden method. For example:
Ext.define('My.own.A', {
constructor: function(test) {
alert(test);
}
});
Ext.define('My.own.B', {
extend: 'My.own.A',
constructor: function(test) {
alert(test);
this.callParent([test + 1]);
}
});
Ext.define('My.own.C', {
extend: 'My.own.B',
constructor: function() {
alert("Going to call parent's overriden constructor...");
this.callParent(arguments);
}
});
var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
// alerts '2', then alerts '3'
Available since: 4.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 from the superclass' method
compile( ) : Ext.XTemplatechainableDoes nothing. ...Does nothing. XTemplates are compiled automatically, so this function simply returns this.
Available since: 1.1.0
Returns
- Ext.XTemplate
this
Overrides: Ext.Template.compile
doInsert( where, el, values, returnEl )private 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);
return this;
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
Available since: 4.0.0
Parameters
- config : Object
Returns
- Object
mixins The mixin prototypes as key - value pairs
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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or 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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or 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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
mixin( name, cls )private 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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
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
Returns
- Ext.Template
this
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++;
return this;
},
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: 4.0.0
Returns
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
Overrides: Ext.Template.constructor
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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return an Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
Alias for applyTemplate.
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.applyTemplate(['John', 25]);or an object:
var tpl = new Ext.Template('Name: {name}, Age: {age}'); tpl.applyTemplate({name: 'John', age: 25});
Returns
- String
The HTML fragment
inherit docs from Ext.Template
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.applyTemplate(['John', 25]);or an object:
var tpl = new Ext.Template('Name: {name}, Age: {age}'); tpl.applyTemplate({name: 'John', age: 25});
Returns
- String
The HTML fragment
Overrides: Ext.Template.applyTemplate
Call the original method that was previously overridden with override
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
return this;
}
});
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: 4.0.0
Parameters
- args : Array/Arguments
The arguments, either an array or the
argumentsobject
Returns
- Object
Returns the result after calling the overridden method
Call the parent's overridden method. For example:
Ext.define('My.own.A', {
constructor: function(test) {
alert(test);
}
});
Ext.define('My.own.B', {
extend: 'My.own.A',
constructor: function(test) {
alert(test);
this.callParent([test + 1]);
}
});
Ext.define('My.own.C', {
extend: 'My.own.B',
constructor: function() {
alert("Going to call parent's overriden constructor...");
this.callParent(arguments);
}
});
var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
// alerts '2', then alerts '3'
Available since: 4.0.0
Parameters
- args : Array/Arguments
The arguments, either an array or the
argumentsobject from the current method, for example:this.callParent(arguments)
Returns
- Object
Returns the result from the superclass' method
Does nothing. XTemplates are compiled automatically, so this function simply returns this.
Available since: 1.1.0
Returns
- Ext.XTemplate
this
Overrides: Ext.Template.compile
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);
return this;
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
Available since: 4.0.0
Parameters
- config : Object
Returns
- Object
mixins The mixin prototypes as key - value pairs
Applies the supplied values to the template and inserts the new node(s) after el.
Available since: 1.1.0
Parameters
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
Applies the supplied values to the template and inserts the new node(s) before el.
Available since: 1.1.0
Parameters
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
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
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
Applies the supplied values to the template and overwrites the content of el with the new node(s).
Available since: 1.1.0
Parameters
- el : String/HTMLElement/Ext.Element
The context element
- values : Object/Array
The template values. See applyTemplate for details.
- returnElement : Boolean (optional)
true to return a Ext.Element.
Returns
- HTMLElement/Ext.Element
The new node or Element
Sets the HTML used as the template and optionally compiles it.
Available since: 1.1.0
Parameters
Returns
- Ext.Template
this
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++;
return this;
},
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: 4.0.0
Returns
Static Methods 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: 4.0.2
Parameters
- members : Object
Returns
- Ext.Base
this
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: 4.0.2
Parameters
- fromClass : Ext.Base
The class to borrow members from
- members : String/String[]
The names of the members to borrow
Returns
- Ext.Base
this
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: 4.0.2
Returns
- Object
the created instance.
createAlias( alias, origin )staticCreate 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: 4.0.2
Parameters
- alias : String/Object
The new method name, or an object to set multiple aliases. See
flexSetter
- origin : String/Object
The original method name
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
Returns
- Ext.Template
The created template
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: 4.0.4
Returns
- String
className
implement( members )staticAdd 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: 4.0.2
Parameters
- members : Object
Override prototype members of this class. ...Override prototype members of this class. Overridden methods can be invoked via
callOverridden
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
return this;
}
});
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: 4.0.2
Parameters
- members : Object
Returns
- Ext.Base
this
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: 4.0.2
Parameters
- members : Object
Returns
- Ext.Base
this
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: 4.0.2
Parameters
- fromClass : Ext.Base
The class to borrow members from
- members : String/String[]
The names of the members to borrow
Returns
- Ext.Base
this
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: 4.0.2
Returns
- Object
the created instance.
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: 4.0.2
Parameters
- alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
- origin : String/Object
The original method name
Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.
Available since: 1.1.0
Parameters
Returns
- Ext.Template
The created template
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: 4.0.4
Returns
- String
className
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: 4.0.2
Parameters
- members : Object
Override prototype members of this class. Overridden methods can be invoked via callOverridden
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
return this;
}
});
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: 4.0.2
Parameters
- members : Object
Returns
- Ext.Base
this