The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact.
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.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
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.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
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
Or in the case of an ExtReact component class this
indicates a member of type prop
- 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.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods section
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.
Just as Ext.dom.Element wraps around a native DOM node, Ext.event.Event wraps the browser's native event-object normalizing cross-browser differences such as mechanisms to stop event-propagation along with a method to prevent default actions from taking place.
Here is a simple example of how you use it:
var container = Ext.create('Ext.Container', {
layout: 'fit',
renderTo: Ext.getBody(),
items: [{
id: 'logger',
html: 'Click somewhere!',
padding: 5
}]
});
container.getEl().on({
click: function(e, node) {
var string = '';
string += 'You clicked at: { x: ' + e.pageX + ', y: ' + e.pageY + ' } ' +
'<i>(e.pageX & e.pageY)</i>';
string += '<hr />';
string += 'The HTMLElement you clicked has the className of: <strong>' +
e.target.className + '</strong> <i>(e.target)</i>';
string += '<hr />';
string += 'The HTMLElement which has the listener has a className of: <strong>' +
e.currentTarget.className + '</strong> <i>(e.currentTarget)</i>';
Ext.getCmp('logger').setHtml(string);
}
});
Ext JS includes many default event recognizers to know when a user interacts with the application.
For a full list of default recognizers, and more information, please view the Ext.event.gesture.Recognizer documentation.
This class also provides a set of constants for use with key events. These are useful for determining if a specific key was pressed, and are available both on instances, and as static properties of the class. The following two statements are equivalent:
if (e.getKey() === Ext.event.Event.TAB) {
// tab key was pressed
}
if (e.getKey() === e.TAB) {
// tab key was pressed
}
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
A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.
Defaults to:
{}
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
True if the control key was down during the event. In Mac this will also be true when meta key was down.
Refers to the element the event handler was attached to, vs the target, which is
the actual element that fired the event. For example, if the event bubbles, the
target element may be a descendant of the currentTarget, as the event may
have been triggered on the target and then bubbled up to the currentTarget
where it was handled.
Indicates whether or not preventDefault() was called on the event.
Defaults to:
false
Same as currentTarget
Deprecated since version 5.0.0
use currentTarget instead.
This property is set to true after the destroy method is called.
Defaults to:
false
The direction of the swipe. Available options are:
This is only available when the event type is swipe
The distance of the event.
This is only available when the event type is swipe and pinch.
Returns the X and Y coordinates of this event without regard to any RTL direction settings.
Defaults to:
prototype.getXY
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 browsers x coordinate of the event. Note: this only works in browsers that support pageX on the native browser event object (pageX is not natively supported in IE9 and earlier). In Ext JS, for a cross browser normalized x-coordinate use getX
The browsers y coordinate of the event. Note: this only works in browsers that support pageY on the native browser event object (pageY is not natively supported in IE9 and earlier). In Ext JS, for a cross browser normalized y-coordinate use getY
The pointer type for this event. May be empty if the event was not triggered by a pointer. Current available types are:
mousetouchpenA amount of rotation, since the start of the event.
This is only available when the event type is rotate
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 element that fired this event. For the element whose handlers are currently
being processed, i.e. the element that the event handler was attached to, use
currentTarget
The mouse wheel delta scaling factor when the
deltaMode
is DOM_DELTA_LINE
To change this value:
Ext.event.Event.prototype.WHEEL_LINE_SIZE = 16;
Defaults to:
20
The mouse wheel delta scaling factor when the
deltaMode
is DOM_DELTA_PAGE
To change this value:
Ext.event.Event.prototype.WHEEL_PAGE_SIZE = 400;
Defaults to:
600
The mouse wheel delta scaling factor when the
deltaMode
is DOM_DELTA_PIXEL
To change this value:
Ext.event.Event.prototype.WHEEL_PIXEL_SIZE = 3;
Defaults to:
1
These are tracked separately from mouseEvents because the mouseEvents map is used by Dom publisher to eliminate duplicate events on devices that fire multiple kinds of events (mouse, touch, pointer). Adding click events to the mouse events map can cause click events to be blocked from firing in some cases.
Defaults to:
{
click: 1,
dblclick: 1
}
An amalgamation of pointerEvents/mouseEvents/touchEvents. Will be populated in class callback.
Defaults to:
{}
Defaults to:
{
mousedown: 1,
mousemove: 1,
mouseup: 1,
mouseover: 1,
mouseout: 1,
mouseenter: 1,
mouseleave: 1
}
Defaults to:
{
pointerdown: 1,
pointermove: 1,
pointerup: 1,
pointercancel: 1,
pointerover: 1,
pointerout: 1,
pointerenter: 1,
pointerleave: 1,
MSPointerDown: 1,
MSPointerMove: 1,
MSPointerUp: 1,
MSPointerOver: 1,
MSPointerOut: 1,
MSPointerCancel: 1,
MSPointerEnter: 1,
MSPointerLeave: 1
}
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
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
Creates a new Event object that is prototype-chained to this event. Useful for creating identical events so that certain properties can be changed without affecting the original event. For example, translated events have their "type" corrected in this manner.
props : Object
properties to set on the chained event
Claims this event as the currently active gesture. Once a gesture is claimed
no other gestures will fire events until after the current gesture has completed.
For example, if claimGesture() is invoked on a dragstart or drag event, no
swipestart or swipe events will be fired until the drag gesture completes, even if
the gesture also meets the required duration and distance requirements to be recognized
as a swipe.
If claimGesture() is invoked on a mouse, touch, or pointer event, it will disable
all gesture events until termination of the current gesture is indicated by a
mouseup, touchend, or pointerup event.
Correctly scales a given wheel delta.
delta : Number
The delta value.
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.
If this is an event of type paste, this returns the clipboard data
of the pasesd mime type.
Available since: 6.5.1
type : String (optional)
The mime type of the data to extract from the clipabord.
Note that this uses non-standard browaer APIs and may not work reliably on all platforms.
Defaults to: 'text/plain'
The clipboard data.
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
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.
Gets the event coordinates relative to the currentTargets position.
clip : Boolean
The returned coordinates are guaranteed to be within
[0, width] and [0, height] of the target, if clip is set to true.
The xy values like [x, y]
Gets the x coordinate of the event.
Deprecated since version 4.0
use getX instead
Gets the y coordinate of the event.
Deprecated since version 4.0
use getY instead
Returns a point object that consists of the object coordinates.
point
Gets the related target.
selector : String (optional)
A simple selector to filter the target or look for an ancestor of the target. See Ext.dom.Query for information about simple selectors.
maxDepth : Number/HTMLElement (optional)
The max depth to search as a number or element (defaults to 10 || document.body).
returnEl : Boolean (optional)
true to return a Ext.Element object instead of DOM
node.
Gets the target for the event.
selector : String (optional)
A simple selector to filter the target or look for an ancestor of the target
maxDepth : Number/Mixed (optional)
The max depth to search as a number or element (defaults to 10 || document.body)
Defaults to: 10||document.body
returnEl : Boolean (optional)
true to return a Ext.Element object instead
of DOM node.
Normalizes mouse wheel y-delta across browsers. To get x-delta information, use getWheelDeltas instead.
The mouse wheel y-delta
Deprecated since version 6.6.0
Use deltaY instead
Returns the mouse wheel deltas for this event.
An object with "x" and "y" properties holding the mouse wheel deltas.
Deprecated since version 6.7.0
Use deltaX and deltaY instead
Gets the X and Y coordinates of the event.
The xy values like [x, y]
Returns true if the control, meta, shift or alt key was pressed during this event.
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
Checks if the key pressed was a "special" key. A special key is defined as one of these keys:
true if the key for this event is special
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.
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
Initiates a drag gesture in response to this event
Only available when type is 'longpress'. When invoked a dragstart event
will be immediately fired at the coordinates of the longpress event. Thereafter
drag events will fire in response to movement on the screen without regard
to the distance moved.
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();
// always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(statics.speciesName);
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
// equivalent to: My.Cat.speciesName
cloned.groupName = this.statics().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
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
Watches config properties.
instance.watchConfig({
title: 'onTitleChange',
scope: me
});
Available since: 6.7.0
name : Object
fn : Object
scope : Object
Returns true if the target of this event is a child of el. If the allowEl
parameter is set to false, it will return false if the target is el.
Example usage:
// Handle click on any child of an element
Ext.getBody().on('click', function(e){
if(e.within('some-el')){
alert('Clicked on a child of some-el!');
}
});
// Handle click directly on an element, ignoring clicks on child nodes
Ext.getBody().on('click', function(e,t){
if((t.id == 'some-el') && !e.within(t, true)){
alert('Clicked directly on some-el!');
}
});
el : String/HTMLElement/Ext.dom.Element
The id, DOM element or Ext.Element to check
: Boolean (optional)
true to test if the related target is within el instead
of the target
allowEl : Boolean (optional)
true to allow the target to be considered "within" itself.
false to only allow child elements.
Defaults to: true
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.
name : Object
member : Object
privacy : Object
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.
Convert a key specification in the form eg: "CTRL+ALT+DELETE" to the glyph sequence for use in menu items, eg "⌃⌥⌦".
keyName : Object
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
ExtWebComponents | Terms of Use