How to work my tree structure into a Jtree?

Question

First off I should say that I am using netbeans and I am new to the whole java GUI game.

So, my problem is that I created my own Tree structure specific to my project and I now want to use my structure to construct the JTree.

I was reading up on the topic of Jtree and, from what I understand, I need to implement the TreeModel interface into my structure. The other way I also read about, was to use DefaultMutableTreeNode but I cannot find any examples using it that are clear to me.

Right now I have my entire tree structure constructed and filled with data and am trying to avoid reconstructing it. How can I implement my tree into a Jtree?

package models;

import java.util.ArrayList;
import java.util.List;


public class IngredientTree {

   private Node root;


    public IngredientTree(){
        root = new Node();
    }
    public IngredientTree(Node rootData) {
        root = rootData;
    }

    public void setRoot(Node n){
        root = n;
    }

    public Node getRoot(){
        return root;
    }

    public void addToTree(Ingredient i){
        if(root.getData().getName()=="") // Then it must be the root 
            root.setData(i);
        else
            addToTree(root,i);
    }
    private void addToTree(Node n, Ingredient i){
        if(isFirstAdd(n)) //Has no parent and no children
            n.addChild(new Node(i,n));
        else if(n.hasChildren()){ //Has parent and children
            if(!inChildren(n,i)){
                if(inNode(n,i))
                    n.addChild(new Node(i,n));
            }
            else{
                for(Node child : n.getChildren()){
                    addToTree(child,i);
                }
            }
        }
        else{ //Has parent but no children
            n.addChild(new Node(i,n));
        }
    }
    private boolean isFirstAdd(Node n){
        return(!n.hasParent() && !n.hasChildren());
    }
    private boolean inChildren(Node n,Ingredient i){
        for(Node child : n.getChildren()){
            if(inNode(child,i))
                return true;
        }
        return false;
    }

    private boolean inNode(Node n,Ingredient i){
        return(i.getStartIndex() > n.getData().getStartIndex() &&
                i.getEndIndex() < n.getData().getEndIndex());
    }

    public int countIngredients(){
        return countIngredients(this.getRoot());
    }

    private int countIngredients(Node r){
        int count = 0;
        if(!r.hasChildren()){
            return 1;
        }else{
            for(Node child: r.getChildren()){
                count += countIngredients(child);
            }
        }
        return count;
    }
}

Answer 1

Would you recommend implementing tree model and basing the reconstruction around that structure?

Yes. FileTreeModel, cited here, is an example. As noted in How to Use Trees: Creating a Data Model, "You just need to implement your tree model so that it uses the information in the existing data structure."

Answer 2

I hope this class will help you

package dharm.mytasks.component;

import java.awt.Dimension;
import java.awt.event.MouseEvent;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import javax.swing.JTree;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.TreePath;
import javax.swing.tree.TreeSelectionModel;

import dharm.mytasks.ui.helper.CommonHelper;

public class Tree<T extends Object> extends JTree {
    private static final long serialVersionUID = 1L;

    public Tree(T rootUserObj){
        this(new TreeNode<>(rootUserObj));
    }

    public Tree(TreeNode<T> root) {
        super(root);

        this.setPreferredSize(new Dimension(150, 0));
//      this.setRootVisible(false);
        this.getSelectionModel().setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
        this.setExpandsSelectedPaths(true);
    }

    @SuppressWarnings("unchecked")
    public TreeNode<T> getRoot() {
        return (TreeNode<T>) getModel().getRoot();
    }

    public void fillChildren(Consumer<TreeNode<T>> childFiller){
        getRoot().fillChildren(childFiller);
    }

    /** Loop for all nodes (deep=true) */
    public void forEachNodes(Consumer<TreeNode<T>> childConsumer){
        TreeNode<T> root = getRoot();
        childConsumer.accept(root);
        root.forEach(childConsumer, true);
    }

    public T getRootUserObject(){
        return getRoot().getUserObject();
    }

    public TreeNode<T> getSelectedNode(){
        @SuppressWarnings("unchecked")
        TreeNode<T> node = (TreeNode<T>) getSelectionModel().getSelectionPath().getLastPathComponent();
        return node;
    }

