Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias (or xtype if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
Framework classes or their members may be specified as private or protected. Else,
the class / member is public. Public, protected, and private are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
classInstance.method1().method2().etc();false is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
This class is a centralized place for formatting functions. It includes functions to format various different types of data, such as text, dates and numeric values.
This class contains several options for localization. These can be set once the library has loaded, all calls to the functions from that point will use the locale settings that were specified.
Options include:
This class also uses the default date format defined here: Ext.Date#defaultFormat.
There are two helper functions that return a new function that can be used in conjunction with grid renderers:
columns: [{
dataIndex: 'date',
renderer: Ext.util.Format.dateRenderer('Y-m-d')
}, {
dataIndex: 'time',
renderer: Ext.util.Format.numberRenderer('0.000')
}]
Functions that only take a single argument can also be passed directly:
columns: [{
dataIndex: 'cost',
renderer: Ext.util.Format.usMoney
}, {
dataIndex: 'productCode',
renderer: Ext.util.Format.uppercase
}]
XTemplates can also directly use Ext.util.Format functions:
new Ext.XTemplate([
'Date: {startDate:date("Y-m-d")}',
'Cost: {cost:usMoney}'
]);
The value true causes config values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config values as properties using their exact name (no prefix).
Defaults to:
true
Available since: 5.0.0
The value true instructs the initConfig method to only honor values for
properties declared in the config block of a class. When false, properties
that are not declared in a config block will be placed on the instance.
Defaults to:
true
Available since: 5.0.0
Setting this property to false will prevent nulling object references
on a Class instance after destruction. Setting this to "async" will delay
the clearing for approx 50ms.
Defaults to:
true
Available since: 6.2.0
Setting this property to true will result in setting the object's
prototype to null after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.
Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.
Defaults to:
false
Available since: 6.2.0
This may be set to true to make the currency function
append the currency sign to the formatted value.
This may be overridden in a locale file.
Defaults to:
false
The number of decimal places that the currency function displays.
This may be overridden in a locale file.
Defaults to:
2
The currency sign that the currency function displays.
This may be overridden in a locale file.
Defaults to:
'$'
True to add a space between the currency and the value
This may be overridden in a locale file.
Defaults to:
''
Available since: 6.2.0
The character that the number function uses as a decimal point.
This may be overridden in a locale file.
Defaults to:
'.'
This property is set to true after the destroy method is called.
Defaults to:
false
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
This property is set to true if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
The percent sign that the percent function displays.
This may be overridden in a locale file.
Defaults to:
'%'
Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics,
this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#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'
},
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'
Defaults to:
Base
The character that the number function uses as a thousand separator.
This may be overridden in a locale file.
Defaults to:
','
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
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)
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)
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)
Returns the result of calling the superclass method
Alias for Ext.String#capitalize. Capitalize the first letter of the given string.
string : String
Format a number as a currency.
value : Number/String
The numeric value to format
sign : String (optional)
The currency sign to use (defaults to currencySign)
decimals : Number (optional)
The number of decimals to use for the currency (defaults to currencyPrecision)
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
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)
Any valid date format string. Defaults to Ext.Date#defaultFormat.
The formatted date string.
Returns a date rendering function that can be reused to apply a date format multiple times efficiently.
format : String
Any valid date format string. Defaults to Ext.Date#defaultFormat.
The date formatting function
Checks a reference and converts it to the default value if it's empty.
value : Object
Reference to check
defaultValue : String (optional)
The value to insert of it's undefined.
Defaults to: ""
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.
Alias for Ext.String#ellipsis. Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.
value : String
The string to truncate.
length : Number
The maximum length to allow before truncating.
word : Boolean (optional)
true to try to find a common word break.
Defaults to: false
The converted text.
Alias for Ext.String#escape. Escapes the passed string for ' and .
string : String
The string to escape.
The escaped string.
Alias for Ext.String#escapeRegex. Escapes the passed string for use in a regular expression.
string : String
The string to escape.
The escaped string.
Simple format for a file size (xxx bytes, xxx KB, xxx MB).
size : Number/String
The numeric value to format
The formatted file size
Alias for Ext.String#format. Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each token must be unique, and must increment in the format {0}, {1}, etc. Example usage:
var cls = 'my-class',
text = 'Some text';
var s = Ext.String.format('<div class="{0}">{1}</div>', cls, text);
// s now contains the string: '<div class="my-class">Some text</div>'
string : String
The tokenized string to be formatted.
values : Mixed...
The values to replace tokens {0}, {1}, etc in order.
The formatted 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
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.
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.
digits : Number
Alias for Ext.String#htmlDecode. Convert certain characters (&, <, >, ', and ") from their HTML character equivalents.
value : String
The string to decode.
The decoded text.
Alias for Ext.String#htmlEncode. Convert certain characters (&, <, >, ', and ") to their HTML character equivalents for literal display in web pages.
value : String
The string to encode.
The encoded text.
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'
instanceConfig : Object
this
Alias for Ext.String#leftPad. 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'
string : String
The original string.
size : Number
The total length of the output string.
character : String (optional)
The character with which to pad the original string.
Defaults to: ' '
The padded string.
Compares value against threshold and returns:
value < threshold then it returns belowvalue > threshold then it returns abovevalue = threshold then it returns equal or above when equal is missingThe 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
threshold : Number
Value to compare against
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
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
Converts a string to all lower case letters.
value : String
The text to convert
The converted text
It does simple math for use in a template, for example:
var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');
A function that operates on the passed value.
Returns a non-breaking space ("NBSP") for any "blank" value.
Available since: 6.2.0
value : Mixed
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
Converts newline characters to the HTML tag <br/>
v : String
The string value to format.
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 precision0.00 - (123456.79) show only digits, 2 precision0.0000 - (123456.7890) show only digits, 4 precision0,000 - (123,457) show comma and digits, no precision0,000.00 - (123,456.79) show comma and digits, 2 precision0,0.00 - (123,456.79) shortcut method, show comma and digits, 2 precision0.#### - (123,456.789) Allow maximum 4 decimal places, but do not right pad with zeroes0.00## - (123456.789) Show at least 2 decimal places, maximum 4, but do not right pad with zeroesv : Number
The number to format.
formatString : String
The way you would like to format this text.
The formatted number.
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
The number formatting function
Returns this result:
value || orValue
The usefulness of this formatter method is in templates. For example:
{foo:or("bar")}
value : Boolean
The "if" value.
orValue : Mixed
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).
box : Number/String
The encoded margins
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.
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")}
value : Boolean
The "if" value.
firstValue : Mixed
secondValue : Mixed
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)
output The pluralized output of the passed singular form
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.
The rounded value.
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.
this
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")}
value : Number
negative : Mixed
positive : Mixed
zero : 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
Strips all script tags.
value : Object
The text from which to strip script tags
The stripped text
Strips all HTML tags.
value : Object
The text from which to strip tags
The stripped text
Returns a substring from within an original string.
value : String
The original text
start : Number
The start index of the substring
length : Number
The length of the substring
The substring
Alias for Ext.String#toggle. 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');
string : String
The current string.
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.
The new value.
Alias for Ext.String#trim. 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-"
string : String
The string to trim.
The trimmed string.
Alias for Ext.String#uncapitalize. Uncapitalize the first letter of a given string.
string : String
Checks a reference and converts it to empty string if it is undefined.
value : Object
Reference to check
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.
this
Converts a string to all upper case letters.
value : String
The text to convert
The converted text
Formats the given value using encodeURI.
Available since: 6.2.0
value : String
The value to encode.
Formats the given value using encodeURIComponent.
Available since: 6.2.0
value : String
The value to encode.
Format a number as US currency.
value : Number/String
The numeric value to format
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.
index : Number
The 0-based word index.
sep : String/RegExp (optional)
The pattern by which to separate words.
Defaults to: "[\W\s]+"
The requested word or empty string.
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.
config : Object
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() { ... };
});
members : Object
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 '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
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.
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()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
Returns the Ext.Configurator for this class.
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'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via Ext.Base#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.
this class
Ext JS | Terms of Use