Merge pull request #318 from JordanMartinez/showCaret

Allow customization of caret visibility and CSS for caret blink rate.

Author: TomasMikula

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

@@ -109,4 +109,33 @@ public CssMetaData<? extends Styleable, Paint> getCssMetaData() {
             return cssMetaData;
         }
     }
+
+    static class CaretBlinkRateProperty extends StyleableObjectProperty<javafx.util.Duration> {
+        private final Object bean;
+
+        private final CssMetaData<? extends Styleable, javafx.util.Duration> cssMetaData;
+
+        public CaretBlinkRateProperty(Object bean, javafx.util.Duration initialValue) {
+            super(initialValue);
+            this.bean = bean;
+            cssMetaData = new PropertyCssMetaData<>(
+                    this, "-fx-caret-blink-rate",
+                    StyleConverter.getDurationConverter(), initialValue);
+        }
+
+        @Override
+        public Object getBean() {
+            return bean;
+        }
+
+        @Override
+        public String getName() {
+            return "caretBlinkRate";
+        }
+
+        @Override
+        public CssMetaData<? extends Styleable, javafx.util.Duration> getCssMetaData() {
+            return cssMetaData;
+        }
+    }
 }

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

@@ -1,5 +1,6 @@
 package org.fxmisc.richtext;
 
+import static javafx.util.Duration.ZERO;
 import static org.fxmisc.richtext.PopupAlignment.*;
 import static org.reactfx.EventStreams.*;
 import static org.reactfx.util.Tuples.*;
@@ -17,7 +18,6 @@
 
 import javafx.beans.binding.Binding;
 import javafx.beans.binding.Bindings;
-import javafx.beans.binding.BooleanBinding;
 import javafx.beans.binding.ObjectBinding;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ObjectProperty;
@@ -160,6 +160,13 @@ public class StyledTextArea<PS, S> extends Region
     private final StyleableObjectProperty<Paint> highlightTextFill
             = new CssProperties.HighlightTextFillProperty(this, Color.WHITE);
 
+    /**
+     * Controls the blink rate of the caret, when one is displayed. Setting
+     * the duration to zero disables blinking.
+     */
+    private final StyleableObjectProperty<javafx.util.Duration> caretBlinkRate
+            = new CssProperties.CaretBlinkRateProperty(this, javafx.util.Duration.millis(500));
+
     // editable property
     /**
      * Indicates whether this text area can be edited by the user.
@@ -181,6 +188,24 @@ public class StyledTextArea<PS, S> extends Region
     public final void setWrapText(boolean value) { wrapText.set(value); }
     public final BooleanProperty wrapTextProperty() { return wrapText; }
 
+    // showCaret property
+    /**
+     * Indicates when this text area should display a caret.
+     */
+    private final Var<CaretVisibility> showCaret = Var.newSimpleVar(CaretVisibility.AUTO);
+    public final CaretVisibility getShowCaret() { return showCaret.getValue(); }
+    public final void setShowCaret(CaretVisibility value) { showCaret.setValue(value); }
+    public final Var<CaretVisibility> showCaretProperty() { return showCaret; }
+
+    public static enum CaretVisibility {
+        /** Caret is displayed. */
+        ON,
+        /** Caret is displayed when area is focused, enabled, and editable. */
+        AUTO,
+        /** Caret is not displayed. */
+        OFF
+    }
+
     // undo manager
     @Override public UndoManager getUndoManager() { return model.getUndoManager(); }
     @Override public void setUndoManager(UndoManagerFactory undoManagerFactory) {
@@ -569,18 +594,39 @@ public StyledTextArea(PS initialParagraphStyle, BiConsumer<TextFlow, PS> applyPa
         EventStream<?> caretDirty = merge(caretPosDirty, paragraphsDirty, selectionDirty);
         subscribeTo(caretDirty, x -> requestFollowCaret());
 
-        // whether or not to animate the caret
-        BooleanBinding blinkCaret = focusedProperty()
-                .and(editableProperty())
-                .and(disabledProperty().not());
-        manageBinding(blinkCaret);
+        // whether or not to display the caret
+        EventStream<Boolean> blinkCaret = EventStreams.valuesOf(showCaretProperty())
+                .flatMap(mode -> {
+                    switch (mode) {
+                        case ON:
+                            return EventStreams.valuesOf(Val.constant(true));
+                        case OFF:
+                            return EventStreams.valuesOf(Val.constant(false));
+                        default:
+                        case AUTO:
+                            return EventStreams.valuesOf(focusedProperty()
+                                    .and(editableProperty())
+                                    .and(disabledProperty().not()));
+                        }
+                });
 
+        // the rate at which to display the caret
+        EventStream<javafx.util.Duration> blinkRate = EventStreams.valuesOf(caretBlinkRate);
+ 
         // The caret is visible in periodic intervals,
         // but only when blinkCaret is true.
-        caretVisible = EventStreams.valuesOf(blinkCaret)
-                .flatMap(blink -> blink
-                        ? booleanPulse(Duration.ofMillis(500), caretDirty)
-                        : EventStreams.valuesOf(Val.constant(false)))
+        caretVisible = EventStreams.combine(blinkCaret, blinkRate)
+                .flatMap(tuple -> {
+                    Boolean blink = tuple.get1();
+                    javafx.util.Duration rate = tuple.get2();
+                    if(blink) {
+                        return rate.lessThanOrEqualTo(ZERO)
+                            ? EventStreams.valuesOf(Val.constant(true))
+                            : booleanPulse(rate, caretDirty);
+                    } else {
+                        return EventStreams.valuesOf(Val.constant(false));
+                    }
+                })
                 .toBinding(false);
         manageBinding(caretVisible);
 
@@ -1216,7 +1262,8 @@ private static Bounds extendLeft(Bounds b, double w) {
         }
     }
 
-    private static EventStream<Boolean> booleanPulse(Duration duration, EventStream<?> restartImpulse) {
+    private static EventStream<Boolean> booleanPulse(javafx.util.Duration javafxDuration, EventStream<?> restartImpulse) {
+        Duration duration = Duration.ofMillis(Math.round(javafxDuration.toMillis()));
         EventStream<?> ticks = EventStreams.restartableTicks(duration, restartImpulse);
         return StateMachine.init(false)
                 .on(restartImpulse.withDefaultEvent(null)).transition((state, impulse) -> true)