Ext JS 4.0.7 Sencha Docs

Ext.tree.plugin.TreeViewDragDrop

Hierarchy

Ext.Base
Ext.AbstractPlugin
Ext.tree.plugin.TreeViewDragDrop

Uses

Files

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

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

  • copy : Boolean

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

  • view : TreeView

    The source TreeView from which the drag originated.

  • ddel : HtmlElement

    The drag proxy element which moves with the mouse

  • item : HtmlElement

    The TreeView node upon which the mousedown event was registered.

  • records : Array

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

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

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

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

viewConfig: {
    plugins: { ptype: 'treeviewdragdrop' }
}

Available since: 4.0.4

Defined By

Config options

Ext.tree.plugin.TreeViewDragDrop
view source
: String

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.

Available since: 4.0.4

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

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

Available since: 4.0.4

Ext.tree.plugin.TreeViewDragDrop
view source
: String
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).

Defaults to: false

Available since: 4.0.4

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 DropZone used by this plugin will only interact with other drag drop objects in the same group.

Defaults to: "TreeDD"

Available since: 4.0.4

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

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.

Available since: 4.0.4

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

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.

Available since: 4.0.4

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.

Defaults to: true

Available since: 4.0.4

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.

Defaults to: true

Available since: 4.0.4

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

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

Defaults to: 1000

Available since: 4.0.4

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). The color must be a 6 digit hex value, without a preceding '#'. See also nodeHighlightOnDrop and nodeHighlightOnRepair.

Defaults to: 'c3daf9'

Available since: 4.0.4

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

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.

Available since: 4.0.4

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

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.

Available since: 4.0.4

Defined By

Properties

Available since: 4.0.0

...

Defaults to: false

Available since: 4.0.0

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, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See 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'

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

Available since: 4.0.0

Methods

Defined By

Instance methods

...

Available since: 4.0.0

Parameters

Returns

...

Available since: 4.0.6

Parameters

Returns

Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

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

        return this;
    }
});

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

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

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

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

Returns

  • Object

    Returns the result after calling the overridden method

Call the parent's overridden method. ...

Call the parent's overridden method. For example:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3'

Available since: 4.0.0

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 from the superclass' method

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.

Available since: 4.0.4

Overrides: Ext.AbstractPlugin.destroy

The base implementation just sets the plugin's disabled flag to true Plugin subclasses which need more complex proce...

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

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

Available since: 4.0.0

The base implementation just sets the plugin's disabled flag to false Plugin subclasses which need more complex proc...

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

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

Available since: 4.0.0

...

Available since: 4.0.0

Ext.tree.plugin.TreeViewDragDrop
view source
( view )
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.

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

Available since: 4.0.4

Parameters

Overrides: Ext.AbstractPlugin.init

( config ) : Objectchainableprotected
Initialize configuration for this class. ...

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

        return this;
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 4.0.0

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

Fires

    ( name, cls )private
    Used internally by the mixins pre-processor ...

    Used internally by the mixins pre-processor

    Available since: 4.0.6

    Parameters

    Fires

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

      Available since: 4.0.4

      Parameters

      ( name, value )private
      ...

      Available since: 4.0.6

      Parameters

      Fires

        ( name, fn )private
        ...

        Available since: 4.0.0

        Parameters

        ( config ) : Ext.Basechainableprivate
        ...

        Available since: 4.0.0

        Parameters

        Returns

        Fires

          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, 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++;
          
                  return this;
              },
          
              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
          

          Available since: 4.0.0

          Returns

          Defined By

          Static methods

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

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

          Available since: 4.0.2

          Parameters

          Returns

          ( fromClass, members ) : Ext.Basechainablestatic
          Borrow another class' members to the prototype of this class. ...

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

          Available since: 4.0.2

          Parameters

          • fromClass : Ext.Base

            The class to borrow members from

          • members : String/String[]

            The names of the members to borrow

          Returns

          Create a new instance of this Class. ...

          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.

          Available since: 4.0.2

          Returns

          ( alias, origin )static
          Create aliases for existing prototype methods. ...

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

          Available since: 4.0.2

          Parameters

          Get the current class' name in string format. ...

          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'
          

          Available since: 4.0.4

          Returns

          Add methods / properties to the prototype of this class. ...

          Add methods / properties to the prototype of this class.

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

          Available since: 4.0.2

          Parameters

          ( members ) : Ext.Basechainablestatic
          Override prototype members of this class. ...

          Override prototype members of this class. Overridden methods can be invoked via callOverridden

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

          Available since: 4.0.2

          Parameters

          Returns

          Defined By

          Events

          Ext.tree.plugin.TreeViewDragDrop
          view source
          ( node, data, overModel, dropPosition, dropFunction, 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 gesture has been triggered by a mouseup event in a valid drop position in the TreeView.

          Available since: 4.0.4

          Parameters

          • node : HTMLElement

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

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

            Returning 0 To this event signals that the data transfer operation should not take place, but that the gesture was valid, and that the repair operation should not take place.

            Any other return value continues with the data transfer operation.

          • data : Object

            The data object gathered at mousedown time by the cooperating DragZone's getDragData method it contains the following properties:

            • copy : Boolean

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

            • view : Ext.tree.View

              The source TreeView from which the drag originated.

            • ddel : HTMLElement

              The drag proxy element which moves with the mouse

            • item : HTMLElement

              The TreeView node upon which the mousedown event was registered.

            • records : Ext.data.Model[]

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

          • overModel : Ext.data.Model

            The Model over which the drop gesture took place.

          • dropPosition : String

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

          • dropFunction : Function

            A function to call to complete the data transfer operation and either move or copy Model instances from the source View's Store to the destination View's Store.

            This is useful when you want to perform some kind of asynchronous processing before confirming the drop, such as an confirm call, or an Ajax request.

            Return 0 from this event handler, and call the dropFunction at any time to perform the data transfer.

          • eOpts : Object

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

          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 has been completed and the data has been moved or copied.

          Available since: 4.0.4

          Parameters

          • node : HTMLElement

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

          • data : Object

            The data object gathered at mousedown time by the cooperating DragZone's getDragData method it contains the following properties:

            • copy : Boolean

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

            • view : Ext.tree.View

              The source TreeView from which the drag originated.

            • ddel : HTMLElement

              The drag proxy element which moves with the mouse

            • item : HTMLElement

              The TreeView node upon which the mousedown event was registered.

            • records : Ext.data.Model[]

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

          • overModel : Ext.data.Model

            The Model over which the drop gesture took place.

          • dropPosition : String

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

          • eOpts : Object

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