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


top

Summary

This class is used as a set of methods that are applied to the prototype of a Ext.data.Model to decorate it with a Node API. This means that models used in conjunction with a tree will have all of the tree related methods available on the model. In general, this class will not be used directly by the developer.

This class also creates extra fields on the model, if they do not exist, to help maintain the tree state and UI. These fields are documented as config options.

The data fields used to render a tree node are: text, leaf, children, and expanded. Once a node is loaded to the tree store you can use get() to fetch the value of a given field name (provided there is not a convenience accessor on the Node for that field).

The following configs have methods used to set the value / state of the node at runtime:

children / leaf

expanded

The remaining configs may be set using set().

node.set('text', 'Changed Text'); // example showing how to change the node label

The qtip, qtitle, and qshowDelay use QuickTips and requires initializing Ext.tip.QuickTipManager unless the application is created using Ext#method-application.

Ext.tip.QuickTipManager.init();

For additional information and examples see the description for Ext.tree.Panel.

No members found using the current filters

configs

Optional Configs

allowDrag : Boolean

Set to false to deny dragging of this node.

Applicable when using the TreeViewDragDrop plugin.

Defaults to:

true

allowDrop : Boolean

Set to false to deny dropping on this node.

Applicable when using the TreeViewDragDrop plugin.

Defaults to:

true

checked : Boolean

Set to true or false to show a checkbox alongside this node.

To fetch an array of checked nodes use getChecked().

Defaults to:

null

children : Ext.data.NodeInterface[]

Array of child nodes.

Note: By default the child nodes root is children, but can be set using the reader rootProperty config on the Ext.data.TreeStore proxy.

cls : String

CSS class to apply to this node.

depth : Number
private pri

The number of parents this node has. A root node has depth 0, a child of it depth 1, and so on...

See getDepth.

getDepth Number

Returns depth of this node (the root node has a depth of 0)

Returns

:Number

expandable : Boolean

False to prevent expanding/collapsing of this node.

See also: isExpandable.

Defaults to:

true

expanded : Boolean

True if the node is expanded.

When the tree is asynchronously remote loaded, expanding a collapsed node loads the children of that node (if the node has not already been loaded previously).

See also: isExpanded.

Defaults to:

false

glyph : Number / String

A numeric unicode character code to use as the icon. The default font-family for glyphs can be set globally using glyphFontFamily application config or the Ext.setGlyphFontFamily() method. It is initially set to 'Pictos'.

The following shows how to set the glyph using the font icons provided in the SDK (assuming the font-family has been configured globally):

// assumes the glyphFontFamily is "Pictos"
glyph: 'x48'       // the "home" icon (H character)

// assumes the glyphFontFamily is "Pictos"
glyph: 72          // The "home" icon (H character)

// assumes the glyphFontFamily is "Pictos"
glyph: 'H'         // the "home" icon

Alternatively, this config option accepts a string with the charCode and font-family separated by the @ symbol.

// using Font Awesome
glyph: 'xf015@FontAwesome'     // the "home" icon

// using Pictos
glyph: 'H@Pictos'              // the "home" icon

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

Available since: 6.2.0

href : String

A URL for a link that's created when this config is specified.

See also hrefTarget.

hrefTarget : String

Target for link. Only applicable when href is also specified.

icon : String

Path to an image to use as an icon.

For instructions on how you can use icon fonts including those distributed in the SDK see iconCls.

Defaults to:

null

iconCls : String

One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.

An example of specifying a custom icon class would be something like:

// specify the property in the config for the class:
iconCls: 'my-home-icon'

// css rule specifying the background image to be used as the icon image:
.my-home-icon {
    background-image: url(../images/my-home-icon.gif) !important;
}

In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:

// using Font Awesome
iconCls: 'x-fa fa-home'

// using Pictos
iconCls: 'pictos pictos-home'

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

Defaults to:

null

index : Number
private pri

The position of the node inside its parent. When parent has 4 children and the node is third amongst them, index will be 2.

See indexOf and indexOfId.

isFirst : Boolean
private pri

True if this is the first node.

See method-isFirst.

isLast : Boolean
private pri

True if this is the last node.

See method-isLast.

leaf : Boolean

Set to true to indicate that this child can have no children. The expand icon/arrow will then not be rendered for this node.

See also: isLeaf.

Defaults to:

false

loaded : Boolean
private pri

True if the node has finished loading.

See isLoaded.

Defaults to:

false

loading : Boolean
private pri

True if the node is currently loading.

See isLoading.

Defaults to:

false

parentId : String
private pri

