Hiding/filtering nodes in a JTree?

G

7

12

I have a data object represented in a TreeModel, and I'd like to show only part of it in my JTree--for the sake of argument, say the leaves and their parents. How can I hide/filter the unnecessary nodes?

Grubman answered 6/5, 2009 at 21:18 Comment(1)

this is an outdated and less informative thread than this duplicate: https://mcmap.net/q/438636/-filtering-on-a-jtree-closed – Skipjack 15/8, 2012 at 9:48

G

9

My eventual implementation:

Have two TreeModels, the underlying one and the filtered one.
When a change occurs on the underlying TreeModel, rebuild the filtered TreeModel from scratch. Clone each node that should be visible, and add it to its first visible ancestor in the filtered TreeModel (or the root if none are visible). See teh codez below, if you're curious.
This has the unfortunate side effect of collapsing every path the user had open. To get around this, I added a TreeModelListener to the filtered TreeModel. When the model changes, I save the expanded paths in the JTree (using getExpandedDescendants()), then re-expand them later (using SwingUtilities.invokeLater()).

I had to override equals() in the TreeNode class I was using so that the new cloned nodes would be the same as the old cloned nodes.

  ...
  populateFilteredNode(unfilteredRoot, filteredRoot);
  ...

  void populateFilteredNode(TreeNode unfilteredNode, TreeNode filteredNode)
  {
    for (int i = 0; i < unfilteredNode.getChildCount(); i++)
    {
      TreeNode unfilteredChildNode = unfilteredNode.getChildAt(i);

      if (unfilteredChildNode.getType() == Type.INVISIBLE_FOLDER)
      {
        populateFilteredNode(unfilteredChildNode, filteredNode);
      }
      else
      {
        TreeNode filteredChildNode = unfilteredChildNode.clone();

        filteredNode.add(filteredChildNode);

        populateFilteredNode(unfilteredChildNode, filteredChildNode);
      }
    }
  }

Grubman answered 7/5, 2009 at 19:10 Comment(0)

A

3

You should be aware of GlazedLists. It's a fantastic library for doing complex table transformations with little effort. They've also expanded to trees too. It may require a little refactoring of your existing code to get it into the GlazedLists way of working. But check out the demo and the webcasts to see how powerful it is. (It's one of the essential Swing libraries in my view, and it's open source.)

Abed answered 14/8, 2009 at 7:55 Comment(2)

I see nothing in GlazedLists for trees: java.net/projects/glazedlists/sources/svn/show/trunk/source/ca/… Please can you tell us where you found its filtering APIs for trees? – Poetics 7/4, 2014 at 14:28

@Poetics it's within the extensions folder: java.net/projects/glazedlists/sources/svn/show/trunk/extensions/… – Abed 7/4, 2014 at 14:48

D

2

Have you tried JXTree ? (unfortunately the website is down right now, but you can google for mirrors)

Derna answered 7/5, 2009 at 20:2 Comment(1)

Actually, the support of filters in JXTree has never been implemented even though it was planned, I just see a protected unused field about filtering in its source code. – Poetics 7/4, 2014 at 18:31

T

2

Take a look at this implementation: http://www.java2s.com/Code/Java/Swing-Components/InvisibleNodeTreeExample.htm

It creates subclasses of DefaultMutableNode adding a "isVisible" property rather then actually removing/adding nodes from the TreeModel.

Toliver answered 14/12, 2012 at 10:7 Comment(1)

I recently needed to implement filtering in a JTree and this solution was by far the cleanest and simplest. – Distich 28/11, 2016 at 9:1

M

1

If you're looking for a commercial solution, JideSoft has a filterable treemodel. Other than that, SwingX has a Filter API which'll work on JXTable, JXTreeTable, JXTree, and JXList.

Memphian answered 10/5, 2009 at 18:32 Comment(6)

Thanks! I tried the Jide one, but I couldn't get it to do what I wanted. I will look into the SwingX API when I get a chance. – Grubman 14/5, 2009 at 18:18

What exactly are you trying to do? If you provide details, I might be able to give some specific code. From what I understand, the filtered leaves from the search criteria will be shown, along with their parents. This is shown in their webstart demo, at jidesoft.com/products/download.htm, 'Demo for all JIDE Products'. In this, look at the QuickFilter (Tree) Demo. – Memphian 15/5, 2009 at 7:16

As I recall, I was having trouble getting the Jide tree model to show the visible children of invisible parents. – Grubman 18/5, 2009 at 17:40

I'm not able to follow you. Can you give a detailed explanation? – Memphian 21/5, 2009 at 6:31

Amanda S, did you mean that your filter indicates that the parents should be hidden except when at least one of their children is visible? This kind of case is handled by this code: adrianwalker.org/2012/04/filtered-jtree.html – Poetics 7/4, 2014 at 14:31

Actually, the support of filters in JXTree has never been implemented even though it was planned, I just see a protected unused field about filtering in its source code. – Poetics 7/4, 2014 at 18:32

O

0

So long as it is still a tree you are displaying, then TreeModel that filters you existing TreeModel should be simple enough.

Obsolesce answered 6/5, 2009 at 21:21 Comment(5)

Can you explain this further? – Grubman 6/5, 2009 at 21:24

What do you want to know. You'll find it easier to find examples that do the same to TableModel. You want to create a TreeModel that delegates to your current model, but removes the nodes you don't want to appear. I suggest, at least to start with, you make all the event propagate as structureChanged (although come to think of it that'll cause the tree expansion to collapse). – Obsolesce 6/5, 2009 at 23:52

Part of the problem is that "removing nodes that I don't want to appear" removes their children too, even though I might want to show them. – Grubman 7/5, 2009 at 0:23

Your going to need some kind of parent there. JTree (more importantly the PL&Fs) don't have a way to represent a child with an elided parent. If you want something which changes the way a tree is drawn, you'll need to get inside specific PL&F implementations. – Obsolesce 7/5, 2009 at 0:42

I could add the node to a "visible" ancestor (or the root, if all the node's ancestors are hidden), but this is a pain if I ever unhide any of the nodes in between. – Grubman 7/5, 2009 at 1:22

S

0

Leverage the code you use to build your TreeNode(s) and rebuild the TreeNode(s) only including the elements you want. Set the root node on the TreeModel with the filtered root node.

Sale answered 6/5, 2009 at 21:58 Comment(1)

It's doable but when you set another model, JTree does a lot of things under the hood, especially if it detects a structural change. It's not very good in terms of performance, both for speed and memory footprint. – Poetics 7/4, 2014 at 18:33

Recommended topics

Hot tags