openo-portal/portal-common/src/main/webapp/common/thirdparty/zTree/api/cn/setting.callback.beforeRename.html

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