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.6.0 - Classic Toolkit


top

Ext.tree.plugin.TreeViewDragDrop alias: plugin.treeviewdragdrop

Hierarchy

Ext.Base
Ext.plugin.Abstract
Ext.tree.plugin.TreeViewDragDrop

Summary

This plugin provides drag and drop functionality for a Ext.tree.View.

A specialized instance of Ext.dd.DragZone and Ext.dd.DropZone are attached to the tree view. The DropZone will participate in drops from DragZones having the same ddGroup including drops from within the same tree.

During the drop operation a data object is passed to a participating DropZone's drop handlers. The drag data object has the following properties:

  • copy: Boolean
    The value of copy. Or true if allowCopy is true and the control key was pressed as the drag operation began.

  • view: Ext.tree.View
    The source tree view from which the drag originated

  • ddel: HTMLElement
    The drag proxy element which moves with the cursor

  • item: HTMLElement
    The tree view node upon which the mousedown event was registered

  • records: Array
    An Array of Ext.data.Models representing the selected data being dragged from the source tree view.

By adding this plugin to a view, two new events will be fired from the client tree view as well as its owning Tree: beforedrop and drop.

var store = Ext.create('Ext.data.TreeStore', {
    root: {
        expanded: true,
        children: [{
            text: "detention",
            leaf: true
        }, {
            text: "homework",
            expanded: true,
            children: [{
                text: "book report",
                leaf: true
            }, {
                text: "algebra",
                leaf: true
            }]
        }, {
            text: "buy lottery tickets",
            leaf: true
        }]
    }
});

Ext.create('Ext.tree.Panel', {
    title: 'Simple Tree',
    width: 200,
    height: 200,
    store: store,
    rootVisible: false,
    renderTo: document.body,
    viewConfig: {
        plugins: {
            treeviewdragdrop: {
                dragText: 'Drag and drop to reorganize'
            }
        }
    }
});
No members found using the current filters

configs

Optional Configs

allowContainerDrops : Boolean

True if drops on the tree container (outside of a specific tree node) are allowed.

Defaults to:

false

allowCopy : Boolean

Set as true to allow the user to hold down the control key at the start of the drag operation and copy the dragged records between grids. Otherwise, dragged records will be moved.

Note: This only applies to records dragged between two different grids with unique stores.

See copy to enable the copying of all dragged records.

Defaults to:

false

allowParentInserts : Boolean

Allow inserting a dragged node between an expanded parent node and its first child that will become a sibling of the parent when dropped.

Defaults to:

false

appendOnly : Boolean

True if the tree should only allow append drops (use for trees which are sorted).

Defaults to:

false

containerScroll : Object / Boolean

True to register this container with the Scrollmanager for auto scrolling during drag operations. A Ext.dd.ScrollManager configuration may also be passed.

Defaults to:

false

copy : Boolean

Set as true to copy the records from the source grid to the destination drop grid. Otherwise, dragged records will be moved.

Note: This only applies to records dragged between two different grids with unique stores.

See allowCopy to allow only control-drag operations to copy records.

Defaults to:

false

ddGroup : String

A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone used by this plugin will only interact with other drag drop objects in the same group.

Defaults to:

TreeDD

displayField : String

The name of the model field that is used to display the text for the nodes

Defaults to:

text

dragGroup : String

The ddGroup to which the DragZone will belong.

This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones which are members of the same ddGroup.

dragText : String

The text to show while dragging.

Two placeholders can be used in the text:

  • {0} The number of selected items.
  • {1} 's' when more than 1 items (only useful for English).

NOTE: The node's text will be shown when a single node is dragged unless dragText is a simple text string.

Defaults to:

'{0} selected node{1}'

dragZone : Object

A config object to apply to the creation of the DragZone which handles for drag start gestures.

Template methods of the DragZone may be overridden using this config.

dropGroup : String

The ddGroup to which the DropZone will belong.

This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones which are members of the same ddGroup.

dropZone : Object

A config object to apply to the creation of the DropZone which handles mouseover and drop gestures.

Template methods of the DropZone may be overridden using this config.

enableDrag : Boolean

Set to false to disallow dragging items from the View.

Defaults to:

true

enableDrop : Boolean

Set to false to disallow the View from accepting drop gestures.

Defaults to:

true

expandDelay : Number

The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node over the target.

Defaults to:

1000

id : String

An identifier for the plugin that can be set at creation time to later retrieve the plugin using the getPlugin method. For example:

 var panel = Ext.create({
     xtype: 'panel',

     plugins: {
         foobar: {
             id: 'foo',
             ...
         }
     }
 });

 // later on:
 var plugin = panel.getPlugin('foo');

Available since: 6.2.0

nodeHighlightColor : String

The color to use when visually highlighting the dragged or dropped node (default value is light blue). The color must be a 6 digit hex value, without a preceding '#'. See also nodeHighlightOnDrop and nodeHighlightOnRepair.

Defaults to:

c3daf9

nodeHighlightOnDrop : Boolean

Whether or not to highlight any nodes after they are successfully dropped on their target. Defaults to the value of Ext.enableFx. See also nodeHighlightColor and nodeHighlightOnRepair.

Defaults to:

Ext.enableFx

nodeHighlightOnRepair : Boolean

Whether or not to highlight any nodes after they are repaired from an unsuccessful drag/drop. Defaults to the value of Ext.enableFx. See also nodeHighlightColor and nodeHighlightOnDrop.

pluginId : String
deprecated dep

Deprecated since version 6.2.0
Use id instead

sortOnDrop : Boolean

Configure as true to sort the target node into the current tree sort order after the dropped node is added.

Defaults to:

false

stateEvents : String / Array

