Ext.data.JsonP.Ext_tree_plugin_TreeViewDragDrop({"alternateClassNames":[],"aliases":{"plugin":["treeviewdragdrop"]},"enum":null,"parentMixins":[],"tagname":"class","subclasses":[],"extends":"Ext.AbstractPlugin","uses":["Ext.tree.ViewDragZone","Ext.tree.ViewDropZone"],"html":"
Hierarchy
Ext.Base
Ext.AbstractPlugin
Ext.tree.plugin.TreeViewDragDrop
Uses
Ext.tree.ViewDragZone
Ext.tree.ViewDropZone
Files
TreeViewDragDrop.js

This plugin provides drag and/or drop functionality for a TreeView.

\n\n

It creates a specialized instance of DragZone which knows how to drag out of a\nTreeView and loads the data object which is passed to a cooperating\nDragZone's methods with the following properties:

\n\n\n\n\n

It also creates a specialized instance of Ext.dd.DropZone which cooperates with other DropZones which are\nmembers of the same ddGroup which processes such data objects.

\n\n

Adding this plugin to a view means that two new events may be fired from the client TreeView, beforedrop and\ndrop.

\n\n

Note that the plugin must be added to the tree view, not to the tree panel. For example using viewConfig:

\n\n
viewConfig: {\n    plugins: { ptype: 'treeviewdragdrop' }\n}\n
\n
Defined By

Config options

Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
True if drops on the tree container (outside of a specific tree node) are allowed. ...

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

\n

Defaults to: false

Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
Allow inserting a dragged node between an expanded parent node and its first child that will become a sibling of\nthe ...

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

\n

Defaults to: false

Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
True if the tree should only allow append drops (use for trees which are sorted). ...

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

\n

Defaults to: false

Ext.tree.plugin.TreeViewDragDrop
view source
: Object/Boolean
True to register this container with the Scrollmanager for auto scrolling during drag operations. ...

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

\n

Defaults to: false

Ext.tree.plugin.TreeViewDragDrop
view source
: String
A named drag drop group to which this object belongs. ...

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

\n

Defaults to: "TreeDD"

Ext.tree.plugin.TreeViewDragDrop
view source
: String
The name of the model field that is used to display the text for the nodes ...

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

\n

Defaults to: 'text'

Ext.tree.plugin.TreeViewDragDrop
view source
: String
The ddGroup to which the DragZone will belong. ...

The ddGroup to which the DragZone will belong.

\n\n

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

\n
Ext.tree.plugin.TreeViewDragDrop
view source
: String
The text to show while dragging. ...

The text to show while dragging.

\n\n

Two placeholders can be used in the text:

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

Defaults to: '{0} selected node{1}'

Ext.tree.plugin.TreeViewDragDrop
view source
: String
The ddGroup to which the DropZone will belong. ...

The ddGroup to which the DropZone will belong.

\n\n

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

\n
Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
Set to false to disallow dragging items from the View. ...

Set to false to disallow dragging items from the View.

\n

Defaults to: true

Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
Set to false to disallow the View from accepting drop gestures. ...

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

\n

Defaults to: true

Ext.tree.plugin.TreeViewDragDrop
view source
: Number
The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node over the\ntarget. ...

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

\n

Defaults to: 1000

Ext.tree.plugin.TreeViewDragDrop
view source
: String
The color to use when visually highlighting the dragged or dropped node (default value is light blue). ...

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

\n

Defaults to: 'c3daf9'

Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
Whether or not to highlight any nodes after they are\nsuccessfully dropped on their target. ...

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

\n
Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
Whether or not to highlight any nodes after they are\nrepaired from an unsuccessful drag/drop. ...

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

\n
Ext.AbstractPlugin
view source
: String
A name for the plugin that can be set at creation time to then retrieve the plugin\nthrough getPlugin method. ...

A name for the plugin that can be set at creation time to then retrieve the plugin\nthrough getPlugin method. For example:

\n\n
var grid = Ext.create('Ext.grid.Panel', {\n    plugins: [{\n        ptype: 'cellediting',\n        clicksToEdit: 2,\n        pluginId: 'cellplugin'\n    }]\n});\n\n// later on:\nvar plugin = grid.getPlugin('cellplugin');\n
\n
Ext.tree.plugin.TreeViewDragDrop
view source
: Boolean
Configure as true to sort the target node into the current tree sort order after the dropped node is added. ...

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

\n

Defaults to: false

Properties

Defined By

Instance Properties

Ext.Base
view source
: Stringprivate
...
\n

Defaults to: 'Ext.Base'

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.AbstractPlugin
view source
: Booleanprivate
...
\n

Defaults to: false

Ext.Base
view source
: Arrayprivate
...
\n

Defaults to: []

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.Base
view source
: Booleanprivate
...
\n

Defaults to: true

Ext.AbstractPlugin
view source
: Boolean
true in this class to identify an object as an instantiated Plugin, or subclass thereof. ...

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

\n

Defaults to: true

Ext.Base
view source
: Ext.Classprotected
Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n
Defined By

Static Properties

Ext.Base
view source
: Arrayprivatestatic
...
\n

Defaults to: []

Methods

Defined By

Instance Methods

Ext.AbstractPlugin
view source
new( [config] ) : Ext.AbstractPlugin
Instantiates the plugin. ...

Instantiates the plugin.

\n

Parameters

  • config : Object (optional)

    Configuration object.

    \n

Returns

Ext.Base
view source
( args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\n
\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result of calling the overridden method

    \n
Ext.Base
view source
( args ) : Objectprotected
Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n
 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n
\n\n

This can be used with an override as follows:

\n\n
 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n
\n\n

This also works with static methods.

\n\n
 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n
\n\n

Lastly, it also works with overridden static methods.

\n\n
 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n
\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result of calling the parent method

    \n
Ext.Base
view source
( args ) : Objectprotected
This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n
 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n
\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n
 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n
\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result of calling the superclass method

    \n
Ext.AbstractPlugin
view source
( [overrideCfg] )
Creates clone of the plugin. ...

Creates clone of the plugin.

\n

Parameters

  • overrideCfg : Object (optional)

    Additional config for the derived plugin.

    \n
Ext.Base
view source
( )private
...
\n
Ext.tree.plugin.TreeViewDragDrop
view source
( )private
AbstractComponent calls destroy on all its plugins at destroy time. ...

AbstractComponent calls destroy on all its plugins at destroy time.

\n

Overrides: Ext.AbstractPlugin.destroy

Ext.AbstractPlugin
view source
( )
The base implementation just sets the plugin's disabled flag to true\n\nPlugin subclasses which need more complex proce...

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

\n\n

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

\n
Ext.AbstractPlugin
view source
( )
The base implementation just sets the plugin's disabled flag to false\n\nPlugin subclasses which need more complex proc...

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

\n\n

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

\n
Ext.AbstractPlugin
view source
( ) : Ext.Component
Returns the component to which this plugin is attached. ...

Returns the component to which this plugin is attached.

\n

Returns

Ext.Base
view source
( name )private
...
\n

Parameters

Ext.Base
view source
( [name] ) : Object/Mixed
Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

\n

Parameters

  • name : String (optional)

    Name of the config option to return.

    \n

Returns

  • Object/Mixed

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

    \n
Ext.Base
view source
( config )private
...
\n

Parameters

Ext.tree.plugin.TreeViewDragDrop
view source
( client )
The init method is invoked after initComponent method has been run for the client Component. ...

The init method is invoked after initComponent method has been run for the client Component.

\n\n

The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.

\n

Parameters

  • client : Ext.Component

    The client Component which owns this plugin.

    \n\n\n\n

Overrides: Ext.AbstractPlugin.init

Ext.Base
view source
( config ) : Ext.Basechainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

Ext.AbstractPlugin
view source
( cls, data, hooks )private
Private. ...

Private.\nInject a ptype property so that AbstractComponent.findPlugin(ptype) works.

\n

Parameters

Ext.Base
view source
( names, callback, scope )private
...
\n

Parameters

Ext.tree.plugin.TreeViewDragDrop
view source
( view )private
...
\n

Parameters

Ext.AbstractPlugin
view source
( cmp )
Sets the component to which this plugin is attached. ...

Sets the component to which this plugin is attached.

\n

Parameters

Ext.Base
view source
( config, applyIfNotSet ) : Ext.Basechainableprivate
...
\n

Parameters

Returns

Ext.Base
view source
( ) : Ext.Classprotected
Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
\n

Returns

Defined By

Static Methods

Ext.Base
view source
( config )privatestatic
...
\n

Parameters

Ext.Base
view source
( members )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( name, member )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n
Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n

Parameters

Ext.Base
view source
( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n
\n

Parameters

Returns

Ext.Base
view source
( xtype )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( fromClass, members ) : Ext.Basechainableprivatestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n
Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : Array/String

    The names of the members to borrow

    \n

Returns

Ext.Base
view source
( ) : Objectstatic
Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n

Returns

Ext.Base
view source
( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n
Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n

Parameters

Ext.Base
view source
( config )privatestatic
...
\n

Parameters

Ext.Base
view source
( ) : Stringstatic
Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n
Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n

Returns

Ext.Base
view source
( )deprecatedstatic
Adds members to class. ...

Adds members to class.

\n
\n

This method has been deprecated since 4.1

\n

Use addMembers instead.

\n\n
\n
Ext.Base
view source
( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

\n

Parameters

Ext.Base
view source
( fn, scope )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n
Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n
\n\n

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

\n
\n

This method has been deprecated since 4.1.0

\n

Use Ext.define instead

\n\n
\n

Parameters

  • members : Object

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

    \n

Returns

Ext.Base
view source
( )privatestatic
...
\n
Defined By

Events

Ext.tree.plugin.TreeViewDragDrop
view source
( node, data, overModel, dropPosition, dropHandlers, eOpts )
This event is fired through the TreeView. ...

This event is fired through the TreeView. Add listeners to the TreeView object

\n\n

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

\n\n

Returning false to this event signals that the drop gesture was invalid, and if the drag proxy will animate\nback to the point from which the drag began.

\n\n

The dropHandlers parameter can be used to defer the processing of this event. For example to wait for the result of\na message box confirmation or an asynchronous server call. See the details of this property for more information.

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

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

\n

Parameters

  • node : HTMLElement

    The TreeView node if any over which the mouse was positioned.

    \n
  • data : Object

    The data object gathered at mousedown time by the cooperating\nDragZone's getDragData method it contains the following\nproperties:

    \n
    • copy : Boolean

      The value of the TreeView's copy property, or true if the TreeView was configured with\nallowCopy: true and the control key was pressed when the drag operation was begun

      \n
    • view : Ext.tree.View

      The source TreeView from which the drag originated.

      \n
    • ddel : HTMLElement

      The drag proxy element which moves with the mouse

      \n
    • item : HTMLElement

      The TreeView node upon which the mousedown event was registered.

      \n
    • records : Ext.data.Model[]

      An Array of Models representing the selected data being\ndragged from the source TreeView.

      \n
  • overModel : Ext.data.Model

    The Model over which the drop gesture took place.

    \n
  • dropPosition : String

    \"before\", \"after\" or \"append\" depending on whether the mouse is above or below\nthe midline of the node, or the node is a branch node which accepts new child nodes.

    \n
  • dropHandlers : Object

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

    \n
    • wait : Boolean

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

      \n
    • processDrop : Function

      A function to be called to complete the drop operation.

      \n
    • cancelDrop : Function

      A function to be called to cancel the drop operation.

      \n
  • eOpts : Object

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

    \n\n\n\n
Ext.tree.plugin.TreeViewDragDrop
view source
( node, data, overModel, dropPosition, eOpts )
This event is fired through the TreeView. ...

This event is fired through the TreeView. Add listeners to the TreeView object Fired when a drop operation\nhas been completed and the data has been moved or copied.

\n

Parameters

  • node : HTMLElement

    The TreeView node if any over which the mouse was positioned.

    \n
  • data : Object

    The data object gathered at mousedown time by the cooperating\nDragZone's getDragData method it contains the following\nproperties:

    \n
    • copy : Boolean

      The value of the TreeView's copy property, or true if the TreeView was configured with\nallowCopy: true and the control key was pressed when the drag operation was begun

      \n
    • view : Ext.tree.View

      The source TreeView from which the drag originated.

      \n
    • ddel : HTMLElement

      The drag proxy element which moves with the mouse

      \n
    • item : HTMLElement

      The TreeView node upon which the mousedown event was registered.

      \n
    • records : Ext.data.Model[]

      An Array of Models representing the selected data being\ndragged from the source TreeView.

      \n
  • overModel : Ext.data.Model

    The Model over which the drop gesture took place.

    \n
  • dropPosition : String

    \"before\", \"after\" or \"append\" depending on whether the mouse is above or below\nthe midline of the node, or the node is a branch node which accepts new child nodes.

    \n
  • eOpts : Object

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

    \n\n\n\n
","superclasses":["Ext.Base","Ext.AbstractPlugin"],"meta":{},"code_type":"ext_define","requires":[],"html_meta":{},"statics":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"$onExtended","id":"static-property-S-onExtended"}],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"addConfig","id":"static-method-addConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addMember","id":"static-method-addMember"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addMembers","id":"static-method-addMembers"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addXtype","id":"static-method-addXtype"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"borrow","id":"static-method-borrow"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"create","id":"static-method-create"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"extend","id":"static-method-extend"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"getName","id":"static-method-getName"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"}},"name":"implement","id":"static-method-implement"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"mixin","id":"static-method-mixin"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"onExtended","id":"static-method-onExtended"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"markdown":true,"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"}},"name":"override","id":"static-method-override"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"triggerExtended","id":"static-method-triggerExtended"}],"event":[],"css_mixin":[]},"files":[{"href":"TreeViewDragDrop.html#Ext-tree-plugin-TreeViewDragDrop","filename":"TreeViewDragDrop.js"}],"linenr":1,"members":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"$className","id":"property-S-className"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"configMap","id":"property-configMap"},{"tagname":"property","owner":"Ext.AbstractPlugin","meta":{"private":true},"name":"disabled","id":"property-disabled"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigList","id":"property-initConfigList"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigMap","id":"property-initConfigMap"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"isInstance","id":"property-isInstance"},{"tagname":"property","owner":"Ext.AbstractPlugin","meta":{},"name":"isPlugin","id":"property-isPlugin"},{"tagname":"property","owner":"Ext.Base","meta":{"protected":true},"name":"self","id":"property-self"}],"cfg":[{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"allowContainerDrops","id":"cfg-allowContainerDrops"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"allowParentInserts","id":"cfg-allowParentInserts"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"appendOnly","id":"cfg-appendOnly"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"containerScroll","id":"cfg-containerScroll"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"ddGroup","id":"cfg-ddGroup"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"displayField","id":"cfg-displayField"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"dragGroup","id":"cfg-dragGroup"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"dragText","id":"cfg-dragText"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"dropGroup","id":"cfg-dropGroup"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"enableDrag","id":"cfg-enableDrag"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"enableDrop","id":"cfg-enableDrop"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"expandDelay","id":"cfg-expandDelay"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"nodeHighlightColor","id":"cfg-nodeHighlightColor"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"nodeHighlightOnDrop","id":"cfg-nodeHighlightOnDrop"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"nodeHighlightOnRepair","id":"cfg-nodeHighlightOnRepair"},{"tagname":"cfg","owner":"Ext.AbstractPlugin","meta":{},"name":"pluginId","id":"cfg-pluginId"},{"tagname":"cfg","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"sortOnDrop","id":"cfg-sortOnDrop"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true,"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."}},"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callParent","id":"method-callParent"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callSuper","id":"method-callSuper"},{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{},"name":"clonePlugin","id":"method-clonePlugin"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"configClass","id":"method-configClass"},{"tagname":"method","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{"private":true},"name":"destroy","id":"method-destroy"},{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{},"name":"disable","id":"method-disable"},{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{},"name":"enable","id":"method-enable"},{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{},"name":"getCmp","id":"method-getCmp"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"getConfig","id":"method-getConfig"},{"tagname":"method","owner":"Ext.Base","meta":{},"name":"getInitialConfig","id":"method-getInitialConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"hasConfig","id":"method-hasConfig"},{"tagname":"method","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"init","id":"method-init"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"protected":true},"name":"initConfig","id":"method-initConfig"},{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{"private":true},"name":"onClassExtended","id":"method-onClassExtended"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"onConfigUpdate","id":"method-onConfigUpdate"},{"tagname":"method","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{"private":true},"name":"onViewRender","id":"method-onViewRender"},{"tagname":"method","owner":"Ext.AbstractPlugin","meta":{},"name":"setCmp","id":"method-setCmp"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"private":true},"name":"setConfig","id":"method-setConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"statics","id":"method-statics"}],"event":[{"tagname":"event","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"beforedrop","id":"event-beforedrop"},{"tagname":"event","owner":"Ext.tree.plugin.TreeViewDragDrop","meta":{},"name":"drop","id":"event-drop"}],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.tree.plugin.TreeViewDragDrop","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.tree.plugin.TreeViewDragDrop","mixins":[],"mixedInto":[]});