Merge pull request #376 from JordanMartinez/pageUpDown

Expose API for page up/down

Author: TomasMikula

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

@@ -448,6 +448,9 @@ public Optional<Tuple2<Codec<PS>, Codec<S>>> getStyleCodecs() {
 
     private Subscription subscriptions = () -> {};
 
+    // Remembers horizontal position when traversing up / down.
+    private Optional<ParagraphBox.CaretOffsetX> targetCaretOffset = Optional.empty();
+
     private final Binding<Boolean> caretVisible;
 
     private final Val<UnaryOperator<Point2D>> _popupAnchorAdjustment;
@@ -967,6 +970,30 @@ private void followCaret() {
         virtualFlow.show(parIdx, region);
     }
 
+    /**
+     * Moves caret to the previous page (i.e. page up)
+     * @param selectionPolicy use {@link SelectionPolicy#CLEAR} when no selection is desired and
+     *                        {@link SelectionPolicy#ADJUST} when a selection from starting point
+     *                        to the place to where the caret is moved is desired.
+     */
+    public void prevPage(SelectionPolicy selectionPolicy) {
+        showCaretAtBottom();
+        CharacterHit hit = hit(getTargetCaretOffset(), 1.0);
+        model.moveTo(hit.getInsertionIndex(), selectionPolicy);
+    }
+
+    /**
+     * Moves caret to the next page (i.e. page down)
+     * @param selectionPolicy use {@link SelectionPolicy#CLEAR} when no selection is desired and
+     *                        {@link SelectionPolicy#ADJUST} when a selection from starting point
+     *                        to the place to where the caret is moved is desired.
+     */
+    public void nextPage(SelectionPolicy selectionPolicy) {
+        showCaretAtTop();
+        CharacterHit hit = hit(getTargetCaretOffset(), getViewportHeight() - 1.0);
+        model.moveTo(hit.getInsertionIndex(), selectionPolicy);
+    }
+
     /**
      * Sets style for the given character range.
      */
@@ -1289,6 +1316,16 @@ private static Bounds extendLeft(Bounds b, double w) {
         }
     }
 
+    void clearTargetCaretOffset() {
+        targetCaretOffset = Optional.empty();
+    }
+
+    ParagraphBox.CaretOffsetX getTargetCaretOffset() {
+        if(!targetCaretOffset.isPresent())
+            targetCaretOffset = Optional.of(getCaretOffsetX());
+        return targetCaretOffset.get();
+    }
+
     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);

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

@@ -84,17 +84,17 @@ class StyledTextAreaBehavior {
                 consume(
                         anyOf(keyPressed(DOWN), keyPressed(KP_DOWN)),
                         (b, e) -> b.nextLine(SelectionPolicy.CLEAR)),
-                consume(keyPressed(PAGE_UP),    (b, e) -> b.prevPage(SelectionPolicy.CLEAR)),
-                consume(keyPressed(PAGE_DOWN),  (b, e) -> b.nextPage(SelectionPolicy.CLEAR)),
+                consume(keyPressed(PAGE_UP),    (b, e) -> b.view.prevPage(SelectionPolicy.CLEAR)),
+                consume(keyPressed(PAGE_DOWN),  (b, e) -> b.view.nextPage(SelectionPolicy.CLEAR)),
                 // vertical selection
                 consume(
                         anyOf(keyPressed(UP,   SHIFT_DOWN), keyPressed(KP_UP, SHIFT_DOWN)),
                         (b, e) -> b.prevLine(SelectionPolicy.ADJUST)),
                 consume(
                         anyOf(keyPressed(DOWN, SHIFT_DOWN), keyPressed(KP_DOWN, SHIFT_DOWN)),
                         (b, e) -> b.nextLine(SelectionPolicy.ADJUST)),
-                consume(keyPressed(PAGE_UP,   SHIFT_DOWN),  (b, e) -> b.prevPage(SelectionPolicy.ADJUST)),
-                consume(keyPressed(PAGE_DOWN, SHIFT_DOWN),  (b, e) -> b.nextPage(SelectionPolicy.ADJUST))
+                consume(keyPressed(PAGE_UP,   SHIFT_DOWN),  (b, e) -> b.view.prevPage(SelectionPolicy.ADJUST)),
+                consume(keyPressed(PAGE_DOWN, SHIFT_DOWN),  (b, e) -> b.view.nextPage(SelectionPolicy.ADJUST))
         );
 
         InputMapTemplate<StyledTextAreaBehavior, KeyEvent> otherNavigation = sequence(
@@ -165,7 +165,7 @@ class StyledTextAreaBehavior {
         InputMapTemplate<StyledTextAreaBehavior, KeyEvent> charPressConsumer = consume(keyPressed().onlyIf(isChar.and(noControlKeys)));
 
         InputMapTemplate<StyledTextAreaBehavior, ? super KeyEvent> keyPressedTemplate = edits
-                .orElse(otherNavigation).ifConsumed((b, e) -> b.clearTargetCaretOffset())
+                .orElse(otherNavigation).ifConsumed((b, e) -> b.view.clearTargetCaretOffset())
                 .orElse(verticalNavigation)
                 .orElse(copyAction)
                 .orElse(charPressConsumer);
@@ -214,19 +214,6 @@ private enum DragState {
      */
     private DragState dragSelection = DragState.NO_DRAG;
 
-    /**
-     * Remembers horizontal position when traversing up / down.
-     */
-    private Optional<CaretOffsetX> targetCaretOffset = Optional.empty();
-    private void clearTargetCaretOffset() {
-        targetCaretOffset = Optional.empty();
-    }
-    private CaretOffsetX getTargetCaretOffset() {
-        if(!targetCaretOffset.isPresent())
-            targetCaretOffset = Optional.of(view.getCaretOffsetX());
-        return targetCaretOffset.get();
-    }
-
     private final Var<Point2D> autoscrollTo = Var.newSimpleVar(null);
 
     /* ********************************************************************** *
@@ -359,7 +346,7 @@ private void downLines(SelectionPolicy selectionPolicy, int nLines) {
         Position targetLine = currentLine.offsetBy(nLines, Forward).clamp();
         if(!currentLine.sameAs(targetLine)) {
             // compute new caret position
-            CharacterHit hit = view.hit(getTargetCaretOffset(), targetLine);
+            CharacterHit hit = view.hit(view.getTargetCaretOffset(), targetLine);
 
             // update model
             model.moveTo(hit.getInsertionIndex(), selectionPolicy);
@@ -374,19 +361,6 @@ private void nextLine(SelectionPolicy selectionPolicy) {
         downLines(selectionPolicy, 1);
     }
 
-    private void prevPage(SelectionPolicy selectionPolicy) {
-        view.showCaretAtBottom();
-        CharacterHit hit = view.hit(getTargetCaretOffset(), 1.0);
-        model.moveTo(hit.getInsertionIndex(), selectionPolicy);
-    }
-
-    private void nextPage(SelectionPolicy selectionPolicy) {
-        view.showCaretAtTop();
-        CharacterHit hit = view.hit(getTargetCaretOffset(), view.getViewportHeight() - 1.0);
-        model.moveTo(hit.getInsertionIndex(), selectionPolicy);
-    }
-
-
     /* ********************************************************************** *
      * Mouse handling implementation                                          *
      * ********************************************************************** */
@@ -423,7 +397,7 @@ private void mousePressed(MouseEvent e) {
     }
 
     private void firstLeftPress(CharacterHit hit) {
-        clearTargetCaretOffset();
+        view.clearTargetCaretOffset();
         IndexRange selection = model.getSelection();
         if(view.isEditable() &&
                 selection.getLength() != 0 &&