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

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(treeId, treeNodes)</span><span class="path">setting.callback.</span>beforeDrag</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 drag node, zTree based on return value to determine whether to start to drag node.</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>, the tree is what the treeNodes are belong to, easy for users to control.</p>\r
  16         <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>\r
  17         <p>A collection of the nodes which will be dragged</p>\r
  18         <p class="highlight_red">v3.x allows drag and drop multiple sibling nodes, so this parameter is modified to Array(JSON).</p>\r
  19         <p class="highlight_red">If the selected nodes aren't the sibling nodes, you can only drag one node which mouse over.</p>\r
  20         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
  21         <p>return true or false</p>\r
  22         <p class="highlight_red">If return false, zTree will stop drag, and will not trigger the 'onDrag / beforeDrop / onDrop' callback.</p>\r
  23         </div>\r
  24         <h3>Examples of setting & function</h3>\r
  25         <h4>1. disable to drag all node</h4>\r
  26         <pre xmlns=""><code>function zTreeBeforeDrag(treeId, treeNodes) {\r
  27     return false;\r
  28 };\r
  29 var setting = {\r
  30         edit: {\r
  31                 enable: true\r
  32         },\r
  33         callback: {\r
  34                 beforeDrag: zTreeBeforeDrag\r
  35         }\r
  36 };\r
  37 ......</code></pre>\r
  38 </div>\r
  39 </div>