Jquery-zTree的基本用法

【简介】

zTree 是利用 JQuery 的核心代码，实现一套能完成大部分常用功能的 Tree 插件

• 兼容 IE、FireFox、Chrome 等浏览器
• 在一个页面内可同时生成多个 Tree 实例
• 支持 JSON 数据
• 支持一次性静态生成 和 Ajax 异步加载 两种方式
• 支持多种事件响应及反馈
• 支持 Tree 的节点移动、编辑、删除
• 支持任意更换皮肤 / 个性化图标（依靠css）
• 支持极其灵活的 checkbox 或 radio 选择功能
• 简单的参数配置实现 灵活多变的功能
• 【部分函数和属性介绍】
  • 核心：zTree(setting, [zTreeNodes])

  这个函数接受一个JSON格式的数据对象setting和一个JSON格式的数据对象zTreeNodes，从而建立 Tree。

  • 核心参数：setting

  zTree 的参数配置都在这里完成，简单的说：树的样式、事件、访问路径等都在这里配置

  setting 举例:

  Js代码  

  1. var setting = {
  2. showLine: true,
  3. checkable: true
  4. };

  因为参数太多，具体参数详见zTreeAPI

  • 核心参数：zTreeNodes

  zTree 的全部节点数据集合，采用由JSON对象组成的数据结构，简单的说：这里使用Json格式保存了树的所有信息

  zTreeNodes的格式分为两种：利用Json格式嵌套体现父子关系和Array简单格式

  ①带有父子关系的标准 zTreeNodes 举例:

  Js代码  

  1. var zTreeNodes = [
  2. {"id":1, "name":"test1", "nodes":[
  3. {"id":11, "name":"test11", "nodes":[
  4. {"id":111, "name":"test111"}
  5. ]},
  6. {"id":12, "name":"test12"}
  7. ]},
  8. ......
  9. ];

  ②带有父子关系的简单 Array 格式(isSimpleData)的 zTreeNodes 举例：

  Js代码  

  1. var treeNodes = [
  2. {"id":1, "pId":0, "name":"test1"},
  3. {"id":11, "pId":1, "name":"test11"},
  4. {"id":12, "pId":1, "name":"test12"},
  5. {"id":111, "pId":11, "name":"test111"},
  6. ......
  7. ];

  【实例一】(Java代码)

  ①在页面引用zTree的js和css：

  Html代码  

  1. <!-- ZTree树形插件 -->
  2. <link rel="stylesheet" href="<%=root%>/Web/common/css/zTreeStyle/zTreeStyle.css" type="text/css">
  3. <!-- <link rel="stylesheet" href="<%=root%>/Web/common/css/zTreeStyle/zTreeIcons.css" type="text/css">  -->
  4. <script type="text/javascript" src="<%=root%>/Web/common/js/jquery-ztree-2.5.min.js"></script>

  ②在script脚本中定义setting和zTreeNodes

  Java代码  

  1. var setting = {
  2. isSimpleData : true,              //数据是否采用简单 Array 格式，默认false
  3. treeNodeKey : "id",               //在isSimpleData格式下，当前节点id属性
  4. treeNodeParentKey : "pId",        //在isSimpleData格式下，当前节点的父节点id属性
  5. showLine : true,                  //是否显示节点间的连线
  6. checkable : true                  //每个节点上是否显示 CheckBox
  7. };
  8. var treeNodes = [
  9. {"id":1, "pId":0, "name":"test1"},
  10. {"id":11, "pId":1, "name":"test11"},
  11. {"id":12, "pId":1, "name":"test12"},
  12. {"id":111, "pId":11, "name":"test111"},
  13. ];

  ③在进入页面时生成树结构：

  Js代码  

  1. var zTree;

  Js代码  

  1. $(function() {
  2. zTree = $("#tree").zTree(setting, treeNodes);
  3. });

  ④最后查看效果：

  

  【实例二】(从后台获取简单格式Json数据)

  ①后台代码封装简单格式Json数据：

  Java代码  

  1. public void doGetPrivilegeTree() throws IOException{
  2. String s1 = "{id:1, pId:0, name:\"test1\" , open:true}";
  3. String s2 = "{id:2, pId:1, name:\"test2\" , open:true}";
  4. String s3 = "{id:3, pId:1, name:\"test3\" , open:true}";
  5. String s4 = "{id:4, pId:2, name:\"test4\" , open:true}";
  6. List<String> lstTree = new ArrayList<String>();
  7. lstTree.add(s1);
  8. lstTree.add(s2);
  9. lstTree.add(s3);
  10. lstTree.add(s4);
  11. //利用Json插件将Array转换成Json格式
  12. response.getWriter().print(JSONArray.fromObject(lstTree).toString());
  13. }

  ②页面使用Ajax获取zTreeNodes数据再生成树

• var setting = {
      isSimpleData : true,              //数据是否采用简单 Array 格式，默认false
      treeNodeKey : "id",               //在isSimpleData格式下，当前节点id属性
      treeNodeParentKey : "pId",        //在isSimpleData格式下，当前节点的父节点id属性
      showLine : true,                  //是否显示节点间的连线
      checkable : true                  //每个节点上是否显示 CheckBox
  };
  
  var zTree;
  var treeNodes;
  
  $(function(){
      $.ajax({
          async : false,
          cache:false,
          type: ‘POST‘,
          dataType : "json",
          url: root+"/ospm/loginInfo/doGetPrivilegeTree.action",//请求的action路径
          error: function () {//请求失败处理函数
              alert(‘请求失败‘);
          },
          success:function(data){ //请求成功后处理函数。
              alert(data);
              treeNodes = data;   //把后台封装好的简单Json格式赋给treeNodes
          }
      });
  
      zTree = $("#tree").zTree(setting, treeNodes);
  });

