TreeViewDragDrop.html
12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-tree-plugin-TreeViewDragDrop'>/**
</span> * This plugin provides drag and/or drop functionality for a TreeView.
*
* It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a
* {@link Ext.tree.View TreeView} and loads the data object which is passed to a cooperating
* {@link Ext.dd.DragZone 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 {@link Ext.data.Model Models} representing the selected data being dragged from the source TreeView.
*
* It also creates a specialized instance of {@link 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, {@link #beforedrop} and
* {@link #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' }
* }
*/
Ext.define('Ext.tree.plugin.TreeViewDragDrop', {
extend: 'Ext.AbstractPlugin',
alias: 'plugin.treeviewdragdrop',
uses: [
'Ext.tree.ViewDragZone',
'Ext.tree.ViewDropZone'
],
<span id='Ext-tree-plugin-TreeViewDragDrop-event-beforedrop'> /**
</span> * @event beforedrop
*
* **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.
*
* @param {HTMLElement} node 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.
*
* @param {Object} data The data object gathered at mousedown time by the cooperating
* {@link Ext.dd.DragZone DragZone}'s {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following
* properties:
* @param {Boolean} data.copy 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
* @param {Ext.tree.View} data.view The source TreeView from which the drag originated.
* @param {HTMLElement} data.ddel The drag proxy element which moves with the mouse
* @param {HTMLElement} data.item The TreeView node upon which the mousedown event was registered.
* @param {Ext.data.Model[]} data.records An Array of {@link Ext.data.Model Model}s representing the selected data being
* dragged from the source TreeView.
*
* @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
*
* @param {String} dropPosition `"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.
*
* @param {Object} dropHandler An object containing methods to complete/cancel 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/cancelling
* the drop, such as an {@link Ext.window.MessageBox#confirm confirm} call, or an Ajax request.
*
* Set dropHandler.wait = true in this event handler to delay processing. When you want to complete the event, call
* dropHandler.processDrop(). To cancel the drop, call dropHandler.cancelDrop.
*/
<span id='Ext-tree-plugin-TreeViewDragDrop-event-drop'> /**
</span> * @event drop
*
* **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.
*
* @param {HTMLElement} node The TreeView node **if any** over which the mouse was positioned.
*
* @param {Object} data The data object gathered at mousedown time by the cooperating
* {@link Ext.dd.DragZone DragZone}'s {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following
* properties:
* @param {Boolean} data.copy 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
* @param {Ext.tree.View} data.view The source TreeView from which the drag originated.
* @param {HTMLElement} data.ddel The drag proxy element which moves with the mouse
* @param {HTMLElement} data.item The TreeView node upon which the mousedown event was registered.
* @param {Ext.data.Model[]} data.records An Array of {@link Ext.data.Model Model}s representing the selected data being
* dragged from the source TreeView.
*
* @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
*
* @param {String} dropPosition `"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.
*/
//<locale>
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-dragText'> /**
</span> * @cfg
* The text to show while dragging.
*
* Two placeholders can be used in the text:
*
* - `{0}` The number of selected items.
* - `{1}` 's' when more than 1 items (only useful for English).
*/
dragText : '{0} selected node{1}',
//</locale>
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-allowParentInserts'> /**
</span> * @cfg {Boolean} allowParentInserts
* Allow inserting a dragged node between an expanded parent node and its first child that will become a sibling of
* the parent when dropped.
*/
allowParentInserts: false,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-allowContainerDrops'> /**
</span> * @cfg {Boolean} allowContainerDrops
* True if drops on the tree container (outside of a specific tree node) are allowed.
*/
allowContainerDrops: false,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-appendOnly'> /**
</span> * @cfg {Boolean} appendOnly
* True if the tree should only allow append drops (use for trees which are sorted).
*/
appendOnly: false,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-ddGroup'> /**
</span> * @cfg {String} ddGroup
* 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.
*/
ddGroup : "TreeDD",
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-dragGroup'> /**
</span> * @cfg {String} dragGroup
* 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.
*/
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-dropGroup'> /**
</span> * @cfg {String} dropGroup
* 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.
*/
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-expandDelay'> /**
</span> * @cfg {String} expandDelay
* The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node over the
* target.
*/
expandDelay : 1000,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-enableDrop'> /**
</span> * @cfg {Boolean} enableDrop
* Set to `false` to disallow the View from accepting drop gestures.
*/
enableDrop: true,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-enableDrag'> /**
</span> * @cfg {Boolean} enableDrag
* Set to `false` to disallow dragging items from the View.
*/
enableDrag: true,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-nodeHighlightColor'> /**
</span> * @cfg {String} nodeHighlightColor
* 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 {@link #nodeHighlightOnDrop} and
* {@link #nodeHighlightOnRepair}.
*/
nodeHighlightColor: 'c3daf9',
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-nodeHighlightOnDrop'> /**
</span> * @cfg {Boolean} nodeHighlightOnDrop
* Whether or not to highlight any nodes after they are
* successfully dropped on their target. Defaults to the value of `Ext.enableFx`.
* See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnRepair}.
*/
nodeHighlightOnDrop: Ext.enableFx,
<span id='Ext-tree-plugin-TreeViewDragDrop-cfg-nodeHighlightOnRepair'> /**
</span> * @cfg {Boolean} nodeHighlightOnRepair
* 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 {@link #nodeHighlightColor} and {@link #nodeHighlightOnDrop}.
*/
nodeHighlightOnRepair: Ext.enableFx,
init : function(view) {
view.on('render', this.onViewRender, this, {single: true});
},
<span id='Ext-tree-plugin-TreeViewDragDrop-method-destroy'> /**
</span> * @private
* AbstractComponent calls destroy on all its plugins at destroy time.
*/
destroy: function() {
Ext.destroy(this.dragZone, this.dropZone);
},
onViewRender : function(view) {
var me = this;
if (me.enableDrag) {
me.dragZone = new Ext.tree.ViewDragZone({
view: view,
ddGroup: me.dragGroup || me.ddGroup,
dragText: me.dragText,
repairHighlightColor: me.nodeHighlightColor,
repairHighlight: me.nodeHighlightOnRepair
});
}
if (me.enableDrop) {
me.dropZone = new Ext.tree.ViewDropZone({
view: view,
ddGroup: me.dropGroup || me.ddGroup,
allowContainerDrops: me.allowContainerDrops,
appendOnly: me.appendOnly,
allowParentInserts: me.allowParentInserts,
expandDelay: me.expandDelay,
dropHighlightColor: me.nodeHighlightColor,
dropHighlight: me.nodeHighlightOnDrop
});
}
}
});
</pre>
</body>
</html>