Tweaked the GTree for restoring selection and expanded nodes when

filtering

Author: ghidravore

Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java

@@ -325,6 +325,7 @@ public GTreeState getRestoreTreeState() {
 	 * <p>
 	 * <b>Note: </b>See the usage note at the header of this class concerning how tree state
 	 * is used relative to the <tt>equals()</tt> method.
+	 * @return the saved state
 	 */
 	public GTreeState getTreeState() {
 		return new GTreeState(this);
@@ -340,10 +341,11 @@ public GTreeState getTreeState(GTreeNode node) {
 	 * <p>
 	 * <b>Note: </b>See the usage note at the header of this class concerning how tree state
 	 * is used relative to the <tt>equals()</tt> method.
+	 * 
+	 * @param state the state to restore
 	 *
 	 * @see #getTreeState()
 	 * @see #getTreeState(GTreeNode)
-	 * @see #cloneTreeState()
 	 */
 	public void restoreTreeState(GTreeState state) {
 		runTask(new GTreeRestoreTreeStateTask(this, state));
@@ -355,12 +357,16 @@ public void restoreTreeState(GTreeState state) {
 	 * that should be opened have been opened.  Thus any other nodes are closed and can be
 	 * disposed, if desired.
 	 *
-	 * @param taskMonitor
+	 * @param taskMonitor the TaskMonitor
 	 */
-	public void expandedStateRestored(TaskMonitor onitor) {
+	public void expandedStateRestored(TaskMonitor taskMonitor) {
 		// optional
 	}
 
+	public List<TreePath> getExpandedPaths() {
+		return getExpandedPaths(getViewRoot());
+	}
+
 	public List<TreePath> getExpandedPaths(GTreeNode node) {
 		Enumeration<TreePath> expandedPaths = tree.getExpandedDescendants(node.getTreePath());
 		if (expandedPaths == null) {
@@ -592,7 +598,7 @@ private GTreeNode getNodeForPath(GTreeNode root, TreePath path) {
 
 		GTreeNode node = (GTreeNode) path.getLastPathComponent();
 		if (path.getPathCount() == 1) {
-			if (root.getId() == node.getId()) {
+			if (root.equals(node)) {
 				return root;
 			}
 			return null; // invalid path--the root of the path is not equal to our root!
@@ -609,7 +615,7 @@ private GTreeNode getNodeForPath(GTreeNode root, TreePath path) {
 		GTreeNode lastPathComponent = (GTreeNode) path.getLastPathComponent();
 		List<GTreeNode> children = parentNode.getChildren();
 		for (GTreeNode child : children) {
-			if (child.getId() == lastPathComponent.getId()) {
+			if (child.equals(lastPathComponent)) {
 				return child;
 			}
 		}
@@ -825,7 +831,8 @@ public GTreeNode getViewRoot() {
 
 	/**
 	 * This method is useful for debugging tree problems.  Don't know where else to put it.
-	 * @param name - Use this to indicate what tree event occurred ("node inserted" "node removed", etc.)
+	 * @param out the output writer
+	 * @param name use this to indicate what tree event occurred ("node inserted" "node removed", etc.)
 	 * @param e the TreeModelEvent;
 	 */
 	public static void printEvent(PrintWriter out, String name, TreeModelEvent e) {

Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeNode.java

@@ -393,15 +393,6 @@ public String toString() {
 		return getName();
 	}
 
-	/**
-	 * Returns an id for this node that is unique among all GTreeNodes in this running JVM.
-	 * If this node is cloned, the clone will have the same id.
-	 * @return the unique id for this node.
-	 */
-	public long getId() {
-		return id;
-	}
-
 	/**
 	 * Notifies the tree that the node has different children.  This method 
 	 * @param node the node that has changed.

Ghidra/Framework/Docking/src/test.slow/java/docking/widgets/tree/GTreeTest.java

@@ -527,6 +527,39 @@ public void testGetAndRestoreTreeState() {
 		assertEquals(originalNode, selectionPath.getLastPathComponent());
 	}
 
+	@Test
+	public void testGetAndRestoreTreeState_ExpandedStateOnly() {
+		//
+		// Test that we can setup the tree, record its expanded state, change the tree 
+		// and then restore the saved state
+		//
+
+		GTreeNode originalNode = findNodeInTree("Leaf Child - Many B1").getParent();
+		assertNotNull("Did not find existing child node in non filtered tree", originalNode);
+
+		gTree.expandPath(originalNode);
+		waitForTree();
+
+		List<TreePath> expandedPaths = gTree.getExpandedPaths();
+		assertEquals(3, expandedPaths.size());
+		assertEquals(originalNode, expandedPaths.get(0).getLastPathComponent());
+
+		GTreeState treeState = gTree.getTreeState();
+
+		gTree.collapseAll(gTree.getViewRoot());
+		waitForTree();
+
+		expandedPaths = gTree.getExpandedPaths();
+		assertTrue(expandedPaths.isEmpty());
+
+		gTree.restoreTreeState(treeState);
+		waitForTree();
+
+		expandedPaths = gTree.getExpandedPaths();
+		assertEquals(3, expandedPaths.size());
+		assertEquals(originalNode, expandedPaths.get(0).getLastPathComponent());
+	}
+
 	@Test
 	public void testFilterPathsRestoredWithFurtherFiltering_NoSelection() throws Exception {
 
@@ -872,8 +905,8 @@ private GTreeNode findNodeInTree(GTreeNode node, String name) {
 	private void setFilterOptions(final TextFilterStrategy filterStrategy, final boolean inverted) {
 		runSwing(() -> {
 			FilterOptions filterOptions = new FilterOptions(filterStrategy, false, false, inverted);
-			((DefaultGTreeFilterProvider) gTree.getFilterProvider()).setFilterOptions(
-				filterOptions);
+			((DefaultGTreeFilterProvider) gTree.getFilterProvider())
+					.setFilterOptions(filterOptions);
 		});
 		waitForTree();
 

Ghidra/Framework/Docking/src/test/java/docking/widgets/tree/GTreeNodeTest.java

@@ -61,7 +61,7 @@ public void setUp() {
 	public void testClone() throws CloneNotSupportedException {
 		GTreeNode clone = node0.clone();
 
-		assertEquals(node0.getId(), clone.getId());
+		assertTrue(node0.equals(clone));
 		assertNull(clone.getParent());
 		assertFalse(clone.isLoaded());
 	}