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.7.0-CE - Modern Toolkit


top

Ext.data.writer.Xml alias: writer.xml

Hierarchy

Inherited Mixins

Ext.mixin.Factoryable

Summary

This class is used to write Ext.data.Model data to the server in an XML format. The documentRoot property is used to specify the root element in the XML document. The record option is used to specify the element name for each record that will make up the XML document.

No members found using the current filters

configs

Optional Configs

allDataOptions : Object

This object contains the options passed to Ext.data.Model#getData when writing Ext.data.Model#phantom records or when writeAllFields is set to true.

NOTE: The serialize option cannot be used here.

Defaults to:

{
    persist: true
}

getAllDataOptions : Object

Returns the value of allDataOptions

Returns

Object

setAllDataOptions (allDataOptions)

Sets the value of allDataOptions

Parameters

allDataOptions :  Object

clientIdProperty : String

When specified this property causes the Ext.data.Model#idProperty of newly created records to be sent to the server as this name instead of the value of the idProperty.

For example, by default, the following code:

 Ext.define('Person', {
     idProperty: 'id',  // this is the default value (for clarity)

     fields: [ 'name' ]
 });

 var person = new Person({
     // no id provided, so one is generated
     name: 'Clark Kent'
 });

Will send this to the server:

 {
     id: 'Person-1',
     name: 'Clark Kent'
 }

This can be an issue if the server expects an integer for the "id" property. You can use Ext.data.Model#identifier to produce identifiers that the server would recognize or use this config to send the client's id in a different property.

 Ext.define('Person', {
     idProperty: 'id',  // this is the default value (for clarity)

     proxy: {
         writer: {
             clientIdProperty: 'clientId'
         }
     },

     fields: [ 'name' ]
 });

Given the above, the server is sent this data now:

 {
     clientId: 'Person-1',
     name: 'Clark Kent'
 }

While this config provides the behavior of Ext.data.Model#clientIdProperty from previous releases, this property is not as useful as a suitable Ext.data.Model#identifier due to id's appearing in foreign-key fields and in Ext.data.Model#manyToMany associations.

See Ext.data.Model#identifier for more on id generation.

Defaults to:

null

getClientIdProperty : String

Returns the value of clientIdProperty

Returns

String

setClientIdProperty (clientIdProperty)

Sets the value of clientIdProperty

Parameters

clientIdProperty :  String

dateFormat : String

This is used for each field of type date in the model to format the value before it is sent to the server.

Defaults to:

null

getDateFormat : String

Returns the value of dateFormat

Returns

String

setDateFormat (dateFormat)

Sets the value of dateFormat

Parameters

dateFormat :  String

defaultDocumentRoot : String

The root to be used if documentRoot is empty and a root is required to form a valid XML document.

Defaults to:

'xmlData'

getDefaultDocumentRoot : String

Returns the value of defaultDocumentRoot

Returns

String

setDefaultDocumentRoot (defaultDocumentRoot)

Sets the value of defaultDocumentRoot

Parameters

defaultDocumentRoot :  String

documentRoot : String

The name of the root element of the document. Defaults to 'xmlData'. If there is more than 1 record and the root is not specified, the default document root will still be used to ensure a valid XML document is created.

If the record mapping includes a root element name, eg: "SystemInfo>Operation", and the selector includes the root element name, then you must configure this as false

Defaults to:

'xmlData'

getDocumentRoot : String

Returns the value of documentRoot

Returns

String

setDocumentRoot (documentRoot)

Sets the value of documentRoot

Parameters

documentRoot :  String

header : String

A header to use in the XML document (such as setting the encoding or version). Defaults to ''.

Defaults to:

''

getHeader : String

Returns the value of header

Returns

String

setHeader (header)

Sets the value of header

Parameters

header :  String

nameProperty : String

This property is used to read the key for each value that will be sent to the server.

For example:

Ext.define('Person', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'first',
        mapping: 'firstName'
    }, {
        name: 'last',
        mapping: 'lastName'
    }, {
        name: 'age'
    }]
});

new Ext.data.writer.Writer({
    nameProperty: 'mapping'
});

// This will be sent to the server
{
    firstName: 'first name value',
    lastName: 'last name value',
    age: 1
}

If the value is not present, the field name will always be used.

Defaults to:

'name'

getNameProperty : String

Returns the value of nameProperty

Returns

String

setNameProperty (nameProperty)

Sets the value of nameProperty

Parameters

nameProperty :  String

partialDataOptions : Object

This object contains the options passed to Ext.data.Model#getData when writing non Ext.data.Model#phantom records or when writeAllFields is set to false.

NOTE: The serialize option cannot be used here.

Defaults to:

{
    changes: true,
    critical: true
}

getPartialDataOptions : Object

Returns the value of partialDataOptions

Returns

Object

setPartialDataOptions (partialDataOptions)

