Ext.XTemplate
Hierarchy
Ext.BaseExt.TemplateExt.XTemplateRequires
Files
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 Ext.DataView.
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: 'Don Griffin',
title: 'Senior Technomage',
company: 'Sencha Inc.',
drinks: ['Coffee', 'Water', 'More Coffee'],
kids: [
{ name: 'Aubrey', age: 17 },
{ name: 'Joshua', age: 13 },
{ name: 'Cale', age: 10 },
{ name: 'Nikol', age: 5 },
{ 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.
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);
More advanced conditionals are also supported:
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<p>{name} is a ',
'<tpl if="age >= 13">',
'<p>teenager</p>',
'<tpl elseif="age >= 2">',
'<p>kid</p>',
'<tpl else>',
'<p>baby</p>',
'</tpl>',
'</tpl></p>'
);
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'<p>{name} is a ',
'<tpl switch="name">',
'<tpl case="Aubrey" case="Nikol">',
'<p>girl</p>',
'<tpl default">',
'<p>boy</p>',
'</tpl>',
'</tpl></p>'
);
A break is implied between each case and default, however, multiple cases can be listed
in a single <tpl> tag.
Using double quotes
Examples:
var tpl = new Ext.XTemplate(
"<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>",
"<tpl if='name == \"Don\"'>Hello</tpl>"
);
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.
The expression is evaluated and the result is included in the generated result. There are
some special variables available in that code:
- out: The output array into which the template is being appended (using
pushto laterjoin). - 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>'
);
Any code contained in "verbatim" blocks (using "{% ... %}") will be inserted directly in
the generated code for the template. These blocks are not included in the output. This
can be used for simple things like break/continue in a loop, or control structures or
method calls (when they don't produce output). The this references the template instance.
var tpl = new Ext.XTemplate(
'<p>Name: {name}</p>',
'<p>Company: {[values.company.toUpperCase() + ", " + values.title]}</p>',
'<p>Kids: ',
'<tpl for="kids">',
'{% if (xindex % 2 === 0) continue; %}',
'{name}',
'{% if (xindex > 100) break; %}',
'</div>',
'</tpl></p>'
);
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 else>',
'<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
Only applies to Ext.Template, XTemplates are compiled automatically on the first call to apply or applyOut.
Only applies to Ext.Template, XTemplates are compiled automatically on the first call to apply or applyOut.
Available since: 2.0.0
Overrides: Ext.Template.compiled
Properties
Instance Properties 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
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
true in this class to identify an object as an instantiated Template, or subclass thereof.
Defaults to: true
Available since: 1.1.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); / 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
Static Properties
Methods
Instance Methods 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
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
- String
The HTML fragment
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
- String
The HTML fragment
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
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
destroy( )private ...
Available since: 2.0.0
Overrides: Ext.mixin.Observable.destroy, Ext.Container.destroy
doInsert( where, el, values, returnElement )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);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
Available since: 2.0.0
Parameters
- instanceConfig : 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
onConfigUpdate( names, callback, scope )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++;
},
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
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
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
- String
The HTML fragment
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
- String
The HTML fragment
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
argumentsobject 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. 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
argumentsobject from the current method, for example:this.callParent(arguments)
Returns
- Object
Returns the result of calling the parent 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
Available since: 2.0.0
Overrides: Ext.mixin.Observable.destroy, Ext.Container.destroy
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
- instanceConfig : 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++;
},
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
Static Methods addConfig( config, fullMerge )privatestatic addMember( name, member )chainableprivatestatic addMembers( members )chainablestaticAdd 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 : Object
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
- 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: 2.0.0
Parameters
- fromClass : Ext.Base
The class to borrow members from
- members : Array/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: 2.0.0
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: 2.0.0
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: 2.0.0
Returns
- String
className
Gets an XTemplate from an object (an instance of an Ext.define'd class). ...Gets an XTemplate from an object (an instance of an Ext.define'd class).
Many times, templates are configured high in the class hierarchy and are to be
shared by all classes that derive from that base. To further complicate matters,
these templates are seldom actual instances but are rather configurations. For
example:
Ext.define('MyApp.Class', {
someTpl: [
'tpl text here'
]
});
The goal being to share that template definition with all instances and even
instances of derived classes, until someTpl is overridden. This method will
"upgrade" these configurations to be real XTemplate instances in place (to
avoid creating one instance per object).
Available since: 2.0.0
Parameters
- instance : Object
The object from which to get the XTemplate (must be
an instance of an Ext.define'd class).
- name : String
The name of the property by which to get the XTemplate.
Returns
- Ext.XTemplate
The XTemplate instance or null if not found.
mixin( name, mixinClass )privatestatic onExtended( fn, scope )chainableprivatestatic 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
- Ext.Base
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 : Object
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
- 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: 2.0.0
Parameters
- fromClass : Ext.Base
The class to borrow members from
- members : Array/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: 2.0.0
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: 2.0.0
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: 2.0.0
Returns
- String
className
Gets an XTemplate from an object (an instance of an Ext.define'd class).
Many times, templates are configured high in the class hierarchy and are to be
shared by all classes that derive from that base. To further complicate matters,
these templates are seldom actual instances but are rather configurations. For
example:
Ext.define('MyApp.Class', {
someTpl: [
'tpl text here'
]
});
The goal being to share that template definition with all instances and even
instances of derived classes, until someTpl is overridden. This method will
"upgrade" these configurations to be real XTemplate instances in place (to
avoid creating one instance per object).
Available since: 2.0.0
Parameters
- instance : Object
The object from which to get the
XTemplate(must be an instance of an Ext.define'd class). - name : String
The name of the property by which to get the
XTemplate.
Returns
- Ext.XTemplate
The
XTemplateinstance or null if not found.
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
- Ext.Base
this class