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

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(treeId, treeNode, clickFlag)</span><span class="path">setting.callback.</span>beforeClick</h2>\r
   4         <h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.core</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 node, zTree based on return value to determine whether to trigger the 'onClick' callback.</p>\r
   9                         <p>Default: null</p>\r
  10                 </div>\r
  11         </div>\r
  12         <h3>Function Parameter Descriptions</h3>\r
  13         <div class="desc">\r
  14         <h4><b>treeId</b><span>String</span></h4>\r
  15         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>\r
  16         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>\r
  17         <p>JSON data object of the node which is clicked</p>\r
  18         <h4 class="topLine"><b>clickFlag</b><span>Number</span></h4>\r
  19         <p>Node is selected or deselected state, please see table below for details</p>\r
  20         <table width="100%" border="0" cellspacing="1" cellpadding="0">\r
  21                 <thead><tr><td>clickFlag</td><td title="Whether to allow multi-select">selectedMulti</td><td title="Whether to press Ctrl-key or Cmd-key">autoCancelSelected<br/>&&<br/>event.ctrlKey / metaKey</td><td title="Node's selection state">isSelected</td><td>operate for selected</td></tr></thead>\r
  22                 <tbody>\r
  23                         <tr><td>1</td><td>true</td><td>false</td><td>false</td><td>node is selected (single)</td></tr>\r
  24                         <tr><td>1</td><td>true</td><td>false</td><td>true</td><td>node is selected (single)</td></tr>\r
  25                         <tr><td>2</td><td>true</td><td>true</td><td>false</td><td>node is selected (multi)</td></tr>\r
  26                         <tr><td>0</td><td>true</td><td>true</td><td>true</td><td>node is deselected</td></tr>\r
  27                         <tr><td>1</td><td>false</td><td>false</td><td>false</td><td>node is selected (single)</td></tr>\r
  28                         <tr><td>1</td><td>false</td><td>false</td><td>true</td><td>node is selected (single)</td></tr>\r
  29                         <tr><td>1</td><td>false</td><td>true</td><td>false</td><td>node is selected (single)</td></tr>\r
  30                         <tr><td>0</td><td>false</td><td>true</td><td>true</td><td>node is deselected</td></tr>\r
  31                 </tbody>\r
  32         </table>\r
  33         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
  34         <p>return true or false</p>\r
  35         <p class="highlight_red">If return false, zTree will not change selected state, and will not trigger the 'onClick' callback.</p>\r
  36         </div>\r
  37         <h3>Examples of setting & function</h3>\r
  38         <h4>1. disabled to click the node</h4>\r
  39         <pre xmlns=""><code>function zTreeBeforeClick(treeId, treeNode, clickFlag) {\r
  40     return (treeNode.id !== 1);\r
  41 };\r
  42 var setting = {\r
  43         callback: {\r
  44                 beforeClick: zTreeBeforeClick\r
  45         }\r
  46 };\r
  47 ......</code></pre>\r
  48 </div>\r
  49 </div>