setting.callback.onRename.html 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(event, treeId, treeNode, isCancel)</span><span class="path">setting.callback.</span>onRename</h2>
  4. <h3>概述<span class="h3_info">[ 依赖 <span class="highlight_green">jquery.ztree.exedit</span> 扩展 js ]</span></h3>
  5. <div class="desc">
  6. <p></p>
  7. <div class="longdesc">
  8. <p>用于捕获节点编辑名称结束之后的事件回调函数。</p>
  9. <p>1、节点进入编辑名称状态,并且修改节点名称后触发此回调函数。<span class="highlight_red">如果用户设置了 beforeRename 回调函数,并返回 false,将无法触发 onRename 事件回调函数。</span></p>
  10. <p>2、<span class="highlight_red">如果通过直接修改 treeNode 的数据,并且利用 updateNode 方法更新,是不会触发此回调函数的。</span></p>
  11. <p class="highlight_red">3、从 v3.5.13 开始,取消编辑状态也会触发此回调,根据 isCancel 参数判断</p>
  12. <p>默认值:null</p>
  13. </div>
  14. </div>
  15. <h3>Function 参数说明</h3>
  16. <div class="desc">
  17. <h4><b>event</b><span>js event 对象</span></h4>
  18. <p>标准的 js event 对象</p>
  19. <h4 class="topLine"><b>treeId</b><span>String</span></h4>
  20. <p>对应 zTree 的 <b class="highlight_red">treeId</b>,便于用户操控</p>
  21. <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
  22. <p>被修改名称的节点 JSON 数据对象</p>
  23. <h4 class="topLine"><b>isCancel</b><span>Boolean</span></h4>
  24. <p>是否取消操作 (v3.5.13+)</p>
  25. <p class="highlight_red">isCancel = true 表示取消编辑操作(按下 ESC 或 使用 cancelEditName 方法)</p>
  26. <p class="highlight_red">isCancel = false 表示确认修改操作</p>
  27. </div>
  28. <h3>setting & function 举例</h3>
  29. <h4>1. 修改名称后,弹出被修改名称的节点的 tId 以及 name 信息</h4>
  30. <pre xmlns=""><code>function zTreeOnRename(event, treeId, treeNode, isCancel) {
  31. alert(treeNode.tId + ", " + treeNode.name);
  32. }
  33. var setting = {
  34. callback: {
  35. onRename: zTreeOnRename
  36. }
  37. };
  38. ......</code></pre>
  39. </div>
  40. </div>