DIV CSS 佈局教程網

jQuery 樹狀選單外掛 zTree 入門教學
編輯:JavaScript綜合知識     

zTree 是 jQuery 生態裡相當成熟的樹狀選單外掛,收件人選擇、部門架構、分類目錄這類階層資料都能勝任。本文示範一個實用案例:滑鼠移到一級節點時出現「全選」連結,點一下就把該目錄下所有子項寫入收件人欄位;點單一子項則只加一筆。

步驟一:載入函式庫

<script type="text/javascript" src="js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="js/jquery.ztree.core-3.5.js"></script>
<script type="text/javascript" src="js/jquery.ztree.excheck-3.5.js"></script>
<script type="text/javascript" src="js/jquery.ztree.exedit-3.5.js"></script>
<link rel="stylesheet" href="css/zTreeStyle/zTreeStyle.css" type="text/css">

三個 JS 包的分工如下:

  • jquery.ztree.core-3.5.js:核心包,必載。
  • jquery.ztree.excheck-3.5.js:核取方塊(勾選)功能包。
  • jquery.ztree.exedit-3.5.js:節點編輯(新增、刪除、拖曳)功能包。

用不到的功能就不必引入,這對首屏效能有實際幫助。

步驟二:ID 後綴命名規則

zTree 會為每個節點的內部元素加上固定後綴,知道這套規則才能準確選到你要的 DOM:

var IDMark_Switch = "_switch",
    IDMark_Icon   = "_ico",
    IDMark_Span   = "_span",
    IDMark_Input  = "_input",
    IDMark_Check  = "_check",
    IDMark_Edit   = "_edit",
    IDMark_Remove = "_remove",
    IDMark_Ul     = "_ul",
    IDMark_A      = "_a";

例如節點 tId 為 treeDemo_1 時,它前方的展開/收合圖示 id 就是 treeDemo_1_switch,節點連結則是 treeDemo_1_a。

步驟三:setting 與回呼函式

var setting = {
  view: {
    addHoverDom: addHoverDom,          // 滑鼠移入節點
    removeHoverDom: removeHoverDom     // 滑鼠移出節點
  },
  callback: {
    beforeClick: beforeClick,          // 點擊前攔截
    onClick: onClick                   // 點擊後通知
  }
};

function beforeClick(treeId, treeNode, clickFlag) {
  var ticketBagNo = treeNode.phone;
  var re = new RegExp(ticketBagNo);
  var accept = $("#accept").val();     // 收件人欄位現有內容
  if (!re.test(accept)) {              // 尚未存在才加入,避免重複
    $("#accept").val(accept + treeNode.name + "<" + ticketBagNo + ">,");
  }
}

function onClick(event, treeId, treeNode, clickFlag) {
  // 需要額外處理時寫在這裡
}

兩個 callback 的差別要記清楚:beforeClick 在勾選或取消勾選之前觸發,回傳 false 可以阻止該動作;onClick 在節點被點擊後觸發,但若 beforeClick 回傳 false,onClick 不會執行。

步驟四:懸停時動態掛上「全選」

function addHoverDom(treeId, treeNode) {
  if (!treeNode.children) return;                       // 沒有子節點就不處理
  if (treeNode.parentNode && treeNode.parentNode.id != 1) return;   // 只對頂層生效

  var aObj = $("#" + treeNode.tId + IDMark_A);
  if (treeNode.children.length > 0) {
    if ($("#diyBtn1_" + treeNode.id).length > 0) return;  // 已存在則跳過
    var editStr = "<a id='diyBtn1_" + treeNode.id + "' style='margin:0 0 0 5px;color:red;'>全選</a>";
    aObj.append(editStr);
    document.getElementById("diyBtn1_" + treeNode.id).onclick = function () {
      allSelect(treeNode);
    };
  }
}

function removeHoverDom(treeId, treeNode) {
  if (!treeNode.children) return;
  $("#diyBtn1_" + treeNode.id).unbind().remove();
}

addHoverDom 與 removeHoverDom 必須成對出現:只加不移,連結會永久留在畫面上;只移不加,則永遠看不到。這裡用 treeNode.id 組成自訂 id,並在新增前先檢查長度是否為 0,防止重複插入。

全選的實作

function allSelect(treeNode) {
  if (!treeNode.children) return;
  for (var i = 0; i < treeNode.children.length; i++) {
    var ticketBagNo = treeNode.children[i].phone;
    var re = new RegExp(ticketBagNo);
    var accept = $("#accept").val();
    if (!re.test(accept)) {
      $("#accept").val(accept + treeNode.children[i].name + "<" + ticketBagNo + ">,");
    }
  }
}

邏輯與 beforeClick 一致:逐筆檢查是否已在欄位中,沒有的才附加,天然具備去重效果。

步驟五:節點資料

zTree 的資料就是一般的 JavaScript 物件陣列,屬性可以自由擴充,這一點非常方便:

var zNodes = [
  {
    id: 1, name: "所有老師", open: false,   // open: false 表示預設收合
    children: [
      { id: 2, name: "測試老師", phone: "123456789101" },
      { id: 3, name: "大老師",   phone: "15623545621" }
    ]
  },
  {
    id: 4, name: "一班", open: true,
    children: [
      { id: 5, name: "小花", phone: "25364215211" },
      { id: 6, name: "小綠", phone: "365241253" }
    ]
  },
  {
    id: 7, name: "二班", open: true,
    children: [
      { id: 8, name: "小家", phone: "25364215211" },
      { id: 9, name: "小沙", phone: "365241253" }
    ]
  }
];

要加「年齡」之類的欄位,直接在節點裡補上 age: "23" 即可,只需注意引號與逗號的格式。若資料來自後端(例如以 JSP、Struts 標籤動態組出這段 JSON),做法完全一樣,只是把值換成伺服器輸出。

步驟六:初始化

$(document).ready(function () {
  $.fn.zTree.init($("#treeDemo"), setting, zNodes);
});

三個參數依序是容器、設定物件、節點資料,缺一不可。呼叫後 zTree 會在該容器內產生完整的樹狀結構。

實作上的提醒

這段程式有兩處值得留意。第一,new RegExp(ticketBagNo) 拿來做「是否已存在」的判斷,其實用 indexOf 更安全——號碼若含正則元字元會出錯,而且子字串比對也可能誤判(例如 1234 存在時會誤以為 12345 也存在)。第二,以「名字<電話>,」拼字串的做法,後端解析時需要約定好分隔規則並做好轉義,人數多時建議改用陣列收集後一次送出,資料結構比字串可靠得多。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved