Jquery-zTree的基本用法

【简介】

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

 兼容 IE、FireFox、Chrome 等浏览器

 在一个页面内可同时生成多个 Tree 实例

 支持 JSON 数据

 支持一次性静态生成 和 Ajax 异步加载 两种方式

 支持多种事件响应及反馈

 支持 Tree 的节点移动、编辑、删除

 支持任意更换皮肤 / 个性化图标（依靠css）

 支持极其灵活的 checkbox 或 radio 选择功能

 简单的参数配置实现 灵活多变的功能

 

zTree博客地址：http://ztreeapi.iteye.com/

目前zTree作者已经入驻ItEye，如果有什么需要学习的完全可以到作者博客上去学习，而且zTree的版本已经更新了很多次了，下面的内容跟最新版估计会有很大出入，我不能保证下面的教程在最新版可用。zTree真的是非常强大的树组件，希望能对大家有所帮助！

 

 

在官网能够下载到zTree的源码、实例和API，其中作者pdf的API写得非常详细（中文的哦）

 

 【部分函数和属性介绍】

核心：zTree(setting, [zTreeNodes])

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

 

核心参数：setting

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

setting 举例:

var setting = { 
    showLine: true, 
    checkable: true 
}; 

 

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

 

核心参数：zTreeNodes

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

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

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

var zTreeNodes = [ 
    {"id":1, "name":"test1", "nodes":[ 
      {"id":11, "name":"test11", "nodes":[ 
        {"id":111, "name":"test111"} 
      ]}, 
      {"id":12, "name":"test12"} 
    ]}, 
    ...... 
]; 

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

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

 

 

【实例一】(Java代码)

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

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

②在script脚本中定义setting和zTreeNodes

var setting = {
		isSimpleData : true,              //数据是否采用简单 Array 格式，默认false
		treeNodeKey : "id",               //在isSimpleData格式下，当前节点id属性
		treeNodeParentKey : "pId",        //在isSimpleData格式下，当前节点的父节点id属性
		showLine : true,                  //是否显示节点间的连线
		checkable : true                  //每个节点上是否显示 CheckBox
	};

var treeNodes = [ 
    {"id":1, "pId":0, "name":"test1"}, 
    {"id":11, "pId":1, "name":"test11"}, 
    {"id":12, "pId":1, "name":"test12"}, 
    {"id":111, "pId":11, "name":"test111"}, 
]; 

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

var zTree;

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

 ④最后查看效果：

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

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

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

 

②页面使用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);
			}
		}
	}

<!-- 右键菜单div -->
 <div id="rMenu" style="position:absolute; display:none;">
 <li>
 <ul id="m_add" onclick="addPrivilege();"><li>增加</li></ul>
 <ul id="m_del" onclick="delPrivilege();"><li>删除</li></ul>
 <ul id="m_del" onclick="editPrivilege();"><li>编辑</li></ul>
 <ul id="m_del" onclick="queryPrivilege();"><li>查看</li></ul>
 </li>
 </div>

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

function reloadTree() {
		hideRMenu();
		zTree = $("#tree").zTree(setting, treeNodes);
	}	
	
	var zTree;
	var treeNodes = [];
	

$(function() {
		reloadTree();

		$("body").bind(//鼠标点击事件不在节点上时隐藏右键菜单
				"mousedown",
				function(event) {
					if (!(event.target.id == "rMenu" || $(event.target)
							.parents("#rMenu").length > 0)) {
						$("#rMenu").hide();
					}
				});
	});

 

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

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

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

 

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

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

 ⑤最后查看效果：

 

评论

17 楼 505547425 2017-05-02  

16 楼 liuweihug 2016-05-19  

ztree 经典系列教程
http://www.suchso.com/catalog.asp?tags=ztree

15 楼 xbq8023 2015-06-29  

14 楼 darrenzhong 2014-09-20  

可以看看这篇文章 言简意赅 http://darrenzhong.com/?p=348

13 楼 liuweihug 2014-05-23  

ztree教程--两个ztree树并存实现下拉框
http://www.suchso.com/UIweb/ztree-jiaocheng-2ge-tree-dropdownlist.html

12 楼 liuweihug 2014-05-07  

Ztree教程-采用Jquery Ajax异步加载数据和Ztree自带异步加载数据
http://www.suchso.com/projecteactual/ztree-jiaocheng-aspnet-demo-ashx-jquery-ajax-ztree-setting-async.html

11 楼 白糖_ 2013-05-10  

liminjun 写道

Jabbar2011 写道

如果我拖拽一个节点或者修改一个节点并提交修改的数据到后台，然后后台报错了，我前台的节点树如何撤销操作？？？？？

zTree也支持拖拽吗?最近自己实现了一个简单的拖拽的树形菜单，问题好多呀!而已不知道怎么保存最后选中树形菜单数据。

肯定支持拖拽了，你可以到zTree的ItEye博客去提问，他在ItEye有博客的

10 楼 liminjun 2013-05-09  

Jabbar2011 写道

如果我拖拽一个节点或者修改一个节点并提交修改的数据到后台，然后后台报错了，我前台的节点树如何撤销操作？？？？？

zTree也支持拖拽吗?最近自己实现了一个简单的拖拽的树形菜单，问题好多呀!而已不知道怎么保存最后选中树形菜单数据。

9 楼 Jabbar2011 2012-10-27  

如果我拖拽一个节点或者修改一个节点并提交修改的数据到后台，然后后台报错了，我前台的节点树如何撤销操作？？？？？

8 楼 mengfei86 2012-08-01  

liguikai2008 写道

不好意思哦，本来打算点“顶”的，鼠标一滑，变成“踩”了，文章不错，谢谢

我去

7 楼 tuoxinquyu 2012-05-09  

如果我的节点是org_id 和 org_name，这个该怎么解决呢？比如json为

[{"org_description":"","org_id":21,"org_name":"公司","parent_id":0},[{"org_description":"","org_id":22,"org_name":"软件研发部","parent_id":1},{"org_description":"","org_id":23,"org_name":"电信集成部","parent_id":1},{"org_description":"财务部管理财务","org_id":24,"org_name":"财务部","parent_id":1}]]

6 楼 a124116186 2012-02-29  

我用实例二的时候包了一个错：Uncaught TypeError: Property 'zTree' of object [object Object] is not a function   
alert（treeNodes）的时候得到是json对象。疑惑

5 楼 robingdo 2012-02-08  

引用

引用

引用

引用

4 楼 liguikai2008 2011-11-24  

不好意思哦，本来打算点“顶”的，鼠标一滑，变成“踩”了，文章不错，谢谢

3 楼 白糖_ 2011-11-20  

wen2006953 写道

不显示图标
还有body里面的那一句代码也要说明啊

在开发中，把ztree整个文件夹都放在项目中。
这些代码我弄丢了，你自己按照pdf研究下吧，不好意思哈...

2 楼 wen2006953 2011-11-20  

不显示图标
还有body里面的那一句代码也要说明啊

1 楼 wen2006953 2011-11-20  

包里没有图片