Allow Text as graphic node for numbered lists, including tests (#419)

* Allow Text as graphic node for numbered lists, including tests

* avoid casting

Author: jperedadnr

rta/src/main/java/com/gluonhq/richtextarea/ParagraphTile.java

@@ -219,35 +219,26 @@ private void updateGraphicBox(Layer layer, BiFunction<Integer, ParagraphDecorati
         graphicBox.getChildren().add(graphicNode);
 
         double nodePrefWidth = 0d, nodePrefHeight = 0d;
-         if (graphicNode instanceof Label) {
-            Label numberedListLabel = (Label) graphicNode;
-            String text = numberedListLabel.getText();
+        Font font = layer.getFont();
+        if (graphicNode instanceof Label label) {
+            String text = label.getText();
             if (text != null) {
-                if (text.contains("#")) {
-                    // numbered list
-                    AtomicInteger ordinal = new AtomicInteger();
-                    viewModel.getParagraphList().stream()
-                            .peek(p -> {
-                                if (p.getDecoration().getGraphicType() != ParagraphDecoration.GraphicType.NUMBERED_LIST ||
-                                        p.getDecoration().getIndentationLevel() != indentationLevel) {
-                                    // restart ordinal if previous paragraph has different indentation,
-                                    // or if it is not a numbered list
-                                    ordinal.set(0);
-                                } else {
-                                    ordinal.incrementAndGet();
-                                }
-                            })
-                            .filter(p -> paragraph.equals(p))
-                            .findFirst()
-                            .ifPresent(p ->
-                                    numberedListLabel.setText(text.replace("#", "" + ordinal.get())));
-                }
-
-                Font font = layer.getFont();
-                numberedListLabel.setFont(font);
-                double w = Tools.computeStringWidth(font, numberedListLabel.getText());
+                text = formatNumber(text, indentationLevel);
+                label.setText(text);
+                label.setFont(font);
+                double w = Tools.computeStringWidth(font, text);
+                nodePrefWidth = Math.max(w + 1, INDENT_PADDING);
+                nodePrefHeight = Tools.computeStringHeight(font, text);
+            }
+        } else if (graphicNode instanceof Text textNode) {
+            String text = textNode.getText();
+            if (text != null) {
+                text = formatNumber(text, indentationLevel);
+                textNode.setText(text);
+                textNode.setFont(font);
+                double w = Tools.computeStringWidth(font, text);
                 nodePrefWidth = Math.max(w + 1, INDENT_PADDING);
-                nodePrefHeight = Tools.computeStringHeight(font, numberedListLabel.getText());
+                nodePrefHeight = Tools.computeStringHeight(font, text);
             }
         } else {
             nodePrefWidth = Math.max(graphicNode.prefWidth(-1), INDENT_PADDING);
@@ -261,6 +252,29 @@ private void updateGraphicBox(Layer layer, BiFunction<Integer, ParagraphDecorati
         layer.updatePrefWidth(richTextAreaSkin.textFlowPrefWidthProperty.get() - boxPrefWidth);
     }
 
+    private String formatNumber(String text, int indentationLevel) {
+        if (text.contains("#")) {
+            // numbered list
+            AtomicInteger ordinal = new AtomicInteger();
+            return viewModel.getParagraphList().stream()
+                    .peek(p -> {
+                        if (p.getDecoration().getGraphicType() != ParagraphDecoration.GraphicType.NUMBERED_LIST ||
+                                p.getDecoration().getIndentationLevel() != indentationLevel) {
+                            // restart ordinal if previous paragraph has different indentation,
+                            // or if it is not a numbered list
+                            ordinal.set(0);
+                        } else {
+                            ordinal.incrementAndGet();
+                        }
+                    })
+                    .filter(p -> paragraph.equals(p))
+                    .findFirst()
+                    .map(p -> text.replace("#", "" + ordinal.get()))
+                    .orElse(text);
+        }
+        return text;
+    }
+
     void mousePressedListener(MouseEvent e) {
         if (control.isDisabled()) {
             return;

rta/src/test/java/com/gluonhq/richtextarea/ui/RTATest.java

@@ -44,6 +44,7 @@
 import javafx.geometry.Orientation;
 import javafx.scene.Node;
 import javafx.scene.Scene;
+import javafx.scene.control.Label;
 import javafx.scene.control.ScrollBar;
 import javafx.scene.control.ToggleButton;
 import javafx.scene.image.ImageView;
@@ -65,6 +66,7 @@
 import org.testfx.matcher.base.NodeMatchers;
 
 import java.nio.CharBuffer;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Locale;
 import java.util.concurrent.CountDownLatch;
@@ -1148,6 +1150,66 @@ public void findMarkdownTest(FxRobot robot) {
         assertEquals(2, rta.getDocument().getDecorations().size());
     }
 
+    @Test
+    public void defaultNumberedListTest(FxRobot robot) {
+        run(() -> {
+            String text = "Hello\nRTA";
+            TextDecoration textDecoration = TextDecoration.builder().presets().fontFamily("Arial").build();
+            ParagraphDecoration paragraphDecoration = ParagraphDecoration.builder().presets()
+                    .graphicType(ParagraphDecoration.GraphicType.NUMBERED_LIST)
+                    .indentationLevel(1).build();
+            Document document = new Document(text,
+                    List.of(new DecorationModel(0, text.length(), textDecoration, paragraphDecoration)), text.length());
+            richTextArea.getActionFactory().open(document).execute(new ActionEvent());
+        });
+        waitForFxEvents();
+
+        verifyThat(".rich-text-area", node -> node instanceof RichTextArea);
+        List<Node> nodes = getSortedNodes(robot, ".numbered-list-label");
+        assertEquals(2, nodes.size());
+        for (int i = 0; i < 2; i++) {
+            assertInstanceOf(Label.class, nodes.get(i));
+            Label label = (Label)  nodes.get(i);
+            assertNotNull(label);
+            assertNotNull(label.getText());
+            assertEquals(i + 1 + ".", label.getText());
+        }
+    }
+
+    @Test
+    public void customNumberedListTest(FxRobot robot) {
+        run(() -> {
+            String text = "Hello\nRTA";
+            TextDecoration textDecoration = TextDecoration.builder().presets().fontFamily("Arial").build();
+            ParagraphDecoration paragraphDecoration = ParagraphDecoration.builder().presets()
+                    .graphicType(ParagraphDecoration.GraphicType.NUMBERED_LIST)
+                    .indentationLevel(1).build();
+            Document document = new Document(text,
+                    List.of(new DecorationModel(0, text.length(), textDecoration, paragraphDecoration)), text.length());
+            richTextArea.setParagraphGraphicFactory((i, t) -> {
+                if (i < 1) {
+                    return null;
+                }
+                Text textNode = new Text("#");
+                textNode.getStyleClass().add("numbered-list-text");
+                return textNode;
+            });
+            richTextArea.getActionFactory().open(document).execute(new ActionEvent());
+        });
+        waitForFxEvents();
+
+        verifyThat(".rich-text-area", node -> node instanceof RichTextArea);
+        List<Node> nodes = getSortedNodes(robot, ".numbered-list-text");
+        assertEquals(2, nodes.size());
+        for (int i = 0; i < 2; i++) {
+            assertInstanceOf(Text.class, nodes.get(i));
+            Text textNode = (Text) nodes.get(i);
+            assertNotNull(textNode);
+            assertNotNull(textNode.getText());
+            assertEquals(String.valueOf(i + 1), textNode.getText());
+        }
+    }
+
     private static void findEmoji(String text, BiConsumer<Emoji, Integer> onCodeNameFound) {
         if (text.endsWith(" ")) {
             return;
@@ -1208,6 +1270,12 @@ private String getInternalText(Document document, int end) {
         return internalSb.toString();
     }
 
+    private static List<Node> getSortedNodes(FxRobot robot, String query) {
+        return robot.lookup(query).queryAllAs(Node.class).stream()
+                .sorted(Comparator.comparingDouble(s -> s.localToScene(s.getLayoutBounds()).getMinY()))
+                .collect(Collectors.toList());
+    }
+
     private void run(Runnable runnable) {
         CountDownLatch countDownLatch = new CountDownLatch(1);
         Platform.runLater(() -> {