Added support for -fx-underline-dash-array and -fx-underline-cap

Author: afester

richtextfx-demos/src/main/resources/org/fxmisc/richtext/demo/spellchecking.css

@@ -1,43 +1,6 @@
-.keyword {
-    -fx-fill: purple;
-    -fx-font-weight: bold;
-}
-
 .underlined {
     -fx-underline-color: red;
     -fx-underline-dash-array: 2 2;
     -fx-underline-width: 1;
     -fx-underline-cap: butt;
 }
-
-.url {
-    -fx-underline-color: blue;
-    -fx-underline-width: 0.5;
-}
-
-.semicolon {
-    -fx-font-weight: bold;
-}
-.paren {
-    -fx-fill: firebrick;
-    -fx-font-weight: bold;
-}
-.bracket {
-    -fx-fill: darkgreen;
-    -fx-font-weight: bold;
-}
-.brace {
-    -fx-fill: teal;
-    -fx-font-weight: bold;
-}
-.string {
-    -fx-fill: blue;
-}
-
-.comment {
-	-fx-fill: cadetblue;
-}
-
-.paragraph-box:has-caret {
-    -fx-background-color: #f2f9fc;
-}

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

@@ -1,6 +1,7 @@
 package org.fxmisc.richtext;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.BiConsumer;
@@ -17,6 +18,7 @@
 import javafx.scene.paint.Paint;
 import javafx.scene.shape.Path;
 import javafx.scene.shape.PathElement;
+import javafx.scene.shape.StrokeLineCap;
 
 import org.reactfx.value.Val;
 import org.reactfx.value.Var;
@@ -190,47 +192,101 @@ private void updateBackgroundShapes() {
         FilteredList<Node> nodeList = getChildren().filtered(node -> node instanceof TextExt);
         for (Node node : nodeList) {
             TextExt text = (TextExt) node;
-            Path backgroundShape = backgroundShapes.get(index);
             int end = start + text.getText().length();
 
-            // Set fill
-            Paint paint = text.backgroundFillProperty().get();
-            if (paint != null) {
-                backgroundShape.setFill(paint);
+            updateBackground(text, start, end, index);
+            updateUnderline(text, start, end, index);
 
-                // Set path elements
-                PathElement[] shape = getRangeShape(start, end);
-                backgroundShape.getElements().setAll(shape);
-            }
+            start = end;
+            index++;
+        }
+    }
+
+
+    /**
+     * Updates the background shape for a text segment.
+     *
+     * @param text  The text node which specified the style attributes
+     * @param start The index of the first character 
+     * @param end   The index of the last character
+     * @param index The index of the background shape
+     */
+    private void updateBackground(TextExt text, int start, int end, int index) {
+        // Set fill
+        Paint paint = text.backgroundFillProperty().get();
+        if (paint != null) {
+            Path backgroundShape = backgroundShapes.get(index);
+            backgroundShape.setFill(paint);
+
+            // Set path elements
+            PathElement[] shape = getRangeShape(start, end);
+            backgroundShape.getElements().setAll(shape);
+        }
+    }
 
-            // set underline
-            Path underlineShape = underlineShapes.get(index);
-            Paint underlineStroke = text.underlineStrokeProperty().get();
-            Number underlineStrokeWidth = text.underlineStrokeWidthProperty().get();
-            Number underlineStrokeDashSize = text.underlineStrokeDashSizeProperty().get();
-            if (underlineStroke != null) {
-                underlineShape.setStroke(underlineStroke);
-            }
-            if (underlineStrokeWidth != null) {
-                underlineShape.setStrokeWidth(underlineStrokeWidth.doubleValue());
-            }
-            if (underlineStrokeDashSize != null) {
-                double dashSize = underlineStrokeDashSize.doubleValue();
-                Double[] dashArray = {dashSize, dashSize}; 
-	            underlineShape.getStrokeDashArray().addAll(dashArray);
-            }
 
-            if (underlineStroke != null || underlineStrokeWidth != null) {
-                // Set path elements
-                PathElement[] shape = getUnderlineShape(start, end);
-                underlineShape.getElements().setAll(shape);
+    /**
+     * Updates the shape which renders the text underline.
+     * 
+     * @param text  The text node which specified the style attributes
+     * @param start The index of the first character 
+     * @param end   The index of the last character
+     * @param index The index of the background shape
+     */
+    private void updateUnderline(TextExt text, int start, int end, int index) {
+
+        // get all CSS properties for the underline
+
+        Paint underlineColor = text.underlineColorProperty().get();
+        Number underlineWidth = text.underlineWidthProperty().get();
+
+        // get the dash array - JavaFX CSS parser seems to return either a Number[] array
+        // or a single value, depending on whether only one or more than one value has been
+        // specified in the CSS
+        Double[] underlineDashArray = null;
+        Object underlineDashArrayProp = text.underlineDashArrayProperty().get();
+        if (underlineDashArrayProp != null) {
+            if (underlineDashArrayProp.getClass().isArray()) {
+                Number[] numberArray = (Number[]) underlineDashArrayProp;
+                underlineDashArray = new Double[numberArray.length];
+                int idx = 0;
+                for (Number d : numberArray) {
+                    underlineDashArray[idx++] = (Double) d;
+                }
+            } else {
+                underlineDashArray = new Double[1];
+                underlineDashArray[0] = ((Double) underlineDashArrayProp).doubleValue();
             }
+        }
 
-            start = end;
-            index++;
+        StrokeLineCap underlineCap = text.underlineCapProperty().get();
+
+        // apply style and render the underline
+
+        Path underlineShape = underlineShapes.get(index);
+        if (underlineColor != null) {
+            underlineShape.setStroke(underlineColor);
+        }
+        if (underlineWidth != null) {
+            underlineShape.setStrokeWidth(underlineWidth.doubleValue());
+        }
+        if (underlineDashArray != null) {
+            underlineShape.getStrokeDashArray().addAll(underlineDashArray);
+            underlineShape.setStrokeLineCap(StrokeLineCap.BUTT);
+        }
+        if (underlineCap != null) {
+            underlineShape.setStrokeLineCap(underlineCap);
+        }
+
+        if (underlineColor != null || underlineWidth != null) {
+            
+            // Set path elements
+            PathElement[] shape = getUnderlineShape(start, end);
+            underlineShape.getElements().setAll(shape);
         }
     }
 
+
     @Override
     protected void layoutChildren() {
         super.layoutChildren();