openo-portal/portal-common/src/main/webapp/common/thirdparty/zTree/api/en/setting.callback.onRename.html

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(event, treeId, treeNode, isCancel)</span><span class="path">setting.callback.</span>onRename</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 when remove node.</p>\r
   9                         <p class="highlight_red">1. If you set 'setting.callback.beforeRename',and return false, zTree will keep the editing name, and will not trigger the 'onRename' callback.</p>\r
  10                         <p class="highlight_red">2. If you modity treeNode data, and use 'updateNode' function, zTree will not trigger the 'onRename' callback.</p>\r
  11                         <p class="highlight_red">3. From v3.5.13, zTree will trigger this callback when user cancel edit name. please see 'isCancel' parameter.</p>\r
  12                         <p>Default: null</p>\r
  13                 </div>\r
  14         </div>\r
  15         <h3>Function Parameter Descriptions</h3>\r
  16         <div class="desc">\r
  17         <h4><b>event</b><span>js event Object</span></h4>\r
  18         <p>event Object</p>\r
  19         <h4 class="topLine"><b>treeId</b><span>String</span></h4>\r
  20         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>\r
  21         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>\r
  22         <p>JSON data object of the node which was rename.</p>\r
  23         <h4 class="topLine"><b>isCancel</b><span>Boolean</span></h4>\r
  24         <p>the status about cancel edit name (v3.5.13+)</p>\r
  25         <p class="highlight_red">isCancel = true means: user cancel edit name. (press ESC or use cancelEditName() function)</p>\r
  26         <p class="highlight_red">isCancel = false means: user submit edit name.</p>\r
  27         </div>\r
  28         <h3>Examples of setting & function</h3>\r
  29         <h4>1. When rename node, alert info about 'tId' and 'name'.</h4>\r
  30         <pre xmlns=""><code>function zTreeOnRename(event, treeId, treeNode, isCancel) {\r
  31         alert(treeNode.tId + ", " + treeNode.name);\r
  32 }\r
  33 var setting = {\r
  34         callback: {\r
  35                 onRename: zTreeOnRename\r
  36         }\r
  37 };\r
  38 ......</code></pre>\r
  39 </div>\r
  40 </div>