ID of parent node.

See parentNode.

qshowDelay : Number

Tooltip showDelay.

See also qtip. See also qtitle.

qtip : String

Tooltip text to show on this node.

See also qtitle. See also qshowDelay.

qtitle : String

Tooltip title.

See also qtip. See also qshowDelay.

root : Boolean
private pri

True if this is the root node.

See isRoot.

text : String

The text to show on node label (html tags are accepted). The default text for the root node is ROOT. All other nodes default to ''.

Note: By default the node label is text, but can be set using the tree's displayField config.

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

childNodes : Ext.data.NodeInterface[]

An array of this nodes children. Array will be empty if this node has no children.

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

firstChild : Ext.data.NodeInterface

A reference to this node's first child node. null if this node has no children.

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

isNode : Boolean

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

Defaults to:

true

lastChild : Ext.data.NodeInterface

A reference to this node's last child node. null if this node has no children.

nextSibling : Ext.data.NodeInterface

A reference to this node's next sibling node. null if this node does not have a next sibling.

parentNode : Ext.data.NodeInterface

A reference to this node's parent node. null if this node is the root node.

previousSibling : Ext.data.NodeInterface

A reference to this node's previous sibling node. null if this node does not have a previous sibling.

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

appendChild ( node, [suppressEvents], [commit] ) : Ext.data.NodeInterface

Inserts node(s) as the last child node of this node.

If the node was previously a child node of another parent node, it will be removed from that node first.

Parameters

node :  Ext.data.NodeInterface/Ext.data.NodeInterface[]/Object

The node or Array of nodes to append

suppressEvents :  Boolean (optional)

True to suppress firing of events.

Defaults to: false

commit :  Boolean (optional)

Defaults to: false

Returns

:Ext.data.NodeInterface

The appended node if single append, or null if an array was passed

bubble ( fn, [scope], [args] )

Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped.

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope (this reference) in which the function is executed. Defaults to the current Node.

args :  Array (optional)

The args to call the function with. Defaults to passing the current Node.

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

cascade ( spec, [scope], [args], [after] )

Cascades down the tree from this node, calling the specified functions with each node. The arguments to the function will be the args provided or the current node. If the before function returns false at any point, the cascade is stopped on that branch.

Note that the 3 argument form passing fn, scope, args is still supported. The fn function is as before, called before cascading down into child nodes. If it returns false, the child nodes are not traversed.

Parameters

spec :  Object/Function

An object containing before and after functions, scope and an argument list or simply the before function.

before :  Function (optional)

A function to call on a node before cascading down into child nodes. If it returns false, the child nodes are not traversed.

after :  Function (optional)

A function to call on a node after cascading down into child nodes.

scope :  Object (optional)

The scope (this reference) in which the functions are executed. Defaults to the current Node.

args :  Array (optional)

The args to call the function with. Defaults to passing the current Node.

scope :  Object (optional)

If spec is the before function instead of an object, this argument is the this pointer.

args :  Array (optional)

If spec is the before function instead of an object, this argument is the args to pass.

after :  Function (optional)

If spec is the before function instead of an object, this argument is the after function to call.

clear ( [erase], [resetChildren] )
private pri

Clears the node.

Parameters

erase :  Boolean (optional)

True to erase the node using the configured proxy.

Defaults to: false

resetChildren :  Boolean (optional)

True to reset child nodes

Defaults to: false

collapse ( [recursive], [callback], [scope] )

Collapse this node.

Parameters

recursive :  Boolean (optional)

True to recursively collapse all the children

Defaults to: false

callback :  Function (optional)

The function to execute once the collapse completes

scope :  Object (optional)

The scope to run the callback in

collapseChildren ( [recursive], [callback], [scope] )

Collapse all the children of this node.

Parameters

recursive :  Function (optional)

True to recursively collapse all the children

Defaults to: false

callback :  Function (optional)

The function to execute once all the children are collapsed

scope :  Object (optional)

The scope to run the callback in

contains ( node ) : Boolean

Returns true if this node is an ancestor (at any point) of the passed node.

Parameters

node :  Ext.data.NodeInterface

Returns

:Boolean

copy ( [newId], [session], [deep] ) : Ext.data.NodeInterface

Creates a copy (clone) of this Node.

Parameters

newId :  String (optional)

A new id, defaults to this Node's id.

session :  Ext.data.session.Session (optional)

The session to which the new record belongs.

deep :  Boolean (optional)

True to recursively copy all child nodes into the new Node. False to copy without child Nodes.

Defaults to: false

Returns

:Ext.data.NodeInterface