    public T getSelectedUserObject(){
        TreeNode<T> node = getSelectedNode();
        if(node != null /*&& node.isLeaf()*/) {
            return node.getUserObject();
        }
        return null;
    }

    public void setSelectedNode(TreeNode<T> node){
        setSelectionPath(new TreePath(node.getPath()));
    }

    public void onChange(Consumer<T> consumer){
        super.addTreeSelectionListener(evt->{
            TreePath selectedPath = evt.getNewLeadSelectionPath();
            if(selectedPath==null) return;
            @SuppressWarnings("unchecked")
            TreeNode<T> node = (TreeNode<T>) selectedPath.getLastPathComponent();
            if(node != null && node.isLeaf()) {
                T userObject = node.getUserObject();
                consumer.accept(userObject);
            }
        });
    }

    public void onMouseRightClickOnNode(BiConsumer<TreeNode<T>, MouseEvent> consumer){
        Tree<T> tree = this;
        CommonHelper.onMouseRightClick(tree, evt->{
            TreePath path = getPathForLocation(evt.getX(), evt.getY());
            if(path==null) return;
            tree.setSelectionPath(path);
            TreeNode<T> node = tree.getSelectedNode();

            consumer.accept(node, evt);
        });
    }

    public void showPopupOnRightClick(BiConsumer<MyJPopupMenu, TreeNode<T>> popupMenuItemFiller){
        this.onMouseRightClickOnNode((node,evt)->{
            MyJPopupMenu popup = new MyJPopupMenu();
            popupMenuItemFiller.accept(popup,node);
            popup.show(evt.getComponent(), evt.getX(), evt.getY());
        });
    }

    public static class TreeNode<T> extends DefaultMutableTreeNode {
        private static final long serialVersionUID = 1L;

        public TreeNode(T userObj){
            super(userObj);
        }

        /** @param userObj
         * @return child node
         */
        public TreeNode<T> addChild(T userObj) {
            TreeNode<T> child = new TreeNode<>(userObj);
            add(child);
            return child;
        }

        @Override
        public T getUserObject(){
            @SuppressWarnings("unchecked")
            T userObject = (T) super.getUserObject();
            return userObject;
        }

        @SuppressWarnings("unchecked")
        public List<TreeNode<T>> getChildren(){
            return (List<TreeNode<T>>) children;//.clone();
        }

        public void fillChildren(Consumer<TreeNode<T>> childFiller){
            if(getChildCount() != 0)
                super.removeAllChildren();
            childFiller.accept(this);
            forEach(child->child.fillChildren(childFiller), false);
        }

        /**
         * @param childConsumer
         * @param deep <code>true</code>=access all, <code>false</code>=first level children
         */
        public void forEach(Consumer<TreeNode<T>> childConsumer, boolean deep){
            getChildren().forEach(child->{
                childConsumer.accept(child);
                if(deep)
                    child.forEach(childConsumer, deep);
            });
        }

    }
}



public class CommonHelper {

    /**
     * @param comp component where listener should add
     * @param onRighClickConsumer
     */
    public static void onMouseRightClick(Component comp, Consumer<MouseEvent> onRighClickConsumer){
        comp.addMouseListener(new MouseAdapter() {
            @Override
            public void mouseClicked(MouseEvent e) {
                if(SwingUtilities.isRightMouseButton(e) && e.getClickCount()==1)
                    onRighClickConsumer.accept(e); //call on right click
            }
        });
    }
}

Answer 3

I hope this class will help you

package dharm.mytasks.component;

import java.awt.Dimension;
import java.awt.event.MouseEvent;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import javax.swing.JTree;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.TreePath;
import javax.swing.tree.TreeSelectionModel;

import dharm.mytasks.ui.helper.CommonHelper;

public class Tree<T extends Object> extends JTree {
    private static final long serialVersionUID = 1L;

    public Tree(T rootUserObj){
        this(new TreeNode<>(rootUserObj));
    }

