CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / setting.edit.drag.inner.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>inner</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 child. 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 'prev, next' 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 child.</p>\r
17         <p> false means: don't allow the node to be the target node's child.</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         <p class="highlight_red">If the treeNodes will be root node, the targetNode = null</p>\r
28         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
29         <p>return true or false</p>\r
30         </div>\r
31         <h3>Examples of setting & function</h3>\r
32         <h4>1. disable to drag the node to the target node's inner.</h4>\r
33         <pre xmlns=""><code>var setting = {\r
34         edit: {\r
35                 enable: true,\r
36                 drag: {\r
37                         prev: true,\r
38                         next: true,\r
39                         inner: false\r
40                 }\r
41         }\r
42 };\r
43 ......</code></pre>\r
44         <h4>2. disable to drag the node to be root node's child.</h4>\r
45         <pre xmlns=""><code>function canInner(treeId, nodes, targetNode) {\r
46         return !(targetNode && targetNode.level === 0);\r
47 }\r
48 var setting = {\r
49         edit: {\r
50                 enable: true,\r
51                 drag: {\r
52                         prev: true,\r
53                         next: true,\r
54                         inner: canInner\r
55                 }\r
56         }\r
57 };\r
58 ......</code></pre>\r
59 </div>\r
60 </div>