A copy of this Node.

createNode ( node ) : Ext.data.NodeInterface

Ensures that the passed object is an instance of a Record with the NodeInterface applied

Parameters

node :  Object

Returns

:Ext.data.NodeInterface

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.

eachChild ( fn, [scope], [args] )

Iterates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops.

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope (this reference) in which the function is executed. Defaults to the Node on which eachChild is called.

args :  Array (optional)

The args to call the function with. Defaults to passing the current Node.

expand ( [recursive], [callback], [scope] )

Expand this node.

Parameters

recursive :  Boolean (optional)

True to recursively expand all the children

Defaults to: false

callback :  Function (optional)

The function to execute once the expand completes

scope :  Object (optional)

The scope to run the callback in

expandChildren ( [recursive], [callback], [scope] )

Expand all the children of this node.

Parameters

recursive :  Boolean (optional)

True to recursively expand all the children

Defaults to: false

callback :  Function (optional)

The function to execute once all the children are expanded

scope :  Object (optional)

The this pointer for the callback.

findChild ( attribute, value, [deep] ) : Ext.data.NodeInterface

Finds the first child that has the attribute with the specified value.

Parameters

attribute :  String

The attribute name

value :  Object

The value to search for

deep :  Boolean (optional)

True to search through nodes deeper than the immediate children

Defaults to: false

Returns

:Ext.data.NodeInterface

The found child or null if none was found

findChildBy ( fn, [scope], [deep] ) : Ext.data.NodeInterface

Finds the first child by a custom function. The child matches if the function passed returns true.

Parameters

fn :  Function

A function which must return true if the passed Node is the required Node.

scope :  Object (optional)

The scope (this reference) in which the function is executed. Defaults to the Node being tested.

deep :  Boolean (optional)

True to search through nodes deeper than the immediate children

Defaults to: false

Returns

:Ext.data.NodeInterface

The found child or null if none was found

