CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / cn / setting.callback.beforeClick.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(treeId, treeNode, clickFlag)</span><span class="path">setting.callback.</span>beforeClick</h2>\r
4         <h3>概述<span class="h3_info">[ 依赖 <span class="highlight_green">jquery.ztree.core</span> 核心 js ]</span></h3>\r
5         <div class="desc">\r
6                 <p></p>\r
7                 <div class="longdesc">\r
8                         <p>用于捕获单击节点之前的事件回调函数,并且根据返回值确定是否允许单击操作</p>\r
9                         <p>默认值:null</p>\r
10                 </div>\r
11         </div>\r
12         <h3>Function 参数说明</h3>\r
13         <div class="desc">\r
14         <h4><b>treeId</b><span>String</span></h4>\r
15         <p>对应 zTree 的 <b class="highlight_red">treeId</b>,便于用户操控</p>\r
16         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>\r
17         <p>被单击的节点 JSON 数据对象</p>\r
18         <h4 class="topLine"><b>clickFlag</b><span>Number</span></h4>\r
19         <p>节点被点击后的选中操作类型,详细看下表</p>\r
20         <table width="100%" border="0" cellspacing="1" cellpadding="0">\r
21                 <thead><tr><td>clickFlag</td><td title="是否允许多点选中">selectedMulti</td><td title="是否按下 Ctrl 或 Cmd 键">autoCancelSelected<br/>&&<br/>event.ctrlKey / metaKey</td><td title="节点当前选择状态">isSelected</td><td>选中操作</td></tr></thead>\r
22                 <tbody>\r
23                         <tr><td>1</td><td>true</td><td>false</td><td>false</td><td>普通选中</td></tr>\r
24                         <tr><td>1</td><td>true</td><td>false</td><td>true</td><td>普通选中</td></tr>\r
25                         <tr><td>2</td><td>true</td><td>true</td><td>false</td><td>追加选中</td></tr>\r
26                         <tr><td>0</td><td>true</td><td>true</td><td>true</td><td>取消选中</td></tr>\r
27                         <tr><td>1</td><td>false</td><td>false</td><td>false</td><td>普通选中</td></tr>\r
28                         <tr><td>1</td><td>false</td><td>false</td><td>true</td><td>普通选中</td></tr>\r
29                         <tr><td>1</td><td>false</td><td>true</td><td>false</td><td>普通选中</td></tr>\r
30                         <tr><td>0</td><td>false</td><td>true</td><td>true</td><td>取消选中</td></tr>\r
31                 </tbody>\r
32         </table>\r
33         <h4 class="topLine"><b>返回值</b><span>Boolean</span></h4>\r
34         <p>返回值是 true / false</p>\r
35         <p class="highlight_red">如果返回 false,zTree 将不会选中节点,也无法触发 onClick 事件回调函数</p>\r
36         </div>\r
37         <h3>setting & function 举例</h3>\r
38         <h4>1. 禁止节点被选中</h4>\r
39         <pre xmlns=""><code>function zTreeBeforeClick(treeId, treeNode, clickFlag) {\r
40     return (treeNode.id !== 1);\r
41 };\r
42 var setting = {\r
43         callback: {\r
44                 beforeClick: zTreeBeforeClick\r
45         }\r
46 };\r
47 ......</code></pre>\r
48 </div>\r
49 </div>