    public Tree(TreeNode<T> root) {
        super(root);

        this.setPreferredSize(new Dimension(150, 0));
//      this.setRootVisible(false);
        this.getSelectionModel().setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
        this.setExpandsSelectedPaths(true);
    }

    @SuppressWarnings("unchecked")
    public TreeNode<T> getRoot() {
        return (TreeNode<T>) getModel().getRoot();
    }

    public void fillChildren(Consumer<TreeNode<T>> childFiller){
        getRoot().fillChildren(childFiller);
    }

    /** Loop for all nodes (deep=true) */
    public void forEachNodes(Consumer<TreeNode<T>> childConsumer){
        TreeNode<T> root = getRoot();
        childConsumer.accept(root);
        root.forEach(childConsumer, true);
    }

    public T getRootUserObject(){
        return getRoot().getUserObject();
    }

    public TreeNode<T> getSelectedNode(){
        @SuppressWarnings("unchecked")
        TreeNode<T> node = (TreeNode<T>) getSelectionModel().getSelectionPath().getLastPathComponent();
        return node;
    }

    public T getSelectedUserObject(){
        TreeNode<T> node = getSelectedNode();
        if(node != null /*&& node.isLeaf()*/) {
            return node.getUserObject();
        }
        return null;
    }

    public void setSelectedNode(TreeNode<T> node){
        setSelectionPath(new TreePath(node.getPath()));
    }

    public void onChange(Consumer<T> consumer){
        super.addTreeSelectionListener(evt->{
            TreePath selectedPath = evt.getNewLeadSelectionPath();
            if(selectedPath==null) return;
            @SuppressWarnings("unchecked")
            TreeNode<T> node = (TreeNode<T>) selectedPath.getLastPathComponent();
            if(node != null && node.isLeaf()) {
                T userObject = node.getUserObject();
                consumer.accept(userObject);
            }
        });
    }

    public void onMouseRightClickOnNode(BiConsumer<TreeNode<T>, MouseEvent> consumer){
        Tree<T> tree = this;
        CommonHelper.onMouseRightClick(tree, evt->{
            TreePath path = getPathForLocation(evt.getX(), evt.getY());
            if(path==null) return;
            tree.setSelectionPath(path);
            TreeNode<T> node = tree.getSelectedNode();

            consumer.accept(node, evt);
        });
    }

    public void showPopupOnRightClick(BiConsumer<MyJPopupMenu, TreeNode<T>> popupMenuItemFiller){
        this.onMouseRightClickOnNode((node,evt)->{
            MyJPopupMenu popup = new MyJPopupMenu();
            popupMenuItemFiller.accept(popup,node);
            popup.show(evt.getComponent(), evt.getX(), evt.getY());
        });
    }

    /** Reload/refresh in GUI */
    public void reload(){
        ((DefaultTreeModel) getModel()).reload();
    }

    public static class TreeNode<T> extends DefaultMutableTreeNode {
        private static final long serialVersionUID = 1L;

        public TreeNode(T userObj){
            super(userObj);
        }

        /** @param userObj
         * @return child node
         */
        public TreeNode<T> addChild(T userObj) {
            TreeNode<T> child = new TreeNode<>(userObj);
            add(child);
            return child;
        }

        @Override
        public T getUserObject(){
            @SuppressWarnings("unchecked")
            T userObject = (T) super.getUserObject();
            return userObject;
        }

        @SuppressWarnings("unchecked")
        public List<TreeNode<T>> getChildren(){
            return (List<TreeNode<T>>) children;//.clone();
        }

        public void fillChildren(Consumer<TreeNode<T>> childFiller){
            if(getChildCount() != 0)
                super.removeAllChildren();
            childFiller.accept(this);
            forEach(child->child.fillChildren(childFiller), false);
        }

        /**
         * @param childConsumer
         * @param deep <code>true</code>=access all, <code>false</code>=first level children
         */
        public void forEach(Consumer<TreeNode<T>> childConsumer, boolean deep){
            getChildren().forEach(child->{
                childConsumer.accept(child);
                if(deep)
                    child.forEach(childConsumer, deep);
            });
        }

    }
}