Instance Methods
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated
config.
Formats an object of name value properties as HTML element attribute values suitable for using when creating textual markup.
attributes :
Object
An object containing the HTML attributes as properties eg: {height:40, vAlign:'top'}
Call the original method that was previously overridden with Ext.Base#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!");
this.callOverridden();
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args :
Array/Arguments
The arguments, either an array or the arguments
object
from the current method, for example: this.callOverridden(arguments)
:
Object
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
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 and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
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',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use
method-callSuper. This is often done to patch a method to fix a bug.
args :
Array/Arguments
The arguments, either an array or the arguments
object
from the current method, for example: this.callParent(arguments)
:
Object
Returns the result of calling the parent method
This method is used by an override to call the superclass method but
bypass any overridden method. This is often done to "patch" a method that
contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function () {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method
, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function () {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use method-callParent to call the superclass
method
since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent
would produce "Fixed" then "Bad"
then "Good".
args :
Array/Arguments
The arguments, either an array or the arguments
object
from the current method, for example: this.callSuper(arguments)
:
Object
Returns the result of calling the superclass method
Format a number as a currency.
value :
Number/String
The numeric value to format
currencySign :
String
(optional)
decimals :
Number
(optional)
end :
Boolean
(optional)
True if the currency sign should be at the end of the string
(defaults to currencyAtEnd)
currencySpacer :
String
(optional)
True to add a space between the currency and value
:
String
The formatted currency string
Formats the passed date using the specified format pattern.
Note that this uses the native Javascript Date.parse() method and is therefore subject to its idiosyncrasies.
Most formats assume the local timezone unless specified. One notable exception is 'YYYY-MM-DD' (note the dashes)
which is typically interpreted in UTC and can cause date shifting.
value :
String/Date
The value to format. Strings must conform to the format
expected by the JavaScript Date object's
parse() method.
format :
String
(optional)
:
String
The formatted date string.
Returns a date rendering function that can be reused to apply a date format multiple times efficiently.
:
Function
The date formatting function
Checks a reference and converts it to the default value if it's empty.
defaultValue :
String
(optional)
The value to insert of it's undefined.
Defaults to: ""
:
String
This method is called to cleanup an object and its resources. After calling
this method, the object should not be used any further in any way, including
access to its methods and properties.
To prevent potential memory leaks, all object references will be nulled
at the end of destruction sequence, unless clearPropertiesOnDestroy
is set to false
.
Destroys member properties by name.
If a property name is the name of a config, the getter is not invoked, so
if the config has not been initialized, nothing will be done.
The property will be destroyed, and the corrected name (if the property is a config
and config names are prefixed) will set to null
in this object's dictionary.
args :
String...
One or more names of the properties to destroy and remove from the object.
Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.
Alias for Ext.String#ellipsis.
length :
Number
The maximum length to allow before truncating.
word :
Boolean
(optional)
true
to try to find a common word break.
Defaults to: false
:
String
Simple format for a file size (xxx bytes, xxx KB, xxx MB).
size :
Number/String
The numeric value to format
:
String
Returns a specified config property value. If the name parameter is not passed,
all current configuration options will be returned as key value pairs.
name :
String
(optional)
The name of the config property to get.
peek :
Boolean
(optional)
true
to peek at the raw value without calling the getter.
Defaults to: false
ifInitialized :
Boolean
(optional)
true
to only return the initialized property value,
not the raw config value, and not to trigger initialization. Returns undefined
if the
property has not yet been initialized.
Defaults to: false
:
Object
The config property value.
Returns the initial configuration passed to the constructor when
instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
});
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
});
Calling btn.getInitialConfig()
would return an object including the config
options passed to the create
method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')
returns 'Test Button'.
name :
String
(optional)
Name of the config option to return.
:
Object/Mixed
The full config object or a single config value
when name
parameter specified.
Returns the given number as a base 16 string at least digits
in length. If
the number is fewer digits, 0's are prepended as necessary. If digits
is
negative, the absolute value is the exact number of digits to return. In this
case, if then number has more digits, only the least significant digits are
returned.
expect(Ext.util.Format.hex(0x12e4, 2)).toBe('12e4');
expect(Ext.util.Format.hex(0x12e4, -2)).toBe('e4');
expect(Ext.util.Format.hex(0x0e, 2)).toBe('0e');
value :
Number
The number to format in hex.
:
String
Convert certain characters (&, <, >, ', and ") from their HTML character equivalents.
Alias for Ext.String#htmlDecode.
:
String
Convert certain characters (&, <, >, ', and ") to their HTML character equivalents for literal display in web pages.
Alias for Ext.String#htmlEncode.
:
String
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'
:
Ext.Base
Pads the left side of a string with a specified character. This is especially useful
for normalizing number and date strings. Example usage:
var s = Ext.String.leftPad('123', 5, '0');
// s now contains the string: '00123'
Alias for Ext.String#leftPad.
size :
Number
The total length of the output string.
character :
String
(optional)
The character with which to pad the original string.
Defaults to: ' '
:
String
Compares value
against threshold
and returns:
- if
value
< threshold
then it returns below
- if
value
> threshold
then it returns above
- if
value
= threshold
then it returns equal
or above
when equal
is missing
The usefulness of this formatter method is in templates. For example:
{foo:lessThanElse(0, 'negative', 'positive')}
{bar:lessThanElse(200, 'lessThan200', 'greaterThan200', 'equalTo200')}
value :
Number
Value that will be checked
below :
Mixed
Value to return when value
< threshold
above :
Mixed
Value to return when value
> threshold
. If value
= threshold
and
equal
is missing then above
is returned.
equal :
Mixed
Value to return when value
= threshold
:
Mixed
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy
).
:
Object
Converts a string to all lower case letters.
:
String
It does simple math for use in a template, for example:
var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');
:
Function
A function that operates on the passed value.
Returns a non-breaking space ("NBSP") for any "blank" value.
Available since: 6.2.0
strict :
Boolean
(optional)
Pass false
to convert all falsey values to an
NBSP. By default, only '', null
and undefined
will be converted.
Defaults to: true
:
Mixed
Converts newline characters to the HTML tag <br/>
v :
String
The string value to format.
:
String
The string with embedded <br/>
tags in place of newlines.
Formats the passed number according to the passed format string.
The number of digits after the decimal separator character specifies the number of
decimal places in the resulting string. The local-specific decimal character is
used in the result.
The presence of a thousand separator character in the format string specifies that
the locale-specific thousand separator (if any) is inserted separating thousand groups.
By default, "," is expected as the thousand separator, and "." is expected as the decimal separator.
Locale-specific characters are always used in the formatted output when inserting
thousand and decimal separators. These can be set using the thousandSeparator and
decimalSeparator options.
The format string must specify separator characters according to US/UK conventions ("," as the
thousand separator, and "." as the decimal separator)
To allow specification of format strings according to local conventions for separator characters, add
the string /i
to the end of the format string. This format depends on the thousandSeparator and
decimalSeparator options. For example, if using European style separators, then the format string
can be specified as '0.000,00'
. This would be equivalent to using '0,000.00'
when using US style formatting.
Examples (123456.789):
0
- (123457) show only digits, no precision
0.00
- (123456.79) show only digits, 2 precision
0.0000
- (123456.7890) show only digits, 4 precision
0,000
- (123,457) show comma and digits, no precision
0,000.00
- (123,456.79) show comma and digits, 2 precision
0,0.00
- (123,456.79) shortcut method, show comma and digits, 2 precision
0.####
- (123,456.789) Allow maximum 4 decimal places, but do not right pad with zeroes
0.00##
- (123456.789) Show at least 2 decimal places, maximum 4, but do not right pad with zeroes
formatString :
String
The way you would like to format this text.
:
String
Returns a number rendering function that can be reused to apply a number format multiple
times efficiently.
format :
String
Any valid number format string for number
:
Function
The number formatting function
Returns this result:
value || orValue
The usefulness of this formatter method is in templates. For example:
{foo:or("bar")}
Parses a number or string representing margin sizes into an object.
Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and
"10 10 10 10" are all valid options and would return the same result).
:
Object
An object with margin sizes for top, right, bottom and left
Formats the passed number as a percentage according to the passed format string.
The number should be between 0 and 1 to represent 0% to 100%.
value :
Number
The percentage to format.
formatString :
String
(optional)
Defaults to: "0"
:
String
The formatted percentage.
If value
is a number, returns the argument from that index. For example
var s = Ext.util.Format.pick(2, 'zero', 'one', 'two');
// s === 'two'
Otherwise, value
is treated in a truthy/falsey manner like so:
var s = Ext.util.Format.pick(null, 'first', 'second');
// s === 'first'
s = Ext.util.Format.pick({}, 'first', 'second');
// s === 'second'
The usefulness of this formatter method is in templates. For example:
{foo:pick("F","T")}
{bar:pick("first","second","third")}
Selectively return the plural form of a word based on a numeric value.
For example, the following template would result in "1 Comment". If the
value of count
was 0 or greater than 1, the result would be "x Comments".
var tpl = new Ext.XTemplate('{count:plural("Comment")}');
tpl.apply({
count: 1
}); // returns "1 Comment"
Examples using the static plural
method call:
Ext.util.Format.plural(2, 'Comment');
// returns "2 Comments"
Ext.util.Format.plural(4, 'person', 'people');
// returns "4 people"
value :
Number
The value to compare against
singular :
String
The singular form of the word
plural :
String
(optional)
The plural form of the word (defaults to the
singular form with an "s" appended)
:
String
output The pluralized output of the passed singular form
Resolves the specified resource url
with an optional prefix
. This resolution
is based on Ext#resolveResource. The prefix is intended to be used for
a package or resource pool identifier.
url :
String
The resource url to resolve
prefix :
String
(optional)
A prefix/identifier to include in the resolution.
:
String
Rounds the passed number to the required decimal precision.
value :
Number/String
The numeric value to round.
precision :
Number
(optional)
The number of decimal places to which to round the
first parameter's value. If undefined
the value
is passed to Math.round
otherwise the value is returned unmodified.
:
Number
Sets a single/multiple configuration options.
name :
String/Object
The name of the property to set, or a set of key value pairs to set.
value :
Object
(optional)
The value to set for the name parameter.
:
Ext.Base
Checks if value
is a positive or negative number and returns the proper param.
The usefulness of this formatter method is in templates. For example:
{foo:sign("clsNegative","clsPositive")}
:
Mixed
Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#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
:
Ext.Class
Strips all script tags.
value :
Object
The text from which to strip script tags
:
String
Returns a substring from within an original string.
start :
Number
The start index of the substring
length :
Number
The length of the substring
:
String
Utility function that allows you to easily switch a string between two alternating values. The passed value
is compared to the current string, and if they are equal, the other value that was passed in is returned. If
they are already different, the first value passed in is returned. Note that this method returns the new value
but does not change the current string.
// alternate sort directions
sort = Ext.String.toggle(sort, 'ASC', 'DESC');
// instead of conditional logic:
sort = (sort === 'ASC' ? 'DESC' : 'ASC');
Alias for Ext.String#toggle.
value :
String
The value to compare to the current string.
other :
String
The new value to use if the string already equals the first value passed in.
:
String
Trims whitespace from either end of a string, leaving spaces within the string intact. Example:
var s = ' foo bar ';
alert('-' + s + '-'); //alerts "- foo bar -"
alert('-' + Ext.String.trim(s) + '-'); //alerts "-foo bar-"
Alias for Ext.String#trim.
:
String
Checks a reference and converts it to empty string if it is undefined.
:
Object
Empty string if converted, otherwise the original value
Destroys a given set of linked
objects. This is only needed if
the linked object is being destroyed before this instance.
names :
String[]
The names of the linked objects to destroy.
:
Ext.Base
Converts a string to all upper case letters.
:
String
Formats the given value using encodeURI
.
Available since: 6.2.0
:
String
Formats the given value using encodeURIComponent
.
Available since: 6.2.0
:
String
Format a number as US currency.
value :
Number/String
The numeric value to format
:
String
The formatted currency string
Returns the word at the given index
. Spaces and punctuation are considered
as word separators by default. For example:
console.log(Ext.util.Format.word('Hello, my name is Bob.', 2);
// == 'name'
value :
String
The sentence to break into words.
sep :
String/RegExp
(optional)
The pattern by which to separate words.
Defaults to: "[\W\s]+"
:
String
The requested word or empty string.
Static Methods
Adds new config properties to this class. This is called for classes when they
are declared, then for any mixins that class may define and finally for any
overrides defined that target the class.
mixinClass :
Ext.Class
(optional)
The mixin class if the configs are from a mixin.
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members :
Object
The members to add to this class.
isStatic :
Boolean
(optional)
Pass true
if the members are static.
Defaults to: false
privacy :
Boolean
(optional)
Pass true
if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
:
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() { ... };
});
:
Ext.Base
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 '$$$$$$$'
fromClass :
Ext.Base
The class to borrow members from
members :
Array/String
The names of the members to borrow
:
Ext.Base
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.
:
Object
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()
alias :
String/Object
The new method name, or an object to set multiple aliases. See
flexSetter
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'
:
String
Used internally by the mixins pre-processor
:
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!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define
instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
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).
members :
Object
The properties to add to this class. This should be
specified as an object literal containing one or more properties.
:
Ext.Base