CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / zTreeObj.updateNode.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(treeNode, checkTypeFlag)</span><span class="path">zTreeObj.</span>updateNode</h2>\r
4         <h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.core</span> js ]</span></h3>\r
5         <div class="desc">\r
6                 <p></p>\r
7                 <div class="longdesc">\r
8                         <p>Update node data. Primarily used to update the node's DOM.</p>\r
9                         <p class="highlight_red">1. Can update the attributes for display (e.g. 'name', 'target', 'url', 'icon', 'iconSkin', 'checked', 'nocheck'), do not update the other attributes. For example: If you need to expand the node, please use expandNode() method, do not modify the 'open' attribute.</p>\r
10                         <p class="highlight_red">2. Use updateNode() method of zTree can't trigger 'beforeCheck' or 'onCheck' callback function.</p>\r
11                         <p class="highlight_red">Please use zTree object to executing the method.</p>\r
12                 </div>\r
13         </div>\r
14         <h3>Function Parameter Descriptions</h3>\r
15         <div class="desc">\r
16         <h4><b>treeNode</b><span>JSON</span></h4>\r
17         <p>JSON data object of the node which need to update.</p>\r
18         <p class="highlight_red">Please ensure that this data object is an internal node data object in zTree.</p>\r
19         <h4 class="topLine"><b>checkTypeFlag</b><span>Boolean</span></h4>\r
20         <p>checkTypeFlag = true means: According to 'setting.check.chkboxType' attribute automatically check or uncheck the parent and child nodes.</p>\r
21         <p>checkTypeFlag = false means: only check or uncheck this node, don't affect its parent and child nodes.</p>\r
22         <p class="highlight_red">This parameter is valid when 'setting.check.enable = true' and 'setting.check.chkStyle = "checkbox"'</p>\r
23         <p class="highlight_red">Don't affect the parent and child nodes which 'nochecked' attribute is true.</p>\r
24         <h4 class="topLine"><b>Return </b><span>none</span></h4>\r
25         <p>no return value</p>\r
26         </div>\r
27         <h3>Examples of function</h3>\r
28         <h4>1. Modify the first selected node's name, and update it.</h4>\r
29         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
30 var nodes = treeObj.getNodes();\r
31 if (nodes.length>0) {\r
32         nodes[0].name = "test";\r
33         treeObj.updateNode(nodes[0]);\r
34 }\r
35 </code></pre>\r
36 </div>\r
37 </div>