setting.callback.beforeDrop.html 2.6 KB

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