DIV CSS 佈局教程網

擴充 EasyUI Tree 的節點搜尋方法(支援名稱模糊比對)
編輯:JQuery入門技巧     

EasyUI 的 tree 原生只提供 find(),而且僅能依 id 精確查找。實務上使用者想輸的是名稱,不是 id。以下擴充一個 search() 方法,做到名稱模糊比對、命中節點高亮、其父節點自動展開、其餘節點隱藏。

用法

$("#treeId").tree("search", searchText);

treeId 是 easyui tree 根 UL 元素的 id,searchText 為搜尋字串。傳入空字串或 "" 時,會還原所有節點並恢復正常狀態。

完整程式碼

(function ($) {
    $.extend($.fn.tree.methods, {

        /**
         * 擴充 easyui tree 的搜尋方法
         * @param jqTree     easyui tree 根 DOM 節點(UL)的 jQuery 物件
         * @param searchText 搜尋文字
         */
        search: function (jqTree, searchText) {
            var tree = this;                          // this 即 tree 物件
            var nodeList = getAllNodes(jqTree, tree);

            searchText = $.trim(searchText);

            // 搜尋條件為空:全部顯示並還原
            if (searchText === "") {
                for (var i = 0; i < nodeList.length; i++) {
                    $(".tree-node-targeted", nodeList[i].target).removeClass("tree-node-targeted");
                    $(nodeList[i].target).show();
                }
                var selectedNode = tree.getSelected(jqTree);
                if (selectedNode) {
                    tree.expandTo(jqTree, selectedNode.target);
                }
                return;
            }

            // 找出所有命中節點
            var matchedNodeList = [];
            for (var i = 0; i < nodeList.length; i++) {
                if (isMatch(searchText, nodeList[i].text)) {
                    matchedNodeList.push(nodeList[i]);
                }
            }

            // 先全部隱藏並收合
            for (var i = 0; i < nodeList.length; i++) {
                $(".tree-node-targeted", nodeList[i].target).removeClass("tree-node-targeted");
                $(nodeList[i].target).hide();
            }
            tree.collapseAll(jqTree);

            // 逐一顯示命中節點
            for (var i = 0; i < matchedNodeList.length; i++) {
                showMatchedNode(jqTree, tree, matchedNodeList[i]);
            }
        },

        /**
         * 顯示節點的子節點(搜尋過程中可能被隱藏)
         */
        showChildren: function (jqTree, node) {
            var tree = this;
            if (!tree.isLeaf(jqTree, node.target)) {
                var children = tree.getChildren(jqTree, node.target);
                if (children && children.length > 0) {
                    for (var i = 0; i < children.length; i++) {
                        if ($(children[i].target).is(":hidden")) {
                            $(children[i].target).show();
                        }
                    }
                }
            }
        },

        /**
         * 捲動到指定節點使其可見(有捲軸才捲)
         * @param param { treeContainer, targetNode }
         */
        scrollTo: function (jqTree, param) {
            var tree = this;
            var targetNode = (param && param.targetNode) ? param.targetNode : tree.getSelected(jqTree);

            if (targetNode != null) {
                var $targetNode = $(targetNode.target);
                var container = (param && param.treeContainer) ? param.treeContainer : jqTree.parent();
                var containerH = container.height();
                var nodeOffsetHeight = $targetNode.offset().top - container.offset().top;

                if (nodeOffsetHeight > (containerH - 30)) {
                    container.scrollTop(container.scrollTop() + nodeOffsetHeight - containerH + 30);
                }
            }
        }
    });

    /** 顯示命中的節點:顯示、標記、展開父鏈 */
    function showMatchedNode(jqTree, tree, node) {
        $(node.target).show();
        $(".tree-title", node.target).addClass("tree-node-targeted");

        var pNode = node;
        while ((pNode = tree.getParent(jqTree, pNode.target))) {
            $(pNode.target).show();
        }

        tree.expandTo(jqTree, node.target);

        // 非葉節點要收合起來,避免搜尋後畫面被全部展開
        if (!tree.isLeaf(jqTree, node.target)) {
            tree.collapse(jqTree, node.target);
        }
    }

    /** 文字比對 */
    function isMatch(searchText, targetText) {
        return $.trim(targetText) !== "" && targetText.indexOf(searchText) !== -1;
    }

    /** 取得所有節點(結果會快取在 data 上) */
    function getAllNodes(jqTree, tree) {
        var allNodeList = jqTree.data("allNodeList");
        if (!allNodeList) {
            var roots = tree.getRoots(jqTree);
            allNodeList = getChildNodeList(jqTree, tree, roots);
            jqTree.data("allNodeList", allNodeList);
        }
        return allNodeList;
    }

    /** 遞迴收集子節點 */
    function getChildNodeList(jqTree, tree, nodes) {
        var childNodeList = [];
        if (nodes && nodes.length > 0) {
            for (var i = 0; i < nodes.length; i++) {
                var node = nodes[i];
                childNodeList.push(node);
                if (!tree.isLeaf(jqTree, node.target)) {
                    var children = tree.getChildren(jqTree, node.target);
                    childNodeList = childNodeList.concat(getChildNodeList(jqTree, tree, children));
                }
            }
        }
        return childNodeList;
    }
})(jQuery);

設計重點

節點清單要快取。每次搜尋都遞迴展開整棵樹太浪費,所以第一次呼叫時收集全部節點並存進 jqTree.data("allNodeList"),之後重複使用。

父鏈必須一起顯示。只 show() 命中節點是不夠的——若其父節點是隱藏狀態,子節點在視覺上仍然看不到。所以 showMatchedNode 裡用 while 迴圈沿著 getParent 一路往上顯示。

命中節點要展開但保持收合。呼叫 expandTo 讓路徑可見,隨後對非葉節點呼叫 collapse,避免搜尋結果一多就把整棵樹攤平。

要補一個失效時機。快取的 allNodeList 不會自動更新。如果樹的內容會動態增刪(例如新增節點後),記得清掉快取:$("#treeId").removeData("allNodeList"),否則搜尋結果會漏掉新資料。另外若要支援不分大小寫比對,把 isMatch 改成 targetText.toLowerCase().indexOf(searchText.toLowerCase()) 即可。

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