fireEvent ( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

getChildAt ( index ) : Ext.data.NodeInterface

Returns the child node at the specified index.

Parameters

index :  Number

Returns

:Ext.data.NodeInterface

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.

getOwnerTree Ext.tree.Panel

Returns the tree this node is in.

Returns

:Ext.tree.Panel

The tree panel which owns this node.

getPath ( [field], [separator] ) : String

Gets the hierarchical path from the root of the current node.

Parameters

field :  String (optional)

The field to construct the path from. Defaults to the model idProperty.

separator :  String (optional)

A separator to use.

Defaults to: '/'

Returns

:String

The node path

getTreeStore Ext.data.TreeStore

Returns the Ext.data.TreeStore which owns this node.

Returns

:Ext.data.TreeStore

The TreeStore which owns this node.

hasChildNodes Boolean

Returns true if this node has one or more child nodes, else false.

Returns

:Boolean

hasConfig ( name )
private pri

Parameters

name :  String

indexOf ( child ) : Number

Returns the index of a child node

Parameters

child :  Ext.data.NodeInterface

Returns

:Number

The index of the child node or -1 if it was not found.

indexOfId ( id ) : Number

Returns the index of a child node that matches the id

Parameters

id :  String

The id of the node to find

Returns

:Number

The index of the node or -1 if it was not found

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

insertBefore ( node, refNode ) : Ext.data.NodeInterface

Inserts the first node before the second node in this nodes childNodes collection.

Parameters

node :  Ext.data.NodeInterface/Ext.data.NodeInterface[]/Object

The node to insert

refNode :  Ext.data.NodeInterface

The node to insert before (if null the node is appended)

Returns

:Ext.data.NodeInterface

The inserted node

insertChild ( index, node ) : Ext.data.NodeInterface

Inserts a node into this node.

Parameters

index :  Number

The zero-based index to insert the node at

node :  Ext.data.NodeInterface/Object

The node to insert

Returns

:Ext.data.NodeInterface

The node you just inserted

isAncestor ( node ) : Boolean

Returns true if the passed node is an ancestor (at any point) of this node.

Parameters

node :  Ext.data.NodeInterface

Returns

:Boolean

isBranchLoaded Boolean

Returns true if this node is a branch node, and the entire branch is fully loaded.

Using this method, it is possible to ascertain whether an expandAll() call (classic toolkit TreePanel method) will have access to all descendant nodes without incurring a store load.

Returns

:Boolean

isExpandable Boolean

Returns true if this node has one or more child nodes, or if the expandable node attribute is explicitly specified as true, otherwise returns false.

Returns

:Boolean

isExpanded Boolean

Returns true if this node is expanded.

Returns

:Boolean

isFirst Boolean

Returns true if this node is the first child of its parent

Returns

:Boolean

isLast Boolean

Returns true if this node is the last child of its parent

Returns

:Boolean

isLastVisible Boolean
private pri

Used by Ext.tree.Column#initTemplateRendererData to determine whether a node is the last visible sibling.

Returns

:Boolean

isLeaf Boolean

Returns true if this node is a leaf

Returns

:Boolean

isLoaded Boolean

Returns true if this node is loaded

Returns

:Boolean

isLoading Boolean

Returns true if this node is loading

Returns

:Boolean

isRoot Boolean

Returns true if this node is the root node

Returns

:Boolean

isVisible Boolean

Returns true if this node is visible. Note that visibility refers to the structure of the tree, the Ext.tree.Panel#rootVisible configuration is not taken into account here. If this method is called on the root node, it will always be visible.

Returns

:Boolean

onChildNodesAvailable ( records, recursive, callback, scope )
private pri

Called as a callback from the Ext.data.TreeStore#onBeforeNodeExpand when the child nodes needed by method-expand have been loaded and appended.

Parameters

records :  Object

recursive :  Object

callback :  Object

scope :  Object

onRegisterTreeNode ( treeStore )
template tpl

Implement this method in a tree record subclass if it needs to track whenever it is registered with a Ext.data.TreeStore.

Parameters

treeStore :  Ext.data.TreeStore

The TreeStore to which the node is being registered.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

onUnregisterTreeNode ( treeStore )
template tpl

Implement this method in a tree record subclass if it needs to track whenever it is unregistered from a Ext.data.TreeStore.

Parameters

treeStore :  Ext.data.TreeStore

The TreeStore from which the node is being unregistered.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

remove ( [erase] ) : Ext.data.NodeInterface
chainable ch

Removes this node from its parent.

If the node is not phantom (only added in the client side), then it may be marked for removal.

If the owning Ext.data.TreeStore is set to track removed then the node will be added to the stack of nodes due to be removed the next time the store is synced with the server.

If the owning Ext.data.TreeStore is set to auto synchronize then the synchronize request will be initiated immediately.

Parameters

erase :  Boolean (optional)

True to erase the node using the configured proxy. This is only needed when the owning Ext.data.TreeStore is not taking care of synchronization operations.

Defaults to: false

Returns

:Ext.data.NodeInterface

this

removeAll ( [erase] ) : Ext.data.NodeInterface
chainable ch

Removes all child nodes from this node.

Parameters

erase :  Boolean (optional)

True to erase the node using the configured proxy.

Defaults to: false

Returns

:Ext.data.NodeInterface

this

removeChild ( node, [erase] ) : Ext.data.NodeInterface

Removes a child node from this node.

Parameters

node :  Ext.data.NodeInterface

The node to remove

erase :  Boolean (optional)

True to erase the record using the configured proxy.

Defaults to: false

Returns

:Ext.data.NodeInterface

The removed node

replaceChild ( newChild, oldChild ) : Ext.data.NodeInterface

Replaces one child node in this node with another.

Parameters

newChild :  Ext.data.NodeInterface

The replacement node

oldChild :  Ext.data.NodeInterface

The node to replace

Returns

:Ext.data.NodeInterface

The replaced node

serialize ( writerParam )

Creates an object representation of this node including its children.

Parameters

writerParam :  Object

setCollapsed ( recursive )
private pri

Sets the node into the collapsed state without affecting the UI.

This is called when a node is collapsed with the recursive flag. All the descendant nodes will have been removed from the store, but descendant non-leaf nodes still need to be set to the collapsed state without affecting the UI.

Parameters

recursive :  Object

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

setFirstChild ( node )
private pri

Sets the first child of this node

Parameters

node :  Ext.data.NodeInterface

setLastChild ( node )
private pri

Sets the last child of this node

Parameters

node :  Ext.data.NodeInterface

sort ( [sortFn], [recursive], [suppressEvent] )

Sorts this nodes children using the supplied sort function.

Parameters

sortFn :  Function (optional)

A function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.

It omitted, the node is sorted according to the existing sorters in the owning Ext.data.TreeStore.

recursive :  Boolean (optional)

True to apply this sort recursively

Defaults to: false

suppressEvent :  Boolean (optional)

True to not fire a sort event.

Defaults to: false

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

updateInfo ( commit, info ) : String[]
protected pro

Updates general data of this node like isFirst, isLast, depth. This method is internally called after a node is moved. This shouldn't have to be called by the developer unless they are creating custom Tree plugins.

Parameters

commit :  Boolean

info :  Object

The info to update. May contain any of the following

isFirst :  Object

isLast :  Object

index :  Object

depth :  Object

parentId :  Object

Returns

:String[]

The names of any persistent fields that were modified.

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

decorate ( modelClass )
static sta

This method decorates a Model class such that it implements the interface of a tree node. That is, it adds a set of methods, events, properties and fields on every record.

Parameters

modelClass :  Ext.Class/Ext.data.Model

The Model class or an instance of the Model class you want to decorate. In either case, this method decorates the class so all instances of that type will have the new capabilities.

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

append ( this, node, index, eOpts )

Fires when a new child node is appended

Parameters

this :  Ext.data.NodeInterface

This node

node :  Ext.data.NodeInterface

The newly appended node

index :  Number

The index of the newly appended node

eOpts : Object

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

beforeappend ( this, node, eOpts )

Fires before a new child is appended, return false to cancel the append.

Parameters

this :  Ext.data.NodeInterface

This node

node :  Ext.data.NodeInterface

The child node to be appended

eOpts : Object

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

beforecollapse ( this, eOpts )

Fires before this node is collapsed.

Parameters

this :  Ext.data.NodeInterface

The collapsing node

eOpts : Object

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

beforeexpand ( this, eOpts )

Fires before this node is expanded.

Parameters

this :  Ext.data.NodeInterface

The expanding node

eOpts : Object

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

beforeinsert ( this, node, refNode, eOpts )

Fires before a new child is inserted, return false to cancel the insert.

Parameters

this :  Ext.data.NodeInterface

This node

node :  Ext.data.NodeInterface

The child node to be inserted

refNode :  Ext.data.NodeInterface

The child node the node is being inserted before

eOpts : Object

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

beforemove ( this, oldParent, newParent, index, eOpts )

Fires before this node is moved to a new location in the tree. Return false to cancel the move.

Parameters

this :  Ext.data.NodeInterface

This node

oldParent :  Ext.data.NodeInterface

The parent of this node

newParent :  Ext.data.NodeInterface

The new parent this node is moving to

index :  Number

The index it is being moved to

eOpts : Object

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

beforeremove ( this, node, isMove, eOpts )

Fires before a child is removed, return false to cancel the remove.

Parameters

this :  Ext.data.NodeInterface

This node

node :  Ext.data.NodeInterface

The child node to be removed

isMove :  Boolean

true if the child node is being removed so it can be moved to another position in the tree. (a side effect of calling appendChild or insertBefore with a node that already has a parentNode)

eOpts : Object

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

collapse ( this, eOpts )

Fires when this node is collapsed.

Parameters

this :  Ext.data.NodeInterface

The collapsing node

eOpts : Object

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

expand ( this, eOpts )

Fires when this node is expanded.

Parameters

this :  Ext.data.NodeInterface

The expanding node

eOpts : Object

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

insert ( this, node, refNode, eOpts )

Fires when a new child node is inserted.

Parameters

this :  Ext.data.NodeInterface

This node

node :  Ext.data.NodeInterface

The child node inserted

refNode :  Ext.data.NodeInterface

The child node the node was inserted before

eOpts : Object

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

move ( this, oldParent, newParent, index, eOpts )

Fires when this node is moved to a new location in the tree

Parameters

this :  Ext.data.NodeInterface

This node

oldParent :  Ext.data.NodeInterface

The old parent of this node

newParent :  Ext.data.NodeInterface

The new parent of this node

index :  Number

The index it was moved to

eOpts : Object

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

remove ( this, node, isMove, context, eOpts )

Fires when a child node is removed

Parameters

this :  Ext.data.NodeInterface

This node

node :  Ext.data.NodeInterface

The removed node

isMove :  Boolean

true if the child node is being removed so it can be moved to another position in the tree.

context :  Object

An object providing information about where the removed node came from. It contains the following properties:

parentNode :  Ext.data.NodeInterface

The node from which the removed node was removed.

previousSibling :  Ext.data.NodeInterface

The removed node's former previous sibling.

nextSibling :  Ext.data.NodeInterface

The removed node's former next sibling. (a side effect of calling appendChild or insertBefore with a node that already has a parentNode)

eOpts : Object

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

sort ( this, childNodes, eOpts )

Fires when this node's childNodes are sorted.

Parameters

this :  Ext.data.NodeInterface

This node.

childNodes :  Ext.data.NodeInterface[]

The childNodes of this node.

eOpts : Object

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

Ext JS 6.6.0 - Modern Toolkit