summaryrefslogtreecommitdiffstats
path: root/common/src/main/webapp/thirdparty/zTree/api/en/setting.callback.onDrop.html
blob: 63624631be01640838e15c7671b4c33cbc1b994f (plain)
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
<div class="apiDetail">
<div>
	<h2><span>Function(event, treeId, treeNodes, targetNode, moveType, isCopy)</span><span class="path">setting.callback.</span>onDrop</h2>
	<h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.exedit</span> js ]</span></h3>
	<div class="desc">
		<p></p>
		<div class="longdesc">
			<p>Used to capture the drop event when drag-drop node.</p>
			<p class="highlight_red">If you set 'setting.callback.beforeDrop',and return false, zTree will restore the dragged nodes, and will not trigger the 'onDrop' callback.</p>
			<p>Default: null</p>
		</div>
	</div>
	<h3>Function Parameter Descriptions</h3>
	<div class="desc">
	<h4><b>event</b><span>js event Object</span></h4>
	<p>event Object</p>
	<h4 class="topLine"><b>treeId</b><span>String</span></h4>
	<p>zTree unique identifier: <b class="highlight_red">treeId</b>, the tree is what the targetNode is belong to, easy for users to control.</p>
	<h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>
	<p>A collection of the nodes which has been dragged</p>
	<p class="highlight_red">The treeNodes are the data of the nodes which be dragged, when move nodes.</p>
	<p class="highlight_red">The treeNodes are the clone data of the nodes which be dragged, when copy nodes.</p>
	<h4 class="topLine"><b>targetNode</b><span>JSON</span></h4>
	<p>JSON data object of the target node which treeNodes are drag-dropped.</p>
	<p class="highlight_red">If the treeNodes will be root node, the targetNode = null</p>
	<h4 class="topLine"><b>moveType</b><span>String</span></h4>
	<p>the relative position of move to the target node</p>
	<p class="highlight_red">"inner": will be child of targetNode</p>
	<p class="highlight_red">"prev": will be sibling node, and be in front of targetNode</p>
	<p class="highlight_red">"next":  will be sibling node, and be behind targetNode</p>
	<p class="highlight_red">If moveType is null, means drag & drop is cancel.</p>
	<h4 class="topLine"><b>isCopy</b><span>Boolean</span></h4>
	<p>the flag used to judge copy node or move node</p>
	<p class="highlight_red">true: copy node; false: move node</p>
	</div>
	<h3>Examples of setting & function</h3>
	<h4>1. When drag-drop nodes complete, alert the number of dragged nodes and info about targetNode.</h4>
	<pre xmlns=""><code>function zTreeOnDrop(event, treeId, treeNodes, targetNode, moveType) {
    alert(treeNodes.length + "," + (targetNode ? (targetNode.tId + ", " + targetNode.name) : "isRoot" ));
};
var setting = {
	callback: {
		onDrop: zTreeOnDrop
	}
};
......</code></pre>
</div>
</div>