CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / setting.edit.drag.prev.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Boolean / Function(treeId, treeNodes, targetNode)</span><span class="path">setting.edit.drag.</span>prev</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>When drag one node to the target node, set whether to allow the node to be the target node's previous sibling. It is valid when <span class="highlight_red">[setting.edit.enable = true]</span></p>\r
9                         <p class="highlight_red">If the target node is root, so zTree will only trigger 'inner' and not trigger 'prev / next'.</p>\r
10                         <p class="highlight_red">This function mainly for the appropriate limit drag and drop (auxiliary arrow), it requires a combination of 'next, inner' together, to achieve full functionality.</p>\r
11                         <p>Default: true</p>\r
12                 </div>\r
13         </div>\r
14         <h3>Boolean Format</h3>\r
15         <div class="desc">\r
16         <p> true means: allow the node to be the target node's previous sibling.</p>\r
17         <p> false means: don't allow the node to be the target node's previous sibling.</p>\r
18         </div>\r
19         <h3>Function Parameter Descriptions</h3>\r
20         <div class="desc">\r
21         <h4><b>treeId</b><span>String</span></h4>\r
22         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>\r
23         <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>\r
24         <p>A collection of the nodes which has been dragged</p>\r
25         <h4 class="topLine"><b>targetNode</b><span>JSON</span></h4>\r
26         <p>JSON data object of the target node which treeNodes are draged over.</p>\r
27         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
28         <p>return true or false</p>\r
29         </div>\r
30         <h3>Examples of setting & function</h3>\r
31         <h4>1. disable to drag the node to the target node's previous sibling.</h4>\r
32         <pre xmlns=""><code>var setting = {\r
33         edit: {\r
34                 enable: true,\r
35                 drag: {\r
36                         prev: false,\r
37                         next: true,\r
38                         inner: true\r
39                 }\r
40         }\r
41 };\r
42 ......</code></pre>\r
43         <h4>2. disable to drag the node to be all of the parent nodes's previous sibling.</h4>\r
44         <pre xmlns=""><code>function canPrev(treeId, nodes, targetNode) {\r
45         return !targetNode.isParent;\r
46 }\r
47 var setting = {\r
48         edit: {\r
49                 enable: true,\r
50                 drag: {\r
51                         prev: canPrev,\r
52                         next: true,\r
53                         inner: true\r
54                 }\r
55         }\r
56 };\r
57 ......</code></pre>\r
58 </div>\r
59 </div>