docs/source/TreeViewDragDrop.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-tree.ViewDDPlugin'>/**
   2 </span> * @class Ext.tree.ViewDDPlugin
   3  * @extends Ext.AbstractPlugin
   4  * &lt;p&gt;This plugin provides drag and/or drop functionality for a TreeView.&lt;/p&gt;
   5  * &lt;p&gt;It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a {@link Ext.tree.View TreeView}
   6  * and loads the data object which is passed to a cooperating {@link Ext.dd.DragZone DragZone}'s methods with the following properties:&lt;ul&gt;
   7  * &lt;li&gt;copy : Boolean
   8  *  &lt;div class=&quot;sub-desc&quot;&gt;The value of the TreeView's &lt;code&gt;copy&lt;/code&gt; property, or &lt;code&gt;true&lt;/code&gt; if the TreeView was configured
   9  *  with &lt;code&gt;allowCopy: true&lt;/code&gt; &lt;u&gt;and&lt;/u&gt; the control key was pressed when the drag operation was begun.&lt;/div&gt;&lt;/li&gt;
  10  * &lt;li&gt;view : TreeView
  11  *  &lt;div class=&quot;sub-desc&quot;&gt;The source TreeView from which the drag originated.&lt;/div&gt;&lt;/li&gt;
  12  * &lt;li&gt;ddel : HtmlElement
  13  *  &lt;div class=&quot;sub-desc&quot;&gt;The drag proxy element which moves with the mouse&lt;/div&gt;&lt;/li&gt;
  14  * &lt;li&gt;item : HtmlElement
  15  *  &lt;div class=&quot;sub-desc&quot;&gt;The TreeView node upon which the mousedown event was registered.&lt;/div&gt;&lt;/li&gt;
  16  * &lt;li&gt;records : Array
  17  *  &lt;div class=&quot;sub-desc&quot;&gt;An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source TreeView.&lt;/div&gt;&lt;/li&gt;
  18  * &lt;/ul&gt;&lt;/p&gt;
  19  * &lt;p&gt;It also creates a specialized instance of {@link Ext.dd.DropZone} which cooperates with other DropZones which are members of the same
  20  * ddGroup which processes such data objects.&lt;/p&gt;
  21  * &lt;p&gt;Adding this plugin to a view means that two new events may be fired from the client TreeView, &lt;code&gt;{@link #event-beforedrop beforedrop}&lt;/code&gt; and
  22  * &lt;code&gt;{@link #event-drop drop}&lt;/code&gt;&lt;/p&gt;
  23  */
  24 Ext.define('Ext.tree.plugin.TreeViewDragDrop', {
  25     extend: 'Ext.AbstractPlugin',
  26     alias: 'plugin.treeviewdragdrop',
  27
  28     uses: [
  29         'Ext.tree.ViewDragZone',
  30         'Ext.tree.ViewDropZone'
  31     ],
  32
  33 <span id='Ext-tree.ViewDDPlugin-event-beforedrop'>    /**
  34 </span>     * @event beforedrop
  35      * &lt;p&gt;&lt;b&gt;This event is fired through the TreeView. Add listeners to the TreeView object&lt;/b&gt;&lt;/p&gt;
  36      * &lt;p&gt;Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the TreeView.
  37      * @param {HtmlElement} node The TreeView node &lt;b&gt;if any&lt;/b&gt; over which the mouse was positioned.&lt;/p&gt;
  38      * &lt;p&gt;Returning &lt;code&gt;false&lt;/code&gt; to this event signals that the drop gesture was invalid, and if the drag proxy
  39      * will animate back to the point from which the drag began.&lt;/p&gt;
  40      * &lt;p&gt;Returning &lt;code&gt;0&lt;/code&gt; To this event signals that the data transfer operation should not take place, but
  41      * that the gesture was valid, and that the repair operation should not take place.&lt;/p&gt;
  42      * &lt;p&gt;Any other return value continues with the data transfer operation.&lt;/p&gt;
  43      * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
  44      * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:&lt;ul&gt;
  45      * &lt;li&gt;copy : Boolean
  46      *  &lt;div class=&quot;sub-desc&quot;&gt;The value of the TreeView's &lt;code&gt;copy&lt;/code&gt; property, or &lt;code&gt;true&lt;/code&gt; if the TreeView was configured
  47      *  with &lt;code&gt;allowCopy: true&lt;/code&gt; and the control key was pressed when the drag operation was begun&lt;/div&gt;&lt;/li&gt;
  48      * &lt;li&gt;view : TreeView
  49      *  &lt;div class=&quot;sub-desc&quot;&gt;The source TreeView from which the drag originated.&lt;/div&gt;&lt;/li&gt;
  50      * &lt;li&gt;ddel : HtmlElement
  51      *  &lt;div class=&quot;sub-desc&quot;&gt;The drag proxy element which moves with the mouse&lt;/div&gt;&lt;/li&gt;
  52      * &lt;li&gt;item : HtmlElement
  53      *  &lt;div class=&quot;sub-desc&quot;&gt;The TreeView node upon which the mousedown event was registered.&lt;/div&gt;&lt;/li&gt;
  54      * &lt;li&gt;records : Array
  55      *  &lt;div class=&quot;sub-desc&quot;&gt;An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source TreeView.&lt;/div&gt;&lt;/li&gt;
  56      * &lt;/ul&gt;
  57      * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
  58      * @param {String} dropPosition &lt;code&gt;&quot;before&quot;&lt;/code&gt;, &lt;code&gt;&quot;after&quot;&lt;/code&gt; or &lt;code&gt;&quot;append&quot;&lt;/code&gt; depending on whether the mouse is above or below the midline of the node,
  59      * or the node is a branch node which accepts new child nodes.
  60      * @param {Function} dropFunction &lt;p&gt;A function to call to complete the data transfer operation and either move or copy Model instances from the source
  61      * View's Store to the destination View's Store.&lt;/p&gt;
  62      * &lt;p&gt;This is useful when you want to perform some kind of asynchronous processing before confirming
  63      * the drop, such as an {@link Ext.window.MessageBox#confirm confirm} call, or an Ajax request.&lt;/p&gt;
  64      * &lt;p&gt;Return &lt;code&gt;0&lt;/code&gt; from this event handler, and call the &lt;code&gt;dropFunction&lt;/code&gt; at any time to perform the data transfer.&lt;/p&gt;
  65      */
  66
  67 <span id='Ext-tree.ViewDDPlugin-event-drop'>    /**
  68 </span>     * @event drop
  69      * &lt;b&gt;This event is fired through the TreeView. Add listeners to the TreeView object&lt;/b&gt;
  70      * Fired when a drop operation has been completed and the data has been moved or copied.
  71      * @param {HtmlElement} node The TreeView node &lt;b&gt;if any&lt;/b&gt; over which the mouse was positioned.
  72      * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
  73      * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:&lt;ul&gt;
  74      * &lt;li&gt;copy : Boolean
  75      *  &lt;div class=&quot;sub-desc&quot;&gt;The value of the TreeView's &lt;code&gt;copy&lt;/code&gt; property, or &lt;code&gt;true&lt;/code&gt; if the TreeView was configured
  76      *  with &lt;code&gt;allowCopy: true&lt;/code&gt; and the control key was pressed when the drag operation was begun&lt;/div&gt;&lt;/li&gt;
  77      * &lt;li&gt;view : TreeView
  78      *  &lt;div class=&quot;sub-desc&quot;&gt;The source TreeView from which the drag originated.&lt;/div&gt;&lt;/li&gt;
  79      * &lt;li&gt;ddel : HtmlElement
  80      *  &lt;div class=&quot;sub-desc&quot;&gt;The drag proxy element which moves with the mouse&lt;/div&gt;&lt;/li&gt;
  81      * &lt;li&gt;item : HtmlElement
  82      *  &lt;div class=&quot;sub-desc&quot;&gt;The TreeView node upon which the mousedown event was registered.&lt;/div&gt;&lt;/li&gt;
  83      * &lt;li&gt;records : Array
  84      *  &lt;div class=&quot;sub-desc&quot;&gt;An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source TreeView.&lt;/div&gt;&lt;/li&gt;
  85      * &lt;/ul&gt;
  86      * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
  87      * @param {String} dropPosition &lt;code&gt;&quot;before&quot;&lt;/code&gt;, &lt;code&gt;&quot;after&quot;&lt;/code&gt; or &lt;code&gt;&quot;append&quot;&lt;/code&gt; depending on whether the mouse is above or below the midline of the node,
  88      * or the node is a branch node which accepts new child nodes.
  89      */
  90
  91     dragText : '{0} selected node{1}',
  92
  93 <span id='Ext-tree.ViewDDPlugin-cfg-allowParentInsert'>    /**
  94 </span>     * @cfg {Boolean} allowParentInsert
  95      * Allow inserting a dragged node between an expanded parent node and its first child that will become a
  96      * sibling of the parent when dropped (defaults to false)
  97      */
  98     allowParentInserts: false,
  99
 100 <span id='Ext-tree.ViewDDPlugin-cfg-allowContainerDrop'>    /**
 101 </span>     * @cfg {String} allowContainerDrop
 102      * True if drops on the tree container (outside of a specific tree node) are allowed (defaults to false)
 103      */
 104     allowContainerDrops: false,
 105
 106 <span id='Ext-tree.ViewDDPlugin-cfg-appendOnly'>    /**
 107 </span>     * @cfg {String} appendOnly
 108      * True if the tree should only allow append drops (use for trees which are sorted, defaults to false)
 109      */
 110     appendOnly: false,
 111
 112 <span id='Ext-tree.ViewDDPlugin-cfg-ddGroup'>    /**
 113 </span>     * @cfg {String} ddGroup
 114      * A named drag drop group to which this object belongs.  If a group is specified, then both the DragZones and DropZone
 115      * used by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
 116      */
 117     ddGroup : &quot;TreeDD&quot;,
 118
 119 <span id='Ext-tree.ViewDDPlugin-cfg-dragGroup'>    /**
 120 </span>     * @cfg {String} dragGroup
 121      * &lt;p&gt;The ddGroup to which the DragZone will belong.&lt;/p&gt;
 122      * &lt;p&gt;This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones
 123      * which are members of the same ddGroup.&lt;/p&gt;
 124      */
 125
 126 <span id='Ext-tree.ViewDDPlugin-cfg-dropGroup'>    /**
 127 </span>     * @cfg {String} dropGroup
 128      * &lt;p&gt;The ddGroup to which the DropZone will belong.&lt;/p&gt;
 129      * &lt;p&gt;This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones
 130      * which are members of the same ddGroup.&lt;/p&gt;
 131      */
 132
 133 <span id='Ext-tree.ViewDDPlugin-cfg-expandDelay'>    /**
 134 </span>     * @cfg {String} expandDelay
 135      * The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node
 136      * over the target (defaults to 1000)
 137      */
 138     expandDelay : 1000,
 139
 140 <span id='Ext-tree.ViewDDPlugin-cfg-enableDrop'>    /**
 141 </span>     * @cfg {Boolean} enableDrop
 142      * &lt;p&gt;Defaults to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
 143      * &lt;p&gt;Set to &lt;code&gt;false&lt;/code&gt; to disallow the View from accepting drop gestures&lt;/p&gt;
 144      */
 145     enableDrop: true,
 146
 147 <span id='Ext-tree.ViewDDPlugin-cfg-enableDrag'>    /**
 148 </span>     * @cfg {Boolean} enableDrag
 149      * &lt;p&gt;Defaults to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
 150      * &lt;p&gt;Set to &lt;code&gt;false&lt;/code&gt; to disallow dragging items from the View &lt;/p&gt;
 151      */
 152     enableDrag: true,
 153
 154 <span id='Ext-tree.ViewDDPlugin-cfg-nodeHighlightColor'>    /**
 155 </span>     * @cfg {String} nodeHighlightColor The color to use when visually highlighting the dragged
 156      * or dropped node (defaults to 'c3daf9' - light blue). The color must be a 6 digit hex value, without
 157      * a preceding '#'. See also {@link #nodeHighlightOnDrop} and {@link #nodeHighlightOnRepair}.
 158      */
 159     nodeHighlightColor: 'c3daf9',
 160
 161 <span id='Ext-tree.ViewDDPlugin-cfg-nodeHighlightOnDrop'>    /**
 162 </span>     * @cfg {Boolean} nodeHighlightOnDrop Whether or not to highlight any nodes after they are
 163      * successfully dropped on their target. Defaults to the value of `Ext.enableFx`.
 164      * See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnRepair}.
 165      * @markdown
 166      */
 167     nodeHighlightOnDrop: Ext.enableFx,
 168
 169 <span id='Ext-tree.ViewDDPlugin-cfg-nodeHighlightOnRepair'>    /**
 170 </span>     * @cfg {Boolean} nodeHighlightOnRepair Whether or not to highlight any nodes after they are
 171      * repaired from an unsuccessful drag/drop. Defaults to the value of `Ext.enableFx`.
 172      * See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnDrop}.
 173      * @markdown
 174      */
 175     nodeHighlightOnRepair: Ext.enableFx,
 176
 177     init : function(view) {
 178         view.on('render', this.onViewRender, this, {single: true});
 179     },
 180
 181 <span id='Ext-tree.ViewDDPlugin-method-destroy'>    /**
 182 </span>     * @private
 183      * AbstractComponent calls destroy on all its plugins at destroy time.
 184      */
 185     destroy: function() {
 186         Ext.destroy(this.dragZone, this.dropZone);
 187     },
 188
 189     onViewRender : function(view) {
 190         var me = this;
 191
 192         if (me.enableDrag) {
 193             me.dragZone = Ext.create('Ext.tree.ViewDragZone', {
 194                 view: view,
 195                 ddGroup: me.dragGroup || me.ddGroup,
 196                 dragText: me.dragText,
 197                 repairHighlightColor: me.nodeHighlightColor,
 198                 repairHighlight: me.nodeHighlightOnRepair
 199             });
 200         }
 201
 202         if (me.enableDrop) {
 203             me.dropZone = Ext.create('Ext.tree.ViewDropZone', {
 204                 view: view,
 205                 ddGroup: me.dropGroup || me.ddGroup,
 206                 allowContainerDrops: me.allowContainerDrops,
 207                 appendOnly: me.appendOnly,
 208                 allowParentInserts: me.allowParentInserts,
 209                 expandDelay: me.expandDelay,
 210                 dropHighlightColor: me.nodeHighlightColor,
 211                 dropHighlight: me.nodeHighlightOnDrop
 212             });
 213         }
 214     }
 215 });</pre></pre></body></html>