setting.callback.beforeDrag.html 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(treeId, treeNodes)</span><span class="path">setting.callback.</span>beforeDrag</h2>
  4. <h3>Overview<span class="h3_info">[ depends on <span
  5. class="highlight_green">jquery.ztree.exedit</span> js ]</span></h3>
  6. <div class="desc">
  7. <p></p>
  8. <div class="longdesc">
  9. <p>Specify callback function to be called before the drag node callback, The return value controls
  10. whether the drag node callback will execute.</p>
  11. <p>Default: null</p>
  12. </div>
  13. </div>
  14. <h3>Function Parameter Descriptions</h3>
  15. <div class="desc">
  16. <h4><b>treeId</b><span>String</span></h4>
  17. <p>zTree unique identifier: <b class="highlight_red">treeId</b>, the id of the containing tree.</p>
  18. <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>
  19. <p>A collection of the nodes being dragged</p>
  20. <p class="highlight_red">v3.x allows the drag and drop of multiple sibling nodes, so this parameter's type
  21. is changed to Array(JSON).</p>
  22. <p class="highlight_red">If the selected nodes aren't sibling nodes, you can only drag one node.</p>
  23. <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>
  24. <p>return true or false</p>
  25. <p class="highlight_red">If return false, zTree will abort the drag and drop, and will not trigger the
  26. 'onDrag / beforeDrop / onDrop' sequence of callbacks.</p>
  27. </div>
  28. <h3>Examples of setting & function</h3>
  29. <h4>1. disable drag completely (by returning false)</h4>
  30. <pre xmlns=""><code>function myBeforeDrag(treeId, treeNodes) {
  31. return false;
  32. };
  33. var setting = {
  34. edit: {
  35. enable: true
  36. },
  37. callback: {
  38. beforeDrag: myBeforeDrag
  39. }
  40. };
  41. ......</code></pre>
  42. </div>
  43. </div>