Sets the value of partialDataOptions

Parameters

partialDataOptions :  Object

record : String

The name of the node to use for each record. Defaults to the owning Ext.data.proxy.Proxy's Ext.data.reader.Xml's Ext.data.reader.Xml#record setting, or 'record'.

Defaults to:

'record'

getRecord : String

Returns the value of record

Returns

String

setRecord (record)

Sets the value of record

Parameters

record :  String

transform : Function / Object

If a transform function is set, it will be invoked just before writeRecords executes. It is passed the unserialized data object and the Ext.data.Request object. The transform function returns a data object, which can be a modified version of the original data object, or a completely new data object. The transform can be a function, or an object with a 'fn' key and an optional 'scope' key. Example usage:

Ext.create('Ext.data.Store', {
    model: 'User',
    proxy: {
        type: 'ajax',
        url : 'users.json',
        writer: {
            type: 'json',
            transform: {
                fn: function(data, request) {
                    // do some manipulation of the unserialized data object
                    return data;
                },
                scope: this
            }
        }
    },
});

Defaults to:

null

getTransform : Function / Object

Returns the value of transform

Returns

Function / Object

setTransform (transform)

Sets the value of transform

Parameters

transform :  Function / Object

writeAllFields : Boolean

true to write all fields from the record to the server. If set to false it will only send the fields that were modified. Note that any fields that have Ext.data.field.Field#persist set to false will still be ignored while those with Ext.data.field.Field#critical set to true will be included.

The exact set of fields written is determined by allDataOptions (when true) or partialDataOptions (when false). This option is ignored and treated as true when writing Ext.data.Model#phantom records.

It is seldom a good idea to use this config. Rather use allDataOptions or partialDataOptions to control what fields are sent for records based on their Ext.data.Model#phantom state.

In the previous release, this was default true.

Defaults to:

false

getWriteAllFields : Boolean

Returns the value of writeAllFields

Returns

Boolean

setWriteAllFields (writeAllFields)

Sets the value of writeAllFields

Parameters

writeAllFields :  Boolean

writeRecordId : Boolean

By default, each record's id is always included in the output for non-phantom records since in most cases the id will be required on the server to process the record action. This is helpful since the id will normally not be modified, and so would not be sent to the server unless writeAllFields was explicitly enabled.

However, there are cases where it is not desirable for the record id to be passed in the data directly. For example, when using a RESTful API the record id would typically be appended to the url instead.

Defaults to:

true

getWriteRecordId : Boolean

Returns the value of writeRecordId

Returns

Boolean

setWriteRecordId (writeRecordId)

Sets the value of writeRecordId

Parameters

writeRecordId :  Boolean

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

factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

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

isWriter : Boolean

true in this class to identify an object as an instantiated Writer, or subclass thereof.

Defaults to:

true

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

constructor ( [config] )

Creates new Writer.

Parameters

config :  Object (optional)

Config object.

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.

destroyMembers ( args )

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.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the object.

getConfig ( [name], [peek], [ifInitialized] ) : 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

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

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.

getRecordData ( record, [operation] ) : Object

Formats the data for each record before sending it to the server. This method should be overridden to format the data in a way that differs from the default.

Parameters

record :  Ext.data.Model

The record that we are writing to the server.

operation :  Ext.data.operation.Operation (optional)

An operation object.

Returns

:Object

An object literal of name/value keys to be written to the server. By default this method returns the data property on the record.

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

objectToElement ( name, o, [output] ) : undefined

Serializes an object to XML. Properties will be serialized as child elements unless their first character is '@'

For example:

myWriter.objectToElement('SystemComponent', {
    "@SystemNumber": '10118795',
    "SystemInfo>SystemName": 'Phase Noise Measurement System',
    AssetId: 'DE3208',
    AgilentModel: 'E5505A',
    SerialNumber: 'US44101357',
}, []).join('');

becomes

<SystemComponent SystemNumber="10118795">
  <SystemInfo>
      <SystemName>Phase Noise Measurement System</SystemName>
  </SystemInfo>
  <AssetId>DE3208</AssetId>
  <AgilentModel>E5505A</AgilentModel>
  <SerialNumber>US44101357</SerialNumber>
</SystemComponent>

Parameters

name :  String

The element name for the object.

o :  Object

The object to serialize.

output :  Array (optional)

The array into which to serialize the object.

Returns

:undefined

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

write ( request ) : Ext.data.Request

Prepares a Proxy's Ext.data.Request object.

Parameters

request :  Ext.data.Request

The request object.

Returns

:Ext.data.Request

The modified request object.

writeRecords ( request, data ) : Ext.data.Request
protected pro

Write the record data to the request in the appropriate format.

Parameters

request :  Ext.data.Request

The request.

data :  Array

An array of objects containing data.

Returns

:Ext.data.Request

The request.

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 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.7.0-CE - Modern Toolkit