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

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(treeId, treeNodes, targetNode, moveType, isCopy)</span><span class="path">setting.callback.</span>beforeDrop</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-drop node, zTree based on return value to determine whether to allow drag-drop node.</p>\r
   9                         <p>Default: null</p>\r
  10                         <p class="highlight_red">When drop the nodes, if the dragged nodes is not in a valid location, this callback will not triggered, and will restore the original position.</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>, the tree is what the targetNode is belong to, easy for users to control.</p>\r
  17         <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>\r
  18         <p>A collection of the nodes which has been dragged</p>\r
  19         <p class="highlight_red">The treeNodes are the data of the nodes which has been dragged, when copy nodes or move nodes.</p>\r
  20         <h4 class="topLine"><b>targetNode</b><span>JSON</span></h4>\r
  21         <p>JSON data object of the target node which treeNodes are drag-dropped.</p>\r
  22         <p class="highlight_red">If the treeNodes will be root node, the targetNode = null</p>\r
  23         <h4 class="topLine"><b>moveType</b><span>String</span></h4>\r
  24         <p>the relative position of move to the target node</p>\r
  25         <p class="highlight_red">"inner": will be child of targetNode</p>\r
  26         <p class="highlight_red">"prev": will be sibling node, and be in front of targetNode</p>\r
  27         <p class="highlight_red">"next":  will be sibling node, and be behind targetNode</p>\r
  28         <h4 class="topLine"><b>isCopy</b><span>Boolean</span></h4>\r
  29         <p>the flag used to judge copy node or move node</p>\r
  30         <p class="highlight_red">true: copy node; false: move node</p>\r
  31         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
  32         <p>return true or false</p>\r
  33         <p class="highlight_red">If return false, zTree will restore the dragged nodes, and will not trigger the 'onDrop' callback.</p>\r
  34         </div>\r
  35         <h3>Examples of setting & function</h3>\r
  36         <h4>1. disable to drag nodes to root</h4>\r
  37         <pre xmlns=""><code>function zTreeBeforeDrop(treeId, treeNodes, targetNode, moveType) {\r
  38     return !(targetNode == null || (moveType != "inner" && !targetNode.parentTId));\r
  39 };\r
  40 var setting = {\r
  41         edit: {\r
  42                 enable: true\r
  43         },\r
  44         callback: {\r
  45                 beforeDrop: zTreeBeforeDrop\r
  46         }\r
  47 };\r
  48 ......</code></pre>\r
  49 </div>\r
  50 </div>