CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / setting.callback.beforeEditName.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(treeId, treeNode)</span><span class="path">setting.callback.</span>beforeEditName</h2>\r
4         <h3>Overview<span class="h3_info">[ depends on <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>Used to capture the event before click edit button, zTree based on return value to determine whether to allow to edit the name.</p>\r
9                         <p class="highlight_red">This callback is used to capture the event which edit button is clicked, then trigger the custom editing operation.</p>\r
10                         <p>Default: null</p>\r
11                 </div>\r
12         </div>\r
13         <h3>Function Parameter Descriptions</h3>\r
14         <div class="desc">\r
15         <h4><b>treeId</b><span>String</span></h4>\r
16         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>\r
17         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>\r
18         <p>JSON data object of the node which will be edited name.</p>\r
19         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
20         <p>return true or false</p>\r
21         <p class="highlight_red">If return false, the node will not be able to edit the name.</p>\r
22         </div>\r
23         <h3>Examples of setting & function</h3>\r
24         <h4>1. disable to edit the parent node's name</h4>\r
25         <pre xmlns=""><code>function zTreeBeforeEditName(treeId, treeNode) {\r
26         return !treeNode.isParent;\r
27 }\r
28 var setting = {\r
29         edit: {\r
30                 enable: true\r
31         },\r
32         callback: {\r
33                 beforeEditName: zTreeBeforeEditName\r
34         }\r
35 };\r
36 ......</code></pre>\r
37 </div>\r
38 </div>