Issue594: fixed review issues, added separate sub classes for various path types

Author: afester

richtextfx/src/integrationTest/java/org/fxmisc/richtext/SceneGraphTests.java

@@ -0,0 +1,82 @@
+package org.fxmisc.richtext;
+
+import static org.junit.Assert.assertNotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.fxmisc.flowless.Cell;
+import org.fxmisc.flowless.VirtualFlow;
+import org.fxmisc.richtext.UnderlinePath;
+
+import javafx.scene.Node;
+import javafx.scene.layout.Region;
+import javafx.scene.shape.Path;
+import javafx.scene.text.Text;
+import javafx.scene.text.TextFlow;
+
+/**
+ * Contains inspection methods to analyze the scene graph which has been rendered by RichTextFX.
+ * TestFX tests should subclass this if it needs to run tests on a simple area and needs to inspect
+ * whether the scene graph has been properly created.
+ */
+public abstract class SceneGraphTests extends InlineCssTextAreaAppTest {
+
+    /**
+     * @param index The index of the desired paragraph box
+     * @return The paragraph box for the paragraph at the specified index
+     */
+    protected Region getParagraphBox(int index) {
+        @SuppressWarnings("unchecked")
+        VirtualFlow<String, Cell<String, Node>> flow = (VirtualFlow<String, Cell<String, Node>>) area.getChildrenUnmodifiable().get(index);
+        Cell<String, Node> gsa = flow.getCell(0);
+
+        // get the ParagraphBox (protected subclass of Region) 
+        return (Region) gsa.getNode();
+    }
+    
+    
+    /**
+     * @param index The index of the desired paragraph box
+     * @return The ParagraphText (protected subclass of TextFlow) for the paragraph at the specified index
+     */
+    protected TextFlow getParagraphText(int index) {
+        // get the ParagraphBox (protected subclass of Region) 
+        Region paragraphBox = getParagraphBox(index);
+
+        // get the ParagraphText (protected subclass of TextFlow)
+        TextFlow tf = (TextFlow) paragraphBox.getChildrenUnmodifiable().stream().filter(n -> n instanceof TextFlow)
+                                 .findFirst().orElse(null);
+        assertNotNull("No TextFlow node found in rich text area", tf);
+
+        return tf;
+    }
+
+
+    /**
+     * @param index The index of the desired paragraph box
+     * @return A list of text nodes which render the text in the ParagraphBox 
+     *         specified by the given index.
+     */
+    protected List<Text> getTextNodes(int index) {
+        TextFlow tf = getParagraphText(index);
+
+        List<Text> result = new ArrayList<>();
+        tf.getChildrenUnmodifiable().filtered(n -> n instanceof Text).forEach(n -> result.add((Text) n));
+        return result;
+    }
+
+
+    /**
+     * @param index The index of the desired paragraph box
+     * @return A list of nodes which render the underlines for the text in the ParagraphBox 
+     *         specified by the given index.
+     */
+    protected List<Path> getUnderlinePaths(int index) {
+        TextFlow tf = getParagraphText(index);
+
+        List<Path> result = new ArrayList<>();
+        tf.getChildrenUnmodifiable().filtered(n -> n instanceof UnderlinePath).forEach(n -> result.add((Path) n));
+        return result;
+    }
+}

richtextfx/src/integrationTest/java/org/fxmisc/richtext/style/StylingTests.java

@@ -1,78 +1,17 @@
 package org.fxmisc.richtext.style;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
 
-import java.util.ArrayList;
 import java.util.List;
 
-import org.fxmisc.flowless.Cell;
-import org.fxmisc.flowless.VirtualFlow;
-import org.fxmisc.richtext.InlineCssTextAreaAppTest;
+import org.fxmisc.richtext.SceneGraphTests;
 import org.junit.Test;
 
-import javafx.scene.Node;
-import javafx.scene.layout.Region;
 import javafx.scene.shape.Path;
 import javafx.scene.text.Text;
