Merge pull request #572 from JFormDesigner/caret-positioning-fix

fixed caret positioning in wrapped lines (issue #423)

Author: JordanMartinez

richtextfx/src/integrationTest/java/org/fxmisc/richtext/keyboard/NavigationTests.java

@@ -225,7 +225,7 @@ public void right() {
 
     }
 
-    public class MultiLineTests extends InlineCssTextAreaAppTest {
+    public class MultiLineGridlikeTextTests extends InlineCssTextAreaAppTest {
 
         public final String[] lines = {
                 "01 02 03 04 05",
@@ -496,6 +496,53 @@ public void end() {
 
     }
 
+    public class MultiLineJaggedTextTests extends InlineCssTextAreaAppTest {
+
+        String threeLinesOfText = "Some long amount of text to take up a lot of space in the given area.";
+
+        @Override
+        public void start(Stage stage) throws Exception {
+            super.start(stage);
+            stage.setWidth(200);
+            area.replaceText(threeLinesOfText);
+            area.setWrapText(true);
+        }
+
+        private void waitForMultiLineRegistration() throws TimeoutException {
+            // When the stage's width changes, TextFlow does not properly handle API calls to a
+            //  multi-line paragraph immediately. So, wait until it correctly responds
+            //  to the stage width change
+            Future<Void> textFlowIsReady = WaitForAsyncUtils.asyncFx(() -> {
+                while (area.getParagraphLinesCount(0) != 3) {
+                    sleep(10);
+                }
+            });
+            WaitForAsyncUtils.waitFor(5, TimeUnit.SECONDS, textFlowIsReady);
+        }
+
+        @Test
+        public void pressingDownMovesCaretToNextLine() throws TimeoutException {
+            waitForMultiLineRegistration();
+
+            area.moveTo(27);
+
+            push(DOWN);
+
+            assertEquals(57, area.getCaretPosition());
+        }
+
+        @Test
+        public void pressingUpMovesCaretToPrevLine() throws TimeoutException {
+            waitForMultiLineRegistration();
+
+            area.moveTo(66);
+
+            push(UP);
+
+            assertEquals(36, area.getCaretPosition());
+        }
+    }
+
     public class ViewportTests extends InlineCssTextAreaAppTest {
 
         @Override

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

@@ -141,23 +141,36 @@ CharacterHit hitLine(double x, int lineIndex) {
     CharacterHit hit(double x, double y) {
         HitInfo hit = textLayout().getHitInfo((float) x, (float) y);
         int charIdx = hit.getCharIndex();
+        boolean leading = hit.isLeading();
 
         int lineIdx = getLineIndex((float) y);
         if(lineIdx >= getLineCount()) {
             return CharacterHit.insertionAt(getCharCount());
         }
 
-        TextLine line = getLines()[lineIdx];
+        TextLine[] lines = getLines();
+        TextLine line = lines[lineIdx];
         RectBounds lineBounds = line.getBounds();
 
+        // If this is a wrapped paragraph and hit character is at end of hit line,
+        // make sure that the "character hit" stays at the end of the hit line
+        // (and not at the beginning of the next line).
+        if(lines.length > 1 &&
+            lineIdx < lines.length - 1 &&
+            charIdx + 1 >= line.getStart() + line.getLength() &&
+            !leading)
+        {
+            leading = true;
+        }
+
         if(x < lineBounds.getMinX() || x > lineBounds.getMaxX()) {
-            if(hit.isLeading()) {
+            if(leading) {
                 return CharacterHit.insertionAt(charIdx);
             } else {
                 return CharacterHit.insertionAt(charIdx + 1);
             }
         } else {
-            if(hit.isLeading()) {
+            if(leading) {
                 return CharacterHit.leadingHalfOf(charIdx);
             } else {
                 return CharacterHit.trailingHalfOf(charIdx);