Add toTreeString methods

Author: pcastornii

patternfx-core/src/main/java/com/techsenger/patternfx/core/AbstractParentComponent.java

@@ -18,6 +18,7 @@
 
 import com.techsenger.toolkit.fx.binding.ListBinder;
 import java.util.List;
+import java.util.function.BiConsumer;
 import javafx.collections.FXCollections;
 import javafx.collections.ListChangeListener;
 import javafx.collections.ObservableList;
@@ -67,6 +68,16 @@ List<ParentViewModel<?>> getChildren(ParentViewModel<?> parent) {
             };
         }
 
+        @Override
+        public String toTreeString() {
+            return component.toTreeString(depthFirstIterator(), (c, b) -> b.append(c.getMediator().getFullName()));
+        }
+
+        @Override
+        public String toTreeString(BiConsumer<ParentViewModel<?>, StringBuilder> componentAppender) {
+            return component.toTreeString(depthFirstIterator(), componentAppender);
+        }
+
         @Override
         public ObservableList<ChildViewModel<?>> getChildren() {
             return children;
@@ -122,10 +133,34 @@ public ObservableList<ChildComponent<?>> getChildren() {
         return this.children;
     }
 
+    @Override
+    public String toTreeString() {
+        return toTreeString(depthFirstIterator(), (c, b) -> b.append(c.getFullName()));
+    }
+
+    @Override
+    public String toTreeString(BiConsumer<ParentComponent<?>, StringBuilder> componentAppender) {
+        return toTreeString(depthFirstIterator(), componentAppender);
+    }
+
     protected ObservableList<ChildComponent<?>> getModifiableChildren() {
         return modifiableChildren;
     }
 
     @Override
     protected abstract Mediator createMediator();
+
+    public <T> String toTreeString(SubtreeIterator<T> iterator, BiConsumer<T, StringBuilder> componentAppender) {
+        var builder = new StringBuilder();
+        var sep = System.lineSeparator();
+        while (iterator.hasNext()) {
+            var c = iterator.next();
+            if (builder.length() > 0) {
+                builder.append(sep);
+            }
+            builder.append("    ".repeat(iterator.getDepth()));
+            componentAppender.accept(c, builder);
+        }
+        return builder.toString();
+    }
 }

patternfx-core/src/main/java/com/techsenger/patternfx/core/ParentComponent.java

@@ -16,6 +16,7 @@
 
 package com.techsenger.patternfx.core;
 
+import java.util.function.BiConsumer;
 import javafx.collections.ObservableList;
 
 /**
@@ -44,4 +45,24 @@ public interface ParentComponent<T extends ParentView<?, ?>> extends Component<T
      * @return an {@link Iterator} that iterates over this component and all of its descendants
      */
     SubtreeIterator<ParentComponent<?>> breadthFirstIterator();
+
+    /**
+     * Returns a string representation of this component and all its descendants formatted as a tree.
+     *
+     * @return a tree-formatted string representation of this component
+     */
+    String toTreeString();
+
+    /**
+     * Returns a string representation of this component and all its descendants formatted as a tree, allowing the
+     * caller to append an additional note for each component.
+     *
+     * The provided {@code componentAppender} is invoked for each component and is responsible for appending the
+     * complete string representation of that component to the given {@link StringBuilder}. The tree structure and
+     * line separation are handled by this method.
+     *
+     * @param componentAppender a callback used to append the full string representation of each component.
+     * @return a tree-formatted string representation of this component
+     */
+    String toTreeString(BiConsumer<ParentComponent<?>, StringBuilder> componentAppender);
 }

patternfx-core/src/main/java/com/techsenger/patternfx/core/ParentMediator.java

@@ -16,6 +16,7 @@
 
 package com.techsenger.patternfx.core;
 
+import java.util.function.BiConsumer;
 import javafx.collections.ObservableList;
 
 /**
@@ -44,4 +45,24 @@ public interface ParentMediator extends ComponentMediator {
      * @return an {@link Iterator} that iterates over this component and all of its descendants
      */
     SubtreeIterator<ParentViewModel<?>> breadthFirstIterator();
+
+    /**
+     * Returns a string representation of this component and all its descendants formatted as a tree.
+     *
+     * @return a tree-formatted string representation of this component
+     */
+    String toTreeString();
+
+    /**
+     * Returns a string representation of this component and all its descendants formatted as a tree, allowing the
+     * caller to append an additional note for each component.
+     *
+     * <p>The provided {@code componentAppender} is invoked for each component and is responsible for appending the
+     * complete string representation of that component to the given {@link StringBuilder}. The tree structure and
+     * line separation are handled by this method.
+     *
+     * @param componentAppender a callback used to append the full string representation of each component.
+     * @return a tree-formatted string representation of this component
+     */
+    String toTreeString(BiConsumer<ParentViewModel<?>, StringBuilder> componentAppender);
 }