CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / cn / setting.edit.showRenameBtn.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Boolean / Function(treeId, treeNode)</span><span class="path">setting.edit.</span>showRenameBtn</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>设置是否显示编辑名称按钮。<span class="highlight_red">[setting.edit.enable = true 时生效]</span></p>\r
9                         <p>当点击某节点的编辑名称按钮时:</p>\r
10                         <p>1、进入节点编辑名称状态。</p>\r
11                         <p>2、编辑名称完毕(Input 失去焦点 或 按下 Enter 键),会触发 <span class="highlight_red">setting.callback.beforeRename</span> 回调函数,用户可根据自己的规则判定是否允许修改名称。</p>\r
12                         <p>3、如果 beforeRename 返回 false,则继续保持编辑名称状态,直到名称符合规则位置 (按下 ESC 键可取消编辑名称状态,恢复原名称)。</p>\r
13                         <p>4、如果未设置 beforeRename 或 beforeRename 返回 true,则结束节点编辑名称状态,更新节点名称,并触发 <span class="highlight_red">setting.callback.onRename</span> 回调函数。</p>\r
14                         <p>默认值:true</p>\r
15                 </div>\r
16         </div>\r
17         <h3>Boolean 格式说明</h3>\r
18         <div class="desc">\r
19         <p> true / false 分别表示 显示 / 隐藏 编辑名称按钮</p>\r
20         </div>\r
21         <h3>Function 参数说明</h3>\r
22         <div class="desc">\r
23         <h4><b>treeId</b><span>String</span></h4>\r
24         <p>对应 zTree 的 <b class="highlight_red">treeId</b>,便于用户操控</p>\r
25         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>\r
26         <p>需要设置是否显示编辑名称按钮的节点 JSON 数据对象</p>\r
27         <h4 class="topLine"><b>返回值</b><span>Boolean</span></h4>\r
28         <p>返回值同 Boolean 格式的数据</p>\r
29         </div>\r
30         <h3>setting & function 举例</h3>\r
31         <h4>1. 不显示编辑名称按钮</h4>\r
32         <pre xmlns=""><code>var setting = {\r
33         edit: {\r
34                 enable: true,\r
35                 showRenameBtn: false\r
36         }\r
37 };\r
38 ......</code></pre>\r
39         <h4>2. 设置所有的父节点不显示编辑名称按钮</h4>\r
40         <pre xmlns=""><code>function setRenameBtn(treeId, treeNode) {\r
41         return !treeNode.isParent;\r
42 }\r
43 var setting = {\r
44         edit: {\r
45                 enable: true,\r
46                 showRenameBtn: setRenameBtn\r
47         }\r
48 };\r
49 ......</code></pre>\r
50 </div>\r
51 </div>