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.
Enables reactive actions to handle changes in the hash by using the routes configuration in a controller. An example configuration would be:
Ext.define('MyApp.view.main.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.app-main',
routes: {
'user/:{id}': 'onUser'
},
onUser: function (values) {
var id = values.id;
// ...
}
});
The routes object can also receive an object to further configure
the route, for example you can configure a before action that will
be executed before the action or can cancel the route execution:
Ext.define('MyApp.view.main.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.app-main',
routes: {
'user/:{id}': {
action: 'onUser',
before: 'onBeforeUser',
name: 'user'
}
},
onBeforeUser: function (values) {
return Ext.Ajax
.request({
url: '/check/permission',
params: {
route: 'user',
meta: {
id: values.id
}
}
});
},
onUser: function (values) {
var id = values.id;
// ...
}
});
URL Parameters in a route can also define a type that will be used when matching hashes when finding routes that recognize a hash and also parses the value into numbers:
Ext.define('MyApp.view.main.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.app-main',
routes: {
'user/:{id:num}': {
action: 'onUser',
before: 'onBeforeUser',
name: 'user'
}
},
onBeforeUser: function (values) {
return Ext.Ajax
.request({
url: '/check/permission',
params: {
route: 'user',
meta: {
id: values.id
}
}
});
},
onUser: function (values) {
var id = values.id;
// ...
}
});
In this example, the id parameter added :num to the parameter which
will now mean the route will only recognize a value for the id parameter
that is a number such as #user/123 and will not recognize #user/abc.
The id passed to the action and before handlers will also get cast into
a number instead of a string. If a type is not provided, it will use
the default matcher.
For more on types, see the types config.
For backwards compatibility, there is positional mode which is like
named mode but how you define the url parameters and how they are passed
to the action and before handlers is slightly different:
Ext.define('MyApp.view.main.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.app-main',
routes: {
'user/:id:action': {
action: 'onUser',
before: 'onBeforeUser',
name: 'user',
conditions: {
':action': '(edit|delete)?'
}
}
},
onBeforeUser: function (id, action) {
return Ext.Ajax
.request({
url: '/check/permission',
params: {
route: 'user',
meta: {
action: action,
id: id
}
}
});
},
onUser: function (id) {
// ...
}
});
The parameters are defined without curly braces (:id, :action) and
they are passed as individual arguments to the action and before handlers.
It's important to note you cannot mix positional and named parameter formats in the same route since how they are passed to the handlers is different.
Routes can define sections of a route pattern that are optional by surrounding
the section that is to be optional with parenthesis. For example, if a route
should match both #user and #user/1234 to either show a grid of all users
or details or a single user, you can define the route such as:
Ext.define('MyApp.view.main.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.app-main',
routes: {
'user(/:{id:num})': {
action: 'onUser',
name: 'user'
}
},
onUser: function (params) {
if (params.id) {
// load user details
} else {
// load grid of users
}
}
});
true to allow this route to be triggered on
a controller that is not active.
Defaults to:
false
true to allow the tokens to be matched with
case-insensitive.
Defaults to:
false
Sets the value of caseInsensitive
caseInsensitive : Boolean
Optional set of conditions for each token in the url string. Each key should be one of the tokens, each value should be a regex that the token should accept.
For positional mode, if you have a route with a url like 'files/:fileName' and
you want it to match urls like files/someImage.jpg then you can set these
conditions to allow the :fileName token to accept strings containing a period:
conditions: {
':fileName': '([0-9a-zA-Z\.]+)'
}
For named mode, if you have a route with a url like 'files/:{fileName}'
and you want it to match urls like files/someImage.jpg then you can set these
conditions to allow the :{fileName} token to accept strings containing a period:
conditions: {
'fileName': '([0-9a-zA-Z\.]+)'
}
You can also define a condition to parse the value or even split it on a character:
conditions: {
'fileName': {
re: '([0-9a-zA-Z\.]+)',
split: '.', // split the value so you get an array ['someImage', 'jpg']
parse: function (values) {
return values[0]; // return a string without the extension
}
}
}
Defaults to:
{}
The array of connected handlers to this route. Each handler must defined a
scope and can define an action, before and/or exit handler:
handlers: [{
action: function() {
//...
},
scope: {}
}, {
action: function() {
//...
},
before: function() {
//...
},
scope: {}
}, {
exit: function() {
//...
},
scope: {}
}]
The action, before and exit handlers can be a string that will be resolved
from the scope:
handlers: [{
action: 'onAction',
before: 'onBefore',
exit: 'onExit',
scope: {
onAction: function () {
//...
},
onBefore: function () {
//...
},
onExit: function () {
//...
}
}
}]
Defaults to:
[]
The name of this route. The name can be used when using Ext.route.Mixin#redirectTo.
Defaults to:
null
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
The default RegExp string to use to match parameters with.
Defaults to:
'([%a-zA-Z0-9\\-\\_\\s,]+)'
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 mode based on the url pattern this route is configured with. Valid values are:
positional The url was configured with the parameter format
as :param. The values in the handler functions will be individual arguments.
Example:
Ext.define('MyApp.view.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.myapp-main',
routes: {
'view/:view/:child': {
action: 'onView',
before: 'onBeforeView',
name: 'view'
}
},
onBeforeView: function (view, child) {
return Ext.Ajax.request({
url: 'check/permission',
params: {
view: view,
info: { childView: child }
}
});
},
onView: function (view, child) {}
});
The values from the matched url that the view route would execute with are
separate arguments in the before and action handlers.
named The url was configured with the parameter format as
:{param:type} where the :type is optional. Example:
Ext.define('MyApp.view.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.myapp-main',
routes: {
'view/:{view}/:{child:alphanum}': {
action: 'onView',
before: 'onBeforeView',
name: 'view'
}
},
onBeforeView: function (values) {
return Ext.Ajax.request({
url: 'check/permission',
params: {
view: values.view,
info: { childView: values.child }
}
});
},
onView: function (values) {}
});
The values from the matched url the view route would execute with are collected
into an object with the parameter name as the key and the associated value as
the value. See types for more about this named mode.
Available since: 6.6.0
A regular expression to match against float numbers for
alphanum, num and ... types in order to cast into floats.
Defaults to:
/^[0-9]*(?:\.[0-9]*)?$/
Available since: 6.6.0
A regular expression to find groups intended to be optional values within the
hash. This means that if they are in the hash they will match and return the
values present. But, if they are not and the rest of the hash matches, the route
will still execute passing undefined as the values of any parameters
within an optional group.
routes: {
'user(\/:{id:num})': {
action: 'onUser',
name: 'user'
}
}
In this example, the id parameter and the slash will be optional since they
are wrapped in the parentheses. This route would execute if the hash is #user
or #user/1234.
Defaults to:
/\((.+?)\)/g
Available since: 6.6.0
A regular expression to check if there are parameters in the configured url.
Defaults to:
/:([0-9A-Za-z_]+)/g
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
A regular expression to determine if the parameter may contain type information. If a parameter does have type information, the url parameters sent to the Ext.route.Handler#before and Ext.route.Handler#after will be in an object instead of separate arguments.
Defaults to:
/:{([0-9A-Za-z_]+)(?::?([0-9A-Za-z_]+|.{3})?)}/g
Available since: 6.6.0
An object of types that will be used to match and parse values from a matched url. There are four default types:
alpha This will only match values that have only alpha characters using
the regex ([a-zA-Z]+).alphanum This will only match values that have alpha and numeric characters
using the regex ([a-zA-Z0-9]+|[0-9]*(?:\\.[0-9]*)?). If a value is a number,
which a number can have a period (10.4), the value will be case into a float
using parseFloat.num This will only match values that have numeric characters using the regex
([0-9]*(?:\\.[0-9]*)?). The value, which can have a period (10.4), will be
case into a float using parseFloat.... This is meant to be the last argument in the url and will match all
characters using the regex (.+)?. If a value is matched, this is an optional
type, the value will be split by / and an array will be sent to the handler
methods. If no value was matched, the value will be undefined.When defining routes, a type is optional and will use the default matcher but the url parameter must be enclosed in curly braces which will send a single object to the route handlers:
Ext.define('MyApp.view.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.myapp-main',
routes: {
'view/:{view}/:{child:alphanum}:{args...}': {
action: 'onView',
before: 'onBeforeView',
name: 'view'
}
},
onBeforeView: function (values) {
return Ext.Ajax.request({
url: 'check/permission',
params: {
view: values.view,
info: { childView: values.child }
}
});
},
onView: function (values) {}
});
In this example, there are 3 parameters defined. The :{view} parameter has no
type which will match characters using the default matcher
but is required to be in the matched url. The :{child:alphanum} will only match
characters that are alpha or numeric but is required to be in the matched url. The
:{args...} is the only optional parameter in this route but can match any
character and will be an array of values split by / unless there are no values
in which case undefined will be sent in the object.
If the hash is #view/user/edit, the values argument sent to the handlers would be:
{
view: 'user',
child: 'edit',
args: undefined
}
Since there were no more values for the args parameter, it's value is undefined.
If the hash is #view/user/1234, the values argument sent to the handlers would be:
{
view: 'user',
child: 1234,
args: undefined
}
Notice the child value is a number instead of a string.
If the hash is #view/user/1234/edit/settings, the values argument sent to the
handlers would be:
{
view: 'user',
child: 1234,
args: ['edit', 'settings']
}
The args parameter matched the edit/settings and split it by the / producing
the array.
To add custom types, you can override Ext.route.Route:
Ext.define('Override.route.Route', {
override: 'Ext.route.Route',
config: {
types: {
uuid: {
re: '([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})'
}
}
}
});
You can now use the uuid type in your routes:
Ext.define('MyApp.view.MainController', {
extend: 'Ext.app.ViewController',
alias: 'controller.myapp-main',
routes: {
'user/:{userid:uuid}': {
action: 'onUser',
caseInsensitive: true,
name: 'user'
}
},
onUser: function (values) {}
});
This would match if the hash was like #user/C56A4180-65AA-42EC-A945-5FD21DEC0538
and the values object would then be:
{
user: 'C56A4180-65AA-42EC-A945-5FD21DEC0538'
}
Available since: 6.6.0
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
Adds a handler to the handlers stack.
handler : Object
An object to describe the handler. A handler should define a fn and scope.
If the fn is a String, the function will be resolved from the scope.
this
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
Takes the configured url string including wildcards and returns a regex that can be used to match against a url.
This is only used in positional mode.
url : String
The url string.
The matcher regex.
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.
The method to execute the action using the configured before function which will kick off the actual actions on the controller.
token : String
The token this route is being executed with.
argConfig : Object
The object from the Ext.route.Routes recognize method call.
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.
Returns an object of url parameters with parameter name as the object key and the value.
Available since: 6.6.0
url : String
The url the route is executing on.
Returns an array of url parameters values in order they appear in the url.
Available since: 6.6.0
url : String
The url the route is executing on.
Returns the url parameters matched in the given url.
Available since: 6.6.0
url : String
The url this route is executing on.
If mode is named,
an object from getNamedUrlParams will be returned.
If is positional, an array from getPositionalUrlParams
will be returned.
Handles a pattern that will enable named mode.
Available since: 6.6.0
url : String
The url pattern.
Handles a pattern that will enable positional mode.
Available since: 6.6.0
url : String
The url pattern.
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
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.
Returns a hash of matching url segments for the given url.
url : String
The url to extract matches for
matching url segments
When a route is exited (no longer recognizes a token in the current hash) we need to clear all last tokens and execute any exit handlers.
Available since: 6.6.0
Parses the value from the url with a type or a matching conditions.
Available since: 6.6.0
value : String
The value from the url.
type : Object (optional)
The type object that will be used to parse the value.
Attempts to recognize a given url string and return a meta data object including any URL parameter matches.
url : String
The url to recognize.
The matched data, or false if no match.
Returns true if this Ext.route.Route matches the given url string.
url : String
The url to test.
true if this Ext.route.Route recognizes the url.
Removes a handler from the handlers stack. This normally happens when destroying a class instance.
scope : Object/Ext.Base
The class instance to match handlers with.
handler : Ext.route.Handler (optional)
An optional Ext.route.Handler to only remove from the array of handlers. If no handler is passed, all handlers will be removed.
this
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
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
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.
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