•  

  ③最后显示效果

  

  【实例三】从后台动态获取数据，树节点提供右键菜单功能

  ①配置setting：

  var url = "/ospm/loginInfo/doGetPrivilegeTree.action";
      //zTree基本设置
      var setting = {
          async : true, //需要采用异步方式获取子节点数据,默认false
          asyncUrl : root + url, //当 async = true 时，设置异步获取节点的 URL 地址 ,允许接收 function 的引用
          asyncParam : ["id"], //提交的与节点数据相关的必需参数
          isSimpleData : true, //数据是否采用简单 Array 格式，默认false
          treeNodeKey : "id", //在isSimpleData格式下，当前节点id属性
          treeNodeParentKey : "parentId", //在isSimpleData格式下，当前节点的父节点id属性
          nameCol : "privName",            //在isSimpleData格式下，当前节点名称
          expandSpeed : "fast", //设置 zTree节点展开、折叠时的动画速度或取消动画(三种默认定义："slow", "normal", "fast")或 表示动画时长的毫秒数值(如：1000)
          showLine : true, //是否显示节点间的连线
          callback : { //回调函数
              rightClick : zTreeOnRightClick   //右键事件
          }
      };

  ②配置鼠标右键事件，显示右键菜单的代码

  //显示右键菜单
      function showRMenu(type, x, y) {
          $("#rMenu ul").show();
          if (type=="root") {
              $("#m_del").hide();
              $("#m_check").hide();
              $("#m_unCheck").hide();
          }
          $("#rMenu").css({"top":y+"px", "left":x+"px", "display":"block"});
      }
      //隐藏右键菜单
      function hideRMenu() {
          $("#rMenu").hide();
      }
  
      //鼠标右键事件-创建右键菜单
      function zTreeOnRightClick(event, treeId, treeNode) {
          if (!treeNode) {
              zTree.cancelSelectedNode();
              showRMenu("root", event.clientX, event.clientY);
          } else if (treeNode && !treeNode.noR) { //noR属性为true表示禁止右键菜单
              if (treeNode.newrole && event.target.tagName != "a" && $(event.target).parents("a").length == 0) {
                  zTree.cancelSelectedNode();
                  showRMenu("root", event.clientX, event.clientY);
              } else {
                  zTree.selectNode(treeNode);
                  showRMenu("node", event.clientX, event.clientY);
              }
          }
      }

  Js代码  

  1. <p><span style="#fafafa;"><!-- 右键菜单div -->
  2. <div id="rMenu" style="position:absolute; display:none;">
  3. <li>
  4. <ul id="m_add" onclick="addPrivilege();"><li>增加</li></ul>
  5. <ul id="m_del" onclick="delPrivilege();"><li>删除</li></ul>
  6. <ul id="m_del" onclick="editPrivilege();"><li>编辑</li></ul>
  7. <ul id="m_del" onclick="queryPrivilege();"><li>查看</li></ul>
  8. </li>
  9. </div></span></p>

  ③页面加载时生成树并且监听鼠标点击事件，及时隐藏右键菜单

  Js代码  

  1. function reloadTree() {
  2. hideRMenu();
  3. zTree = $("#tree").zTree(setting, treeNodes);
  4. }
  5. var zTree;
  6. var treeNodes = [];
  7. $(function() {
  8. reloadTree();
  9. $("body").bind(//鼠标点击事件不在节点上时隐藏右键菜单
  10. "mousedown",
  11. function(event) {
  12. if (!(event.target.id == "rMenu" || $(event.target)
  13. .parents("#rMenu").length > 0)) {
  14. $("#rMenu").hide();
  15. }
  16. });
  17. });

  ④后台代码根据id获取树节点信息

  -----------------------Action层-----------------------

  Java代码  

  1. public void doGetPrivilegeTree() throws IOException{
  2. String sId = request.getParameter("id");
  3. int treeId = 0;
  4. if(sId!=null&&!"".equals(sId)){
  5. treeId = Integer.parseInt(sId);
  6. }
  7. List<Privilege> lstPriv = privilegeService.findPrivilegeTreeById(treeId);
  8. response.setCharacterEncoding("UTF-8");
  9. response.getWriter().print(JSONArray.fromObject(lstPriv).toString());
  10. }

  -----------------------Service层-----------------------

  Java代码  

  1. /**
  2. * 根据节点id，查询其下级节点的数据
  3. */
  4. @SuppressWarnings("unchecked")
  5. @Override
  6. public List<Privilege> findPrivilegeTreeById(int treeId) {
  7. StringBuffer sbTree= new StringBuffer();
  8. sbTree.append("SELECT NEW Privilege(p.id,p.privName,p.description,p.status,p.isLeaf,p.parentId) FROM Privilege p ");
  9. sbTree.append("WHERE p.parentId=:treeId ");
  10. sbTree.append("AND p.status!=:del ");
  11. Map<String,Object> mapTree = new HashMap<String, Object>();
  12. mapTree.put("treeId", treeId);
  13. mapTree.put("del", Privilege.PRIV_STATUS_DELETE);
  14. return (List<Privilege>) privilegeDao.findByHql(sbTree.toString(), mapTree);
  15. }

  ⑤最后查看效果：