setting.callback.onRename.html 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(event, treeId, treeNode, isCancel)</span><span class="path">setting.callback.</span>onRename
  4. </h2>
  5. <h3>Overview<span class="h3_info">[ depends on <span
  6. class="highlight_green">jquery.ztree.exedit</span> js ]</span></h3>
  7. <div class="desc">
  8. <p></p>
  9. <div class="longdesc">
  10. <p>Callback for remove node.</p>
  11. <p class="highlight_red">1. If you set 'setting.callback.beforeRename',and return false, zTree will keep
  12. the editing name, and will not trigger the 'onRename' callback.</p>
  13. <p class="highlight_red">2. If you modify treeNode data, and use 'updateNode' function, zTree will not
  14. trigger the 'onRename' callback.</p>
  15. <p class="highlight_red">3. From v3.5.13, zTree will trigger this callback when user cancel edit name.
  16. please see 'isCancel' parameter.</p>
  17. <p>Default: null</p>
  18. </div>
  19. </div>
  20. <h3>Function Parameter Descriptions</h3>
  21. <div class="desc">
  22. <h4><b>event</b><span>js event Object</span></h4>
  23. <p>event Object</p>
  24. <h4 class="topLine"><b>treeId</b><span>String</span></h4>
  25. <p>zTree unique identifier: <b class="highlight_red">treeId</b>.</p>
  26. <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
  27. <p>JSON data object of the node which was rename.</p>
  28. <h4 class="topLine"><b>isCancel</b><span>Boolean</span></h4>
  29. <p>the status about cancel edit name (v3.5.13+)</p>
  30. <p class="highlight_red">isCancel = true means: user cancel edit name. (press ESC or use cancelEditName()
  31. function)</p>
  32. <p class="highlight_red">isCancel = false means: user submit edit name.</p>
  33. </div>
  34. <h3>Examples of setting & function</h3>
  35. <h4>1. When rename node, alert info about 'tId' and 'name'.</h4>
  36. <pre xmlns=""><code>function myOnRename(event, treeId, treeNode, isCancel) {
  37. alert(treeNode.tId + ", " + treeNode.name);
  38. }
  39. var setting = {
  40. callback: {
  41. onRename: myOnRename
  42. }
  43. };
  44. ......</code></pre>
  45. </div>
  46. </div>