The configured list of stateEvents used to (optionally) participate in Owner Component's state management.

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

dragZone : Ext.view.DragZone

An Ext.view.DragZone which handles mousedown and dragging of records from the grid.

dropZone : Ext.grid.ViewDropZone

An Ext.grid.ViewDropZone which handles mouseover and dropping records in any grid which shares the same dropGroup.

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

isPlugin : Boolean
readonly ro

The value true to identify objects of this class or a 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

applyState ( state, allState )

The applyState method is invoked by the client Component's State mixin after initComponent method has been run for the client.

The supplied implementation is empty. If plugin Subclasses are to (optionally) participate in the client Component's state management, implementers should provide a suitable method to utilize it.

Parameters

state :  Object

The current plugin state object to be applied.

allState :  Object

The current aggregate state of the Component and all plugins.

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

clonePlugin ( [overrideCfg] )

Creates clone of the plugin.

Parameters

overrideCfg :  Object (optional)

Additional config for the derived plugin.

constructor ( [config] )

Initializes the plugin.

Parameters

config :  Object (optional)

Configuration object.

destroy

The destroy method is invoked by the owning Component at the time the Component is being destroyed.

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.

detachCmp

Plugins that can be disconnected from their host component should implement this method.

Available since: 6.2.0

disable

The base implementation just sets the plugin's disabled flag to true

Plugin subclasses which need more complex processing may implement an overriding implementation.

enable

The base implementation just sets the plugin's disabled flag to false

Plugin subclasses which need more complex processing may implement an overriding implementation.

getCmp Ext.Component

Returns the component to which this plugin is attached.

Returns

:Ext.Component

The owning host component.

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.

getState Object

The getState method is invoked by the client Component's State mixin when one or more of the the specified stateEvents are raised.

The supplied implementation is empty. If plugin Subclasses are to (optionally) participate in the client Component's state management, implementers should provide a suitable method which returns a state object.

Returns

:Object

state

hasConfig ( name )
private pri

Parameters

name :  String

init ( host )

The init method is invoked to formally associate the host component and the plugin.

Subclasses should perform initialization and set up any requires links between the plugin and its host Component in their own implementation of this method.

Parameters

host :  Ext.Component

The host Component which owns this plugin.

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

setCmp ( host )

Sets the host component to which this plugin is attached. For a plugin to be removable without being destroyed, this method should be provided and be prepared to receive null for the component.

Parameters

host :  Ext.Component

The owning host component.

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

events

beforedrop ( node, data, overModel, dropPosition, dropHandlers, eOpts )

This event is fired through the Ext.tree.View and its owning Ext.tree.Panel. You can add listeners to the tree or tree view config object

Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the tree view.

Returning false to this event signals that the drop gesture was invalid and animates the drag proxy back to the point from which the drag began.

The dropHandlers parameter can be used to defer the processing of this event. For example, you can force the handler to wait for the result of a message box confirmation or an asynchronous server call (see the details of the dropHandlers property for more information).

tree.on('beforedrop', function(node, data, overModel, dropPosition, dropHandlers) {
    // Defer the handling
    dropHandlers.wait = true;
    Ext.MessageBox.confirm('Drop', 'Are you sure', function(btn){
        if (btn === 'yes') {
            dropHandlers.processDrop();
        } else {
            dropHandlers.cancelDrop();
        }
    });
});

Any other return value continues with the data transfer operation unless the wait property is set.

Parameters

node :  HTMLElement

The Ext.tree.View node if any over which the cursor was positioned.

data :  Object

The data object gathered at mousedown time by the cooperating Ext.dd.DragZone's getDragData method. It contains the following properties:

copy :  Boolean

The value of copy. Or true if allowCopy is true and the control key was pressed as the drag operation began.

view :  Ext.tree.View

The source tree view from which the drag originated

ddel :  HTMLElement

The drag proxy element which moves with the cursor

item :  HTMLElement

The tree view node upon which the mousedown event was registered

records :  Ext.data.TreeModel[]

An Array of Models representing the selected data being dragged from the source tree view

overModel :  Ext.data.TreeModel

The Model over which the drop gesture took place

dropPosition :  String

"before" or "after" depending on whether the cursor is above or below the mid-line of the node.

dropHandlers :  Object

This parameter allows the developer to control when the drop action takes place. It is useful if any asynchronous processing needs to be completed before performing the drop. This object has the following properties:

wait :  Boolean

Indicates whether the drop should be deferred. Set this property to true to defer the drop.

processDrop :  Function

A function to be called to complete the drop operation.

cancelDrop :  Function

A function to be called to cancel the drop operation.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

drop ( node, data, overModel, dropPosition, eOpts )

This event is fired through the Ext.tree.View and its owning Ext.tree.Panel. You can add listeners to the tree or tree view config object

Fired when a drop operation has been completed and the data has been moved or copied.

Parameters

node :  HTMLElement

The Ext.tree.View node if any over which the cursor was positioned.

data :  Object

The data object gathered at mousedown time by the cooperating Ext.dd.DragZone's getDragData method. It contains the following properties:

copy :  Boolean

The value of copy. Or true if allowCopy is true and the control key was pressed as the drag operation began.

view :  Ext.tree.View

The source tree view from which the drag originated

ddel :  HTMLElement

The drag proxy element which moves with the cursor

item :  HTMLElement

The tree view node upon which the mousedown event was registered

records :  Ext.data.TreeModel[]

An Array of Models representing the selected data being dragged from the source tree view

overModel :  Ext.data.TreeModel

The Model over which the drop gesture took place.

dropPosition :  String

"before" or "after" depending on whether the cursor is above or below the mid-line of the node.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext JS 6.6.0 - Classic Toolkit