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 manages state information for a component or element during a layout.
A "block" is a required value that is preventing further calculation. When a layout has encountered a situation where it cannot possibly calculate results, it can associate itself with the context item and missing property so that it will not be rescheduled until that property is set.
Blocks are a one-shot registration. Once the property changes, the block is removed.
Be careful with blocks. If any further calculations can be made, a block is not the right choice.
Whenever any call to getProp, getDomProp, hasProp or hasDomProp is made, the current layout is automatically registered as being dependent on that property in the appropriate state. Any changes to the property will trigger the layout and it will be queued in the Ext.layout.Context.
Triggers, once added, remain for the entire layout. Any changes to the property will reschedule all unfinished layouts in their trigger set.
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
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
There are several cases that allow us to skip (opt out) of laying out a component
and its children as long as its lastBox is not marked as invalid. If anything
happens to change things, the lastBox is marked as invalid by updateLayout
as it ascends the component hierarchy.
Defaults to:
false
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
State variables that are cleared when invalidated. Only applies to component items.
Defaults to:
null
Adds x and y values from a props object to a styles object as "left" and "top" values. Overridden to add the x property as "right" in rtl mode. A styles object for an Element
count The number of styles that were set.
True if this item wraps a Component (rather than an Element).
Defaults to:
false
Adds a block.
name : String
The name of the block list ('blocks' or 'domBlocks').
layout : Ext.layout.Layout
The layout that is blocked.
propName : String
The property name that blocked the layout (e.g., 'width').
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
Adds a trigger.
propName : String
The property name that triggers the layout (e.g., 'width').
inDom : Boolean
True if the trigger list is domTriggers, false if triggers.
Registers a layout in the block list for the given property. Once the property is set in the Ext.layout.Context, the layout is unblocked.
layout : Ext.layout.Layout
propName : String
The property name that blocked the layout (e.g., 'width').
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 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
Removes any blocks on a property in the specified set. Any layouts that were blocked by this property and are not still blocked (by other properties) will be rescheduled.
name : String
The name of the block list ('blocks' or 'domBlocks').
propName : String
The property name that blocked the layout (e.g., 'width').
clears the margin cache so that marginInfo get re-read from the dom on the next call to getMarginInfo() This is needed in some special cases where the margins have changed since the last layout, making the cached values invalid. For example collapsed window headers have different margin than expanded ones.
This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.
Registers a layout in the DOM block list for the given property. Once the property flushed to the DOM by the Ext.layout.Context, the layout is unblocked.
layout : Ext.layout.Layout
propName : String
The property name that blocked the layout (e.g., 'width').
Reschedules any layouts associated with a given trigger.
name : String
The name of the trigger list ('triggers' or 'domTriggers').
propName : String
The property name that triggers the layout (e.g., 'width').
Flushes any updates in the dirty collection to the DOM. This is only called if there are dirty entries because this object is only added to the flushQueue of the Ext.layout.Context when entries become dirty.
Gets the border information for the element as an object with left, top, right and bottom properties holding border size in pixels. This object is only read from the DOM on first request and is cached.
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.
Gets a property of this object if it is correct in the DOM. Also tracks the current layout as dependent on this property so that DOM writes of it will trigger the layout to be recalculated.
propName : String
The property name (e.g., 'width').
The property value or undefined if not yet set or is dirty.
Returns the context item for an owned element. This should only be called on a component's item. The list of child items is used to manage invalidating calculated results.
nameOrEl : String/Ext.dom.Element
The element or the name of an owned element
owner : Ext.layout.container.Container/Ext.Component (optional)
The owner of the named element if the passed "nameOrEl" parameter is a String. Defaults to this ContextItem's "target" property. For more details on owned elements see childEls and renderSelectors
Gets the "frame" information for the element as an object with left, top, right and bottom properties holding border+framing size in pixels. This object is calculated on first request and is cached.
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.
Gets the margin information for the element as an object with left, top, right and bottom properties holding margin size in pixels. This object is only read from the DOM on first request and is cached.
Gets the padding information for the element as an object with left, top, right and bottom properties holding padding size in pixels. This object is only read from the DOM on first request and is cached.
Gets a property of this object. Also tracks the current layout as dependent on this property so that changes to it will trigger the layout to be recalculated.
propName : String
The property name that blocked the layout (e.g., 'width').
The property value or undefined if not yet set.
Returns a style for this item. Each style is read from the DOM only once on first request and is then cached. If the value is an integer, it is parsed automatically (so '5px' is not returned, but rather 5).
styleName : String
The CSS style name.
The value of the DOM style (parsed as necessary).
Returns styles for this item. Each style is read from the DOM only once on first request and is then cached. If the value is an integer, it is parsed automatically (so '5px' is not returned, but rather 5).
styleNames : String[]
The CSS style names.
altNames : String[] (optional)
The alternate names for the returned styles. If given,
these names must correspond one-for-one to the styleNames.
The values of the DOM styles (parsed as necessary).
Returns true if the given property is correct in the DOM. This is equivalent to calling getDomProp and not getting an undefined result. In particular, this call registers the current layout to be triggered by flushes of this property.
propName : String
The property name (e.g., 'width').
Returns true if the given property has been set. This is equivalent to calling getProp and not getting an undefined result. In particular, this call registers the current layout to be triggered by changes to this property.
propName : String
The property name (e.g., 'width').
Clears all properties on this object except (perhaps) those not calculated by this component. This is more complex than it would seem because a layout can decide to invalidate its results and run the component's layouts again, but since some of the values may be calculated by the container, care must be taken to preserve those values.
full : Boolean
True if all properties are to be invalidated, false to keep those calculated by the ownerCt.
A value to pass as the first argument to initContinue.
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
Invalidates the component associated with this item. The layouts for this component and all of its contained items will be re-run after first clearing any computed values.
If state needs to be carried forward beyond the invalidation, the options parameter
can be used.
options : Object
An object describing how to handle the invalidation.
state : Object
before : Function
A function to call after the context data is cleared and before the Ext.layout.Layout#beginLayoutCycle methods are called.
item : Ext.layout.ContextItem
This ContextItem.
options : Object
The options object passed to invalidate.
after : Function
A function to call after the context data is cleared and after the Ext.layout.Layout#beginLayoutCycle methods are called.
item : Ext.layout.ContextItem
This ContextItem.
options : Object
The options object passed to invalidate.
scope : Object
The scope to use when calling the callback functions.
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.
Recovers a property value from the last computation and restores its value and dirty state.
propName : String
The name of the property to recover.
oldProps : Object
The old "props" object from which to recover values.
oldDirty : Object
The old "dirty" object from which to recover state.
Removes a cached ContextItem that was created using getEl. It may be necessary to call this method if the dom reference for owned element changes so that getEl can be called again to reinitialize the ContextItem with the new element.
nameOrEl : String/Ext.dom.Element
The element or the name of an owned element
owner : Ext.layout.container.Container/Ext.Component (optional)
The owner of the named element if the passed "nameOrEl" parameter is a String. Defaults to this ContextItem's "target" property.
Queue the setting of a DOM attribute on this ContextItem's target when next flushed.
name : Object
value : Object
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
Sets the contentHeight property. If the component uses raw content, then only the measured height is acceptable.
Calculated values can sometimes be NaN or undefined, which generally mean the calculation is not done. To indicate that such as value was passed, 0 is returned. Otherwise, 1 is returned.
If the caller is not measuring (i.e., they are calculating) and the component has raw content, 1 is returned indicating that the caller is done.
height : Object
measured : Object
Sets the contentWidth and contentHeight properties. If the component uses raw content, then only the measured values are acceptable.
Calculated values can sometimes be NaN or undefined, which generally means that the calculation is not done. To indicate that either passed value was such a value, false returned. Otherwise, true is returned.
If the caller is not measuring (i.e., they are calculating) and the component has raw content, true is returned indicating that the caller is done.
width : Object
height : Object
measured : Object
Sets the contentWidth property. If the component uses raw content, then only the measured width is acceptable.
Calculated values can sometimes be NaN or undefined, which generally means that the calculation is not done. To indicate that such as value was passed, 0 is returned. Otherwise, 1 is returned.
If the caller is not measuring (i.e., they are calculating) and the component has raw content, 1 is returned indicating that the caller is done.
width : Object
measured : Object
Sets the height and constrains the height to min/maxHeight range.
height : Number
The height.
dirty : Boolean (optional)
Specifies if the value is currently in the DOM. A
value of false indicates that the value is already in the DOM.
Defaults to: true
The actual height after constraining.
Sets a property value. This will unblock and/or trigger dependent layouts if the property value is being changed. Values of NaN and undefined are not accepted by this method.
propName : String
The property name (e.g., 'width').
value : Object
The new value of the property.
dirty : Boolean
Optionally specifies if the value is currently in the DOM
(default is true which indicates the value is not in the DOM and must be flushed
at some point).
1 if this call specified the property value, 0 if not.
Sets the height and constrains the width to min/maxWidth range.
width : Number
The width.
dirty : Boolean (optional)
Specifies if the value is currently in the DOM. A
value of false indicates that the value is already in the DOM.
Defaults to: true
The actual width after constraining.
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
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 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