setting.callback.beforeClick.html 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(treeId, treeNode, clickFlag)</span><span class="path">setting.callback.</span>beforeClick
  4. </h2>
  5. <h3>Overview<span class="h3_info">[ depends on <span
  6. class="highlight_green">jquery.ztree.core</span> js ]</span></h3>
  7. <div class="desc">
  8. <p></p>
  9. <div class="longdesc">
  10. <p>Before click callback, return false to prevent the 'onClick' callback.</p>
  11. <p>Default: null</p>
  12. </div>
  13. </div>
  14. <h3>Function Parameter Descriptions</h3>
  15. <div class="desc">
  16. <h4><b>treeId</b><span>String</span></h4>
  17. <p>zTree unique identifier: <b class="highlight_red">treeId</b>.</p>
  18. <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
  19. <p>JSON data object of the node which is clicked</p>
  20. <h4 class="topLine"><b>clickFlag</b><span>Number</span></h4>
  21. <p>Node is selected or deselected state, please see table below for details</p>
  22. <table width="100%" border="0" cellspacing="1" cellpadding="0">
  23. <thead>
  24. <tr>
  25. <td>clickFlag</td>
  26. <td title="Whether to allow multi-select">selectedMulti</td>
  27. <td title="Whether to press Ctrl-key or Cmd-key">autoCancelSelected<br/>&&<br/>event.ctrlKey /
  28. metaKey
  29. </td>
  30. <td title="Node's selection state">isSelected</td>
  31. <td>operate for selected</td>
  32. </tr>
  33. </thead>
  34. <tbody>
  35. <tr>
  36. <td>1</td>
  37. <td>true</td>
  38. <td>false</td>
  39. <td>false</td>
  40. <td>node is selected (single)</td>
  41. </tr>
  42. <tr>
  43. <td>1</td>
  44. <td>true</td>
  45. <td>false</td>
  46. <td>true</td>
  47. <td>node is selected (single)</td>
  48. </tr>
  49. <tr>
  50. <td>2</td>
  51. <td>true</td>
  52. <td>true</td>
  53. <td>false</td>
  54. <td>node is selected (multi)</td>
  55. </tr>
  56. <tr>
  57. <td>0</td>
  58. <td>true</td>
  59. <td>true</td>
  60. <td>true</td>
  61. <td>node is deselected</td>
  62. </tr>
  63. <tr>
  64. <td>1</td>
  65. <td>false</td>
  66. <td>false</td>
  67. <td>false</td>
  68. <td>node is selected (single)</td>
  69. </tr>
  70. <tr>
  71. <td>1</td>
  72. <td>false</td>
  73. <td>false</td>
  74. <td>true</td>
  75. <td>node is selected (single)</td>
  76. </tr>
  77. <tr>
  78. <td>1</td>
  79. <td>false</td>
  80. <td>true</td>
  81. <td>false</td>
  82. <td>node is selected (single)</td>
  83. </tr>
  84. <tr>
  85. <td>0</td>
  86. <td>false</td>
  87. <td>true</td>
  88. <td>true</td>
  89. <td>node is deselected</td>
  90. </tr>
  91. </tbody>
  92. </table>
  93. <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>
  94. <p>return true or false</p>
  95. <p class="highlight_red">If return false, zTree will not change selected state, and will not trigger the
  96. 'onClick' callback.</p>
  97. </div>
  98. <h3>Examples of setting & function</h3>
  99. <h4>1. disabled to click the node</h4>
  100. <pre xmlns=""><code>function myBeforeClick(treeId, treeNode, clickFlag) {
  101. return (treeNode.id !== 1);
  102. };
  103. var setting = {
  104. callback: {
  105. beforeClick: myBeforeClick
  106. }
  107. };
  108. ......</code></pre>
  109. </div>
  110. </div>