兼容 IE、FireFox、Chrome 等浏览器
在一个页面内可同时生成多个 Tree 实例
支持 JSON 数据
支持一次性静态生成 和 Ajax 异步加载 两种方式
支持多种事件响应及反馈
支持 Tree 的节点移动、编辑、删除
支持任意更换皮肤 / 个性化图标(依靠css)
支持极其灵活的 checkbox 或 radio 选择功能
简单的参数配置实现 灵活多变的功能
目前zTree作者已经入驻ItEye，如果有什么需要学习的完全可以到作者博客上去学习，而且zTree的版本已经更新了很多次了，下面的内容跟最新版估计会有很大出入，我不能保证下面的教程在最新版可用。zTree真的是非常强大的树组件，希望能对大家有所帮助！
在官网能够下载到zTree的源码、实例和API，其中作者pdf的API写得非常详细(中文的哦)
【部分函数和属性介绍】
核心：zTree(setting, [zTreeNodes])
这个函数接受一个JSON格式的数据对象setting和一个JSON格式的数据对象zTreeNodes，从而建立 Tree。
核心参数：setting
zTree 的参数配置都在这里完成，简单的说：树的样式、事件、访问路径等都在这里配置
setting 举例:
Js代码
varsetting = {
showLine:true,
checkable:true
};
var setting = {
showLine: true,
checkable: true
};
因为参数太多，具体参数详见zTreeAPI
核心参数：zTreeNodes
zTree 的全部节点数据集合，采用由JSON对象组成的数据结构，简单的说：这里使用Json格式保存了树的所有信息
zTreeNodes的格式分为两种：利用Json格式嵌套体现父子关系和Array简单格式
①带有父子关系的标准 zTreeNodes 举例:
Js代码
varzTreeNodes = [
{"id":1,"name":"test1","nodes":[
{"id":11,"name":"test11","nodes":[
{"id":111,"name":"test111"}
]},
{"id":12,"name":"test12"}
]},
......
];
var zTreeNodes = [
{"id":1, "name":"test1", "nodes":[
{"id":11, "name":"test11", "nodes":[
{"id":111, "name":"test111"}
]},
{"id":12, "name":"test12"}
]},
......
];
②带有父子关系的简单 Array 格式(isSimpleData)的 zTreeNodes 举例：
Js代码
vartreeNodes = [
{"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 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：
Html代码
/Web/common/css/zTreeStyle/zTreeStyle.css"type="text/css">
/Web/common/js/jquery-ztree-2.5.min.js">
②在script脚本中定义setting和zTreeNodes
Java代码
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 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"},
];
③在进入页面时生成树结构：
Js代码
varzTree;
var zTree;
Js代码
$(function() {
zTree = $("#tree").zTree(setting, treeNodes);
});
$(function() {
zTree = $("#tree").zTree(setting, treeNodes);
});
④最后查看效果：
【实例二】(从后台获取简单格式Json数据)
①后台代码封装简单格式Json数据：
Java代码
publicvoiddoGetPrivilegeTree()throwsIOException{
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 lstTree =newArrayList();
lstTree.add(s1);
lstTree.add(s2);
lstTree.add(s3);
lstTree.add(s4);
//利用Json插件将Array转换成Json格式
response.getWriter().print(JSONArray.fromObject(lstTree).toString());
}
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 lstTree = new ArrayList();
lstTree.add(s1);
lstTree.add(s2);
lstTree.add(s3);
lstTree.add(s4);
//利用Json插件将Array转换成Json格式
response.getWriter().print(JSONArray.fromObject(lstTree).toString());
}
②页面使用Ajax获取zTreeNodes数据再生成树
Js代码
varsetting = {
isSimpleData :true,//数据是否采用简单 Array 格式，默认false
treeNodeKey :"id",//在isSimpleData格式下，当前节点id属性
treeNodeParentKey :"pId",//在isSimpleData格式下，当前节点的父节点id属性
showLine :true,//是否显示节点间的连线
checkable :true//每个节点上是否显示 CheckBox
};
varzTree;
vartreeNodes;
$(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);
});
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：
Js代码
varurl ="/ospm/loginInfo/doGetPrivilegeTree.action";
//zTree基本设置
varsetting = {
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//右键事件
}
};
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 //右键事件
}
};
②配置鼠标右键事件，显示右键菜单的代码
Js代码
//显示右键菜单
functionshowRMenu(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"});
}
//隐藏右键菜单
functionhideRMenu() {
$("#rMenu").hide();
}
//鼠标右键事件-创建右键菜单
functionzTreeOnRightClick(event, treeId, treeNode) {
if(!treeNode) {
zTree.cancelSelectedNode();
showRMenu("root", event.clientX, event.clientY);
}elseif(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);
}
}
}
//显示右键菜单
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代码
- 增加
- 删除
- 编辑
- 查看
- 增加
- 删除
- 编辑
- 查看
③页面加载时生成树并且监听鼠标点击事件，及时隐藏右键菜单
Js代码
functionreloadTree() {
hideRMenu();
zTree = $("#tree").zTree(setting, treeNodes);
}
varzTree;
vartreeNodes = [];
$(function() {
reloadTree();
$("body").bind(//鼠标点击事件不在节点上时隐藏右键菜单
"mousedown",
function(event) {
if(!(event.target.id =="rMenu"|| $(event.target)
.parents("#rMenu").length > 0)) {
$("#rMenu").hide();
}
});
});
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层-----------------------
Java代码
publicvoiddoGetPrivilegeTree()throwsIOException{
String sId = request.getParameter("id");
inttreeId =0;
if(sId!=null&&!"".equals(sId)){
treeId = Integer.parseInt(sId);
}
List lstPriv = privilegeService.findPrivilegeTreeById(treeId);
response.setCharacterEncoding("UTF-8");
response.getWriter().print(JSONArray.fromObject(lstPriv).toString());
}
public void doGetPrivilegeTree() throws IOException{
String sId = request.getParameter("id");
int treeId = 0;
if(sId!=null&&!"".equals(sId)){
treeId = Integer.parseInt(sId);
}
List lstPriv = privilegeService.findPrivilegeTreeById(treeId);
response.setCharacterEncoding("UTF-8");
response.getWriter().print(JSONArray.fromObject(lstPriv).toString());
}
-----------------------Service层-----------------------
Java代码
/**
* 根据节点id，查询其下级节点的数据
*/
@SuppressWarnings("unchecked")
@Override
publicList findPrivilegeTreeById(inttreeId) {
StringBuffer sbTree=newStringBuffer();
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 mapTree =newHashMap();
mapTree.put("treeId", treeId);
mapTree.put("del", Privilege.PRIV_STATUS_DELETE);
return(List) privilegeDao.findByHql(sbTree.toString(), mapTree);
}
/**
* 根据节点id，查询其下级节点的数据
*/
@SuppressWarnings("unchecked")
@Override
public List 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 mapTree = new HashMap();
mapTree.put("treeId", treeId);
mapTree.put("del", Privilege.PRIV_STATUS_DELETE);
return (List) privilegeDao.findByHql(sbTree.toString(), mapTree);
}
⑤最后查看效果：
转自：http://blessht.iteye.com/blog/1029769