CLIENT GUI Framework
[vnfsdk/refrepo.git] / openo-portal / portal-common / src / main / webapp / common / thirdparty / zTree / api / cn / setting.callback.beforeDrag.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(treeId, treeNodes)</span><span class="path">setting.callback.</span>beforeDrag</h2>\r
4         <h3>概述<span class="h3_info">[ 依赖 <span class="highlight_green">jquery.ztree.exedit</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>被拖拽的节点 treeNodes 所在 zTree 的 <b class="highlight_red">treeId</b>,便于用户操控</p>\r
16         <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>\r
17         <p>要被拖拽的节点 JSON 数据集合</p>\r
18         <p class="highlight_red">v3.x 允许多个同级节点同时被拖拽,因此将此参数修改为 Array(JSON)</p>\r
19         <p class="highlight_red">如果拖拽时多个被选择的节点不是同级关系,则只能拖拽鼠标当前所在位置的节点</p>\r
20         <h4 class="topLine"><b>返回值</b><span>Boolean</span></h4>\r
21         <p>返回值是 true / false</p>\r
22         <p class="highlight_red">如果返回 false,zTree 将终止拖拽,也无法触发 onDrag / beforeDrop / onDrop 事件回调函数</p>\r
23         </div>\r
24         <h3>setting & function 举例</h3>\r
25         <h4>1. 禁止全部拖拽操作</h4>\r
26         <pre xmlns=""><code>function zTreeBeforeDrag(treeId, treeNodes) {\r
27     return false;\r
28 };\r
29 var setting = {\r
30         edit: {\r
31                 enable: true\r
32         },\r
33         callback: {\r
34                 beforeDrag: zTreeBeforeDrag\r
35         }\r
36 };\r
37 ......</code></pre>\r
38 </div>\r
39 </div>