-import javafx.scene.text.TextFlow;
 
 
-abstract class RenderingTests extends InlineCssTextAreaAppTest {
-
-    /**
-     * 
-     * @param index The index of the desired paragraph box
-     * @return The paragraph box for the paragraph at the specified index
-     */
-    protected Region getParagraphBox(int index) {
-        @SuppressWarnings("unchecked")
-        VirtualFlow<String, Cell<String, Node>> flow = (VirtualFlow<String, Cell<String, Node>>) area.getChildrenUnmodifiable().get(index);
-        Cell<String, Node> gsa = flow.getCell(0);
-
-        // get the ParagraphBox (protected subclass of Region) 
-        return (Region) gsa.getNode();
-    }
-    
-
-    /**
-     * @return A list of text nodes which render the current text.
-     */
-    protected List<Text> getTextNodes() {
-        // get the ParagraphBox (protected subclass of Region) 
-        Region paragraphBox = getParagraphBox(0);
-
-        // get the ParagraphText (protected subclass of TextFlow)
-        TextFlow tf = (TextFlow) paragraphBox.getChildrenUnmodifiable().stream().filter(n -> n instanceof TextFlow)
-                                 .findFirst().orElse(null);
-        assertNotNull("No TextFlow node found in rich text area", tf);
-
-        List<Text> result = new ArrayList<>();
-        tf.getChildrenUnmodifiable().filtered(n -> n instanceof Text).forEach(n -> result.add((Text) n));
-        return result;
-    }
-
-    /**
-     * @return A list of nodes which render the underlines for the current text.
-     */
-    protected List<Path> getUnderlinePaths() {
-        // get the ParagraphBox (protected subclass of Region) 
-        Region paragraphBox = getParagraphBox(0);
-        
-        // get the ParagraphText (protected subclass of TextFlow) 
-        TextFlow tf = (TextFlow) paragraphBox.getChildrenUnmodifiable().get(0);
-
-        List<Path> result = new ArrayList<>();
-        tf.getChildrenUnmodifiable().filtered(n -> n instanceof Path).forEach(n -> result.add((Path) n));
-        
-        result.forEach(n -> System.err.println(n.getClass()));
-        
-        return result.subList(2, result.size());
-    }
-}
-
-
-public class StylingTests extends RenderingTests {
+public class StylingTests extends SceneGraphTests {
 
     private final static String HELLO = "Hello ";
     private final static String WORLD = "World";
@@ -88,15 +27,15 @@ public void simpleStyling() {
         });
 
         // expected: one text node which contains the complete text
-        List<Text> textNodes = getTextNodes();
+        List<Text> textNodes = getTextNodes(0);
         assertEquals(1, textNodes.size());
 
         interact(() -> {
             area.setStyle(HELLO.length(), HELLO.length() + WORLD.length(), "-fx-font-weight: bold;");
         });
 
         // expected: three text nodes
-        textNodes = getTextNodes();
+        textNodes = getTextNodes(0);
         assertEquals(3, textNodes.size());
 
         Text first = textNodes.get(0);
@@ -124,7 +63,7 @@ public void underlineStyling() {
         });
 
         // expected: one text node which contains the complete text
-        List<Text> textNodes = getTextNodes();
+        List<Text> textNodes = getTextNodes(0);
         assertEquals(1, textNodes.size());
         assertEquals(HELLO + WORLD + AND_ALSO_THE + SUN + AND_MOON, 
                      textNodes.get(0).getText());
@@ -140,7 +79,7 @@ public void underlineStyling() {
         });
 
         // expected: five text nodes
-        textNodes = getTextNodes();
+        textNodes = getTextNodes(0);
         assertEquals(5, textNodes.size());
 
         Text first = textNodes.get(0);
@@ -155,7 +94,7 @@ public void underlineStyling() {
         assertEquals(AND_MOON, fifth.getText());
 
         // determine the underline paths - need to be two of them!
-        List<Path> underlineNodes = getUnderlinePaths();
+        List<Path> underlineNodes = getUnderlinePaths(0);
         assertEquals(2, underlineNodes.size());
     }
 }

richtextfx/src/main/java/org/fxmisc/richtext/BackgroundPath.java

@@ -0,0 +1,10 @@
+package org.fxmisc.richtext;
+
+import javafx.scene.shape.Path;
+
+/**
+ * A path which describes a background shape in the Scene graph.
+ * 
+ */
+public class BackgroundPath extends Path {
+}

richtextfx/src/main/java/org/fxmisc/richtext/BorderPath.java

@@ -0,0 +1,10 @@
+package org.fxmisc.richtext;
+
+import javafx.scene.shape.Path;
+
+/**
+ * A path which describes a border in the Scene graph.
+ * 
+ */
+public class BorderPath extends Path {
+}

