setting.callback.beforeRename.html 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(treeId, treeNode, newName, isCancel)</span><span class="path">setting.callback.</span>beforeRename
  4. </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>用于捕获节点编辑名称结束(Input 失去焦点 或 按下 Enter 键)之后,更新节点名称数据之前的事件回调函数,并且根据返回值确定是否允许更改名称的操作</p>
  10. <p class="highlight_red">节点进入编辑名称状态后,按 ESC 键可以放弃当前修改,恢复原名称,取消编辑名称状态</p>
  11. <p class="highlight_red">从 v3.5.13 开始,取消编辑状态也会触发此回调,根据 isCancel 参数判断</p>
  12. <p>默认值:null</p>
  13. </div>
  14. </div>
  15. <h3>Function 参数说明</h3>
  16. <div class="desc">
  17. <h4><b>treeId</b><span>String</span></h4>
  18. <p>对应 zTree 的 <b class="highlight_red">treeId</b>,便于用户操控</p>
  19. <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
  20. <p>将要更改名称的节点 JSON 数据对象</p>
  21. <h4 class="topLine"><b>newName</b><span>String</span></h4>
  22. <p>修改后的新名称</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. <h4 class="topLine"><b>返回值</b><span>Boolean</span></h4>
  28. <p>返回值是 true / false</p>
  29. <p class="highlight_red">如果返回 false,zTree 将保持名称编辑状态,无法触发 onRename 事件回调函数,并且会导致屏蔽其它事件,直到修改名称使得 beforeRename
  30. 返回 true</p>
  31. <p class="highlight_red">如果返回 false,不会让 input 输入框获取焦点,避免由于警告信息而导致反复触发 beforeRename。 请在关闭提示警告信息后,利用 editName
  32. 方法让 input 重新获取焦点。</p>
  33. </div>
  34. <h3>setting & function 举例</h3>
  35. <h4>1. 禁止修改的名称的长度小于 5</h4>
  36. <pre xmlns=""><code>function zTreeBeforeRename(treeId, treeNode, newName, isCancel) {
  37. return newName.length > 5;
  38. }
  39. var setting = {
  40. edit: {
  41. enable: true
  42. },
  43. callback: {
  44. beforeRename: zTreeBeforeRename
  45. }
  46. };
  47. ......</code></pre>
  48. </div>
  49. </div>