Docs Help

Terms, Icons, and Labels

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.

Access Levels

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.

Member Types

Member Syntax

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).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

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.

Class Icons

- 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

Member Icons

- 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

Class Member Quick-Nav Menu

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.

Getter and Setter Methods

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.

History Bar

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.

Search and Filters

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.

API Doc Class Metadata

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:

Expanding and Collapsing Examples and Class Members

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.

Desktop -vs- Mobile View

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:

Viewing the Class Source

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.

Ext JS 6.2.1 - Modern Toolkit


top

Ext.dom.Query singleton

Hierarchy

Ext.Base
Ext.dom.Query

Summary

Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in).

DomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.

All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example div.foo:nth-child(odd)[@foo=bar].bar:first would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure.

Simple Selectors

For performance reasons, some query methods accept selectors that are termed as simple selectors. A simple selector is a selector that does not include contextual information about any parent/sibling elements.

Some examples of valid simple selectors:

var simple = '.foo'; // Only asking for the class name on the element
var simple = 'div.bar'; // Only asking for the tag/class name on the element
var simple = '[href];' // Asking for an attribute on the element.
var simple = ':not(.foo)'; // Only asking for the non-matches against the class name
var simple = 'span:first-child'; // Doesn't require any contextual information about the parent node

Simple examples of invalid simple selectors:

var notSimple = 'div.foo div.bar'; // Requires matching a parent node by class name
var notSimple = 'span + div'; //  Requires matching a sibling by tag name

Element Selectors:

  • * any element
  • E an element with the tag E
  • E F All descendent elements of E that have the tag F
  • E > F or E/F all direct children elements of E that have the tag F
  • E + F all elements with the tag F that are immediately preceded by an element with the tag E
  • E ~ F all elements with the tag F that are preceded by a sibling element with the tag E

Attribute Selectors:

The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.

  • E[foo] has an attribute "foo"
  • E[foo=bar] has an attribute "foo" that equals "bar"
  • E[foo^=bar] has an attribute "foo" that starts with "bar"
  • E[foo$=bar] has an attribute "foo" that ends with "bar"
  • E[foo*=bar] has an attribute "foo" that contains the substring "bar"
  • E[foo%=2] has an attribute "foo" that is evenly divisible by 2
  • E[foo!=bar] attribute "foo" does not equal "bar"

Pseudo Classes:

  • E:first-child E is the first child of its parent
  • E:last-child E is the last child of its parent
  • E:nth-child(_n_) E is the _n_th child of its parent (1 based as per the spec)
  • E:nth-child(odd) E is an odd child of its parent
  • E:nth-child(even) E is an even child of its parent
  • E:only-child E is the only child of its parent
  • E:checked E is an element that is has a checked attribute that is true (e.g. a radio or checkbox)
  • E:first the first E in the resultset
  • E:last the last E in the resultset
  • E:nth(_n_) the _n_th E in the resultset (1 based)
  • E:odd shortcut for :nth-child(odd)
  • E:even shortcut for :nth-child(even)
  • E:contains(foo) E's innerHTML contains the substring "foo"
  • E:nodeValue(foo) E contains a textNode with a nodeValue that equals "foo"
  • E:not(S) an E element that does not match simple selector S
  • E:has(S) an E element that has a descendent that matches simple selector S
  • E:next(S) an E element whose next sibling matches simple selector S
  • E:prev(S) an E element whose previous sibling matches simple selector S
  • E:any(S1|S2|S2) an E element which matches any of the simple selectors S1, S2 or S3
  • E:visible(true) an E element which is deeply visible according to Ext.dom.Element#isVisible

CSS Value Selectors:

  • E{display=none} css value "display" that equals "none"
  • E{display^=none} css value "display" that starts with "none"
  • E{display$=none} css value "display" that ends with "none"
  • E{display*=none} css value "display" that contains the substring "none"
  • E{display%=2} css value "display" that is evenly divisible by 2
  • E{display!=none} css value "display" that does not equal "none"

XML Namespaces:

  • ns|E an element with tag E and namespace prefix ns
No members found using the current filters

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

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

$configStrict : Boolean
private pri

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

clearPropertiesOnDestroy : Boolean / "async"
protected pro

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

clearPrototypeOnDestroy : Boolean
private pri

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

destroyed : Boolean
protected pro

This property is set to true after the destroy method is called.

Defaults to:

false

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

matchers

Collection of matching regular expressions and code snippets. Each capture group within () will be replace the {} in the select statement as specified by their index.

Defaults to:

[
    {
        re: /^\.([\w\-\\]+)/,
        select: useClassList ? 'n = byClassName(n, "{1}");' : 'n = byClassName(n, " {1} ");'
    },
    {
        re: /^\:([\w\-]+)(?:\(((?:[^\s>\/]*|.*?))\))?/,
        select: 'n = byPseudo(n, "{1}", "{2}");'
    },
    {
        re: /^(?:([\[\{])(?:@)?([\w\-]+)\s?(?:(=|.=)\s?['"]?(.*?)["']?)?[\]\}])/,
        select: 'n = byAttribute(n, "{2}", "{4}", "{3}", "{1}");'
    },
    {
        re: /^#([\w\-\\]+)/,
        select: 'n = byId(n, "{1}");'
    },
    {
        re: /^@([\w\-\.]+)/,
        select: 'return {firstChild:{nodeValue:attrValue(n, "{1}")}};'
    }
]