richtextfx/src/main/java/org/fxmisc/richtext/CaretPath.java

@@ -0,0 +1,10 @@
+package org.fxmisc.richtext;
+
+import javafx.scene.shape.Path;
+
+/**
+ * A path which describes a selection shape in the Scene graph.
+ * 
+ */
+public class CaretPath extends Path {
+}

richtextfx/src/main/java/org/fxmisc/richtext/ParagraphText.java

@@ -56,8 +56,8 @@ public ObjectProperty<Paint> highlightTextFillProperty() {
 
     private final Paragraph<PS, SEG, S> paragraph;
 
-    private final Path caretShape = new Path();
-    private final Path selectionShape = new Path();
+    private final Path caretShape = new CaretPath();
+    private final Path selectionShape = new SelectionPath();
 
     private final CustomCssShapeHelper<Paint> backgroundShapeHelper;
     private final CustomCssShapeHelper<BorderAttributes> borderShapeHelper;
@@ -71,9 +71,6 @@ public ObjectProperty<Paint> highlightTextFillProperty() {
         caretShape.visibleProperty().bind(caretVisible);
     }
 
-    private final class UnderlinePath extends Path{
-    }
-
     ParagraphText(Paragraph<PS, SEG, S> par, Function<StyledSegment<SEG, S>, Node> nodeFactory) {
         this.paragraph = par;
 
@@ -118,18 +115,33 @@ private final class UnderlinePath extends Path{
         par.getStyledSegments().stream().map(nodeFactory).forEach(getChildren()::add);
 
         // set up custom css shape helpers
-        Supplier<Path> createShape = () -> {
+        Supplier<Path> createBackgroundShape = () -> {
+            Path shape = new BackgroundPath();
+            shape.setManaged(false);
+            shape.layoutXProperty().bind(leftInset);
+            shape.layoutYProperty().bind(topInset);
+            return shape;
+        };
+        Supplier<Path> createBorderShape = () -> {
+            Path shape = new BorderPath();
+            shape.setManaged(false);
+            shape.layoutXProperty().bind(leftInset);
+            shape.layoutYProperty().bind(topInset);
+            return shape;
+        };
+        Supplier<Path> createUnderlineShape = () -> {
             Path shape = new UnderlinePath();
             shape.setManaged(false);
             shape.layoutXProperty().bind(leftInset);
             shape.layoutYProperty().bind(topInset);
             return shape;
         };
+
         Consumer<Collection<Path>> clearUnusedShapes = paths -> getChildren().removeAll(paths);
         Consumer<Path> addToBackground = path -> getChildren().add(0, path);
         Consumer<Path> addToForeground = path -> getChildren().add(path);
         backgroundShapeHelper = new CustomCssShapeHelper<>(
-                createShape,
+                createBackgroundShape,
                 (backgroundShape, tuple) -> {
                     backgroundShape.setStrokeWidth(0);
                     backgroundShape.setFill(tuple._1);
@@ -139,7 +151,7 @@ private final class UnderlinePath extends Path{
                 clearUnusedShapes
         );
         borderShapeHelper = new CustomCssShapeHelper<>(
-                createShape,
+                createBorderShape,
                 (borderShape, tuple) -> {
                     BorderAttributes attributes = tuple._1;
                     borderShape.setStrokeWidth(attributes.width);
@@ -156,7 +168,7 @@ private final class UnderlinePath extends Path{
                 clearUnusedShapes
         );
         underlineShapeHelper = new CustomCssShapeHelper<>(
-                createShape,
+                createUnderlineShape,
                 (underlineShape, tuple) -> {
                     UnderlineAttributes attributes = tuple._1;
                     underlineShape.setStroke(attributes.color);

richtextfx/src/main/java/org/fxmisc/richtext/SelectionPath.java

@@ -0,0 +1,10 @@
+package org.fxmisc.richtext;
+
+import javafx.scene.shape.Path;
+
+/**
+ * A path which describes a selection shape in the Scene graph.
+ * 
+ */
+public class SelectionPath extends Path {
+}

richtextfx/src/main/java/org/fxmisc/richtext/UnderlinePath.java

@@ -0,0 +1,10 @@
+package org.fxmisc.richtext;
+
+import javafx.scene.shape.Path;
+
+/**
+ * A path which describes an underline in the Scene graph.
+ * 
+ */
+public class UnderlinePath extends Path {
+}