openo-portal/portal-common/src/main/webapp/common/thirdparty/zTree/api/cn/setting.callback.beforeDrop.html

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(treeId, treeNodes, targetNode, moveType, isCopy)</span><span class="path">setting.callback.</span>beforeDrop</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                         <p class="highlight_red">如未拖拽到有效位置，则不触发此回调函数，直接将节点恢复原位置</p>\r
  11                 </div>\r
  12         </div>\r
  13         <h3>Function 参数说明</h3>\r
  14         <div class="desc">\r
  15         <h4><b>treeId</b><span>String</span></h4>\r
  16         <p>目标节点 targetNode 所在 zTree 的 <b class="highlight_red">treeId</b>，便于用户操控</p>\r
  17         <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>\r
  18         <p>被拖拽的节点 JSON 数据集合</p>\r
  19         <p class="highlight_red">无论拖拽操作为 复制 还是 移动，treeNodes 都是当前被拖拽节点的数据集合。</p>\r
  20         <h4 class="topLine"><b>targetNode</b><span>JSON</span></h4>\r
  21         <p>treeNodes 被拖拽放开的目标节点 JSON 数据对象。</p>\r
  22         <p class="highlight_red">如果拖拽成为根节点，则 targetNode = null</p>\r
  23         <h4 class="topLine"><b>moveType</b><span>String</span></h4>\r
  24         <p>指定移动到目标节点的相对位置</p>\r
  25         <p class="highlight_red">"inner"：成为子节点，"prev"：成为同级前一个节点，"next"：成为同级后一个节点</p>\r
  26         <h4 class="topLine"><b>isCopy</b><span>Boolean</span></h4>\r
  27         <p>拖拽节点操作是 复制 或 移动</p>\r
  28         <p class="highlight_red">true：复制；false：移动</p>\r
  29         <h4 class="topLine"><b>返回值</b><span>Boolean</span></h4>\r
  30         <p>返回值是 true / false</p>\r
  31         <p class="highlight_red">如果返回 false，zTree 将恢复被拖拽的节点，也无法触发 onDrop 事件回调函数</p>\r
  32         </div>\r
  33         <h3>setting & function 举例</h3>\r
  34         <h4>1. 禁止将节点拖拽成为根节点</h4>\r
  35         <pre xmlns=""><code>function zTreeBeforeDrop(treeId, treeNodes, targetNode, moveType) {\r
  36     return !(targetNode == null || (moveType != "inner" && !targetNode.parentTId));\r
  37 };\r
  38 var setting = {\r
  39         edit: {\r
  40                 enable: true\r
  41         },\r
  42         callback: {\r
  43                 beforeDrop: zTreeBeforeDrop\r
  44         }\r
  45 };\r
  46 ......</code></pre>\r
  47 </div>\r
  48 </div>