aboutsummaryrefslogtreecommitdiffstats
path: root/common/src/main/webapp/thirdparty/zTree/api/en/setting.callback.beforeClick.html
blob: 32ddbf77ccf2ec6db567287e827807c205e74a65 (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
49
<div class="apiDetail">
<div>
	<h2><span>Function(treeId, treeNode, clickFlag)</span><span class="path">setting.callback.</span>beforeClick</h2>
	<h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.core</span> js ]</span></h3>
	<div class="desc">
		<p></p>
		<div class="longdesc">
			<p>Used to capture the event before click node, zTree based on return value to determine whether to trigger the 'onClick' callback.</p>
			<p>Default: null</p>
		</div>
	</div>
	<h3>Function Parameter Descriptions</h3>
	<div class="desc">
	<h4><b>treeId</b><span>String</span></h4>
	<p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>
	<h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
	<p>JSON data object of the node which is clicked</p>
	<h4 class="topLine"><b>clickFlag</b><span>Number</span></h4>
	<p>Node is selected or deselected state, please see table below for details</p>
	<table width="100%" border="0" cellspacing="1" cellpadding="0">
		<thead><tr><td>clickFlag</td><td title="Whether to allow multi-select">selectedMulti</td><td title="Whether to press Ctrl-key or Cmd-key">autoCancelSelected<br/>&&<br/>event.ctrlKey / metaKey</td><td title="Node's selection state">isSelected</td><td>operate for selected</td></tr></thead>
		<tbody>
			<tr><td>1</td><td>true</td><td>false</td><td>false</td><td>node is selected (single)</td></tr>
			<tr><td>1</td><td>true</td><td>false</td><td>true</td><td>node is selected (single)</td></tr>
			<tr><td>2</td><td>true</td><td>true</td><td>false</td><td>node is selected (multi)</td></tr>
			<tr><td>0</td><td>true</td><td>true</td><td>true</td><td>node is deselected</td></tr>
			<tr><td>1</td><td>false</td><td>false</td><td>false</td><td>node is selected (single)</td></tr>
			<tr><td>1</td><td>false</td><td>false</td><td>true</td><td>node is selected (single)</td></tr>
			<tr><td>1</td><td>false</td><td>true</td><td>false</td><td>node is selected (single)</td></tr>
			<tr><td>0</td><td>false</td><td>true</td><td>true</td><td>node is deselected</td></tr>
		</tbody>
	</table>
	<h4 class="topLine"><b>Return </b><span>Boolean</span></h4>
	<p>return true or false</p>
	<p class="highlight_red">If return false, zTree will not change selected state, and will not trigger the 'onClick' callback.</p>
	</div>
	<h3>Examples of setting & function</h3>
	<h4>1. disabled to click the node</h4>
	<pre xmlns=""><code>function zTreeBeforeClick(treeId, treeNode, clickFlag) {
    return (treeNode.id !== 1);
};
var setting = {
	callback: {
		beforeClick: zTreeBeforeClick
	}
};
......</code></pre>
</div>
</div>