operators : Object

Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.

New operators can be added as long as the match the format c= where c is any character other than space, >, or <.

Operator functions are passed the following parameters:

  • propValue : The property value to test.
  • compareTo : The value to compare to.

pseudos

Object hash of "pseudo class" filter functions which are used when filtering selections. Each function is passed two parameters:

  • c : Array An Array of DOM elements to filter.

  • v : String The argument (if any) supplied in the selector.

A filter function returns an Array of DOM elements which conform to the pseudo class. In addition to the provided pseudo classes listed above such as first-child and nth-child, developers may add additional, custom psuedo class filters to select elements according to application-specific requirements.

For example, to filter a elements to only return links to external resources:

Ext.DomQuery.pseudos.external = function(c, v) {
    var r = [], ri = -1;
    for(var i = 0, ci; ci = c[i]; i++) {
        // Include in result set only if it's a link to an external resource
        if (ci.hostname != location.hostname) {
            r[++ri] = ci;
        }
    }
    return r;
};

Then external links could be gathered with the following statement:

var externalLinks = Ext.select("a:external");

Defaults to:

{
    "first-child": function(c) {
        var r = [],
            ri = -1,
            n, i, ci;
        for (i = 0; (ci = n = c[i]); i++) {
            while ((n = n.previousSibling) && n.nodeType != 1){}
            if (!n) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "last-child": function(c) {
        var r = [],
            ri = -1,
            n, i, ci;
        for (i = 0; (ci = n = c[i]); i++) {
            while ((n = n.nextSibling) && n.nodeType != 1){}
            if (!n) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "nth-child": function(c, a) {
        var r = [],
            ri = -1,
            m = nthRe.exec(a == "even" && "2n" || a == "odd" && "2n+1" || !nthRe2.test(a) && "n+" + a || a),
            f = (m[1] || 1) - 0,
            l = m[2] - 0,
            i, n, j, cn, pn;
        for (i = 0; n = c[i]; i++) {
            pn = n.parentNode;
            if (batch != pn._batch) {
                j = 0;
                for (cn = pn.firstChild; cn; cn = cn.nextSibling) {
                    if (cn.nodeType == 1) {
                        cn.nodeIndex = ++j;
                    }
                }
                pn._batch = batch;
            }
            if (f == 1) {
                if (l === 0 || n.nodeIndex == l) {
                    r[++ri] = n;
                }
            } else if ((n.nodeIndex + l) % f === 0) {
                r[++ri] = n;
            }
        }
        return r;
    },
    "only-child": function(c) {
        var r = [],
            ri = -1,
            i, ci;
        for (i = 0; ci = c[i]; i++) {
            if (!prev(ci) && !next(ci)) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "empty": function(c) {
        var r = [],
            ri = -1,
            i, ci, cns, j, cn, empty;
        for (i = 0; ci = c[i]; i++) {
            cns = ci.childNodes;
            j = 0;
            empty = true;
            while (cn = cns[j]) {
                ++j;
                if (cn.nodeType == 1 || cn.nodeType == 3) {
                    empty = false;
                    break;
                }
            }
            if (empty) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "contains": function(c, v) {
        var r = [],
            ri = -1,
            i, ci;
        for (i = 0; ci = c[i]; i++) {
            if ((ci.textContent || ci.innerText || ci.text || '').indexOf(v) != -1) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "nodeValue": function(c, v) {
        var r = [],
            ri = -1,
            i, ci;
        for (i = 0; ci = c[i]; i++) {
            if (ci.firstChild && ci.firstChild.nodeValue == v) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "checked": function(c) {
        var r = [],
            ri = -1,
            i, ci;
        for (i = 0; ci = c[i]; i++) {
            if (ci.checked === true) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "not": function(c, ss) {
        return DQ.filter(c, ss, true);
    },
    "any": function(c, selectors) {
        var ss = selectors.split('|'),
            r = [],
            ri = -1,
            s, i, ci, j;
        for (i = 0; ci = c[i]; i++) {
            for (j = 0; s = ss[j]; j++) {
                if (DQ.is(ci, s)) {
                    r[++ri] = ci;
                    break;
                }
            }
        }
        return r;
    },
    "odd": function(c) {
        return this["nth-child"](c, "odd");
    },
    "even": function(c) {
        return this["nth-child"](c, "even");
    },
    "nth": function(c, a) {
        return c[a - 1] || [];
    },
    "first": function(c) {
        return c[0] || [];
    },
    "last": function(c) {
        return c[c.length - 1] || [];
    },
    "has": function(c, ss) {
        var s = DQ.select,
            r = [],
            ri = -1,
            i, ci;
        for (i = 0; ci = c[i]; i++) {
            if (s(ss, ci).length > 0) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "next": function(c, ss) {
        var is = DQ.is,
            r = [],
            ri = -1,
            i, ci, n;
        for (i = 0; ci = c[i]; i++) {
            n = next(ci);
            if (n && is(n, ss)) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    "prev": function(c, ss) {
        var is = DQ.is,
            r = [],
            ri = -1,
            i, ci, n;
        for (i = 0; ci = c[i]; i++) {
            n = prev(ci);
            if (n && is(n, ss)) {
                r[++ri] = ci;
            }
        }
        return r;
    },
    focusable: function(candidates) {
        var len = candidates.length,
            results = [],
            i = 0,
            c;
        for (; i < len; i++) {
            c = candidates[i];
            if (Ext.fly(c, '_DomQuery').isFocusable()) {
                results.push(c);
            }
        }
        return results;
    },
    visible: function(candidates, deep) {
        var len = candidates.length,
            results = [],
            i = 0,
            c;
        for (; i < len; i++) {
            c = candidates[i];
            if (Ext.fly(c, '_DomQuery').isVisible(deep)) {
                results.push(c);
            }
        }
        return results;
    },
    isScrolled: function(c) {
        var r = [],
            ri = -1,
            i, ci, s;
        for (i = 0; ci = c[i]; i++) {
            s = Ext.fly(ci, '_DomQuery').getScroll();
            if (s.top > 0 || s.left > 0) {
                r[++ri] = ci;
            }
        }
        return r;
    }
}

self : Ext.Class
protected pro

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

callOverridden ( args ) : Object
deprecated dep protected pro

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"

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

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.

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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".

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

:Object

Returns the result of calling the superclass method

compile ( selector, [type] ) : Function

Compiles a selector/xpath query into a reusable function. The returned function takes one parameter "root" (optional), which is the context node from where the query should start.

Parameters

selector :  String

The selector/xpath query

type :  String (optional)

Either "select" or "simple" for a simple selector match

Defaults to: "select"

Returns

:Function

destroy

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.

filter ( el, selector, nonMatches ) : HTMLElement[]

Filters an array of elements to only include matches of a simple selector

Parameters

el :  HTMLElement[]

An array of elements to filter

selector :  String

The simple selector to test

nonMatches :  Boolean

If true, it returns the elements that DON'T match the selector instead of the ones that match

Returns

:HTMLElement[]

An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned.

getConfig ( [name], [peek] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

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

Returns

:Object

The config property value.

getInitialConfig ( [name] ) : Object/Mixed

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'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

The full config object or a single config value when name parameter specified.

getNodeValue ( node, [defaultValue] ) : String

Get the text value for a node, optionally replacing null with the defaultValue.

Parameters

node :  Object

The node

defaultValue :  String (optional)

When specified, this is return as empty value.

Returns

:String

The value

hasConfig ( name )
private pri

Parameters

name :  String

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

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'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

is ( el, selector ) : Boolean

Returns true if the passed element(s) match the passed simple selector

Parameters

el :  String/HTMLElement/HTMLElement[]

An element id, element or array of elements

selector :  String

The simple selector to test

Returns

:Boolean

jsSelect ( selector, [root] ) : HTMLElement[]

Selects an array of DOM nodes using JavaScript-only implementation.

Use select to take advantage of browsers built-in support for CSS selectors.

Parameters

selector :  String

The selector/xpath query (can be a comma separated list of selectors)

root :  HTMLElement/String (optional)

The start of the query.

Defaults to: document

Returns

:HTMLElement[]

An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned.

select ( path, [root], [type], [single] ) : HTMLElement[]

Selects an array of DOM nodes by CSS/XPath selector.

Uses document.querySelectorAll if browser supports that, otherwise falls back to Ext.dom.Query#jsSelect to do the work.

Parameters

path :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

type :  String (optional)

Either "select" or "simple" for a simple selector match (only valid when used when the call is deferred to the jsSelect method)

Defaults to: "select"

single :  Boolean (optional)

Pass true to select only the first matching node using document.querySelector (where available)

Returns

:HTMLElement[]

An array of DOM elements (not a NodeList as returned by querySelectorAll).

selectNode ( selector, [root] ) : HTMLElement

Selects a single element.

Parameters

selector :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

Returns

:HTMLElement

The DOM element which matched the selector.

selectNumber ( selector, [root], [defaultValue] ) : Number

Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.

Parameters

selector :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

defaultValue :  Number (optional)

When specified, this is return as empty value.

Returns

:Number

selectValue ( selector, [root], [defaultValue] ) : String

Selects the value of a node, optionally replacing null with the defaultValue.

Parameters

selector :  String

The selector/xpath query

root :  HTMLElement (optional)

The start of the query.

Defaults to: document

defaultValue :  String (optional)

When specified, this is return as empty value.

Returns

:String

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

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.

Returns

:Ext.Base

this

statics Ext.Class
protected pro

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

Returns

:Ext.Class
Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

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.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

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();

Parameters

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

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

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() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

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 '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

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.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

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()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

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'

Returns

:String

className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

Ext JS 6.2.1 - Modern Toolkit