Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 4212ebb0 authored by Justin Ghan's avatar Justin Ghan
Browse files

Layout#getRangeForRect API changes 

- Layout#getRangeForRect returns Range<Integer> instead of int[].
- WordSegmentFinder takes ULocale instead of Locale
- Additional Javadoc

Bug: 251085162
Test: atest android.text.cts.LayoutGetRangeForRectTest
Change-Id: Id51f5b23885dc93addc44b81d641c963c58505c8
parent 8f760708

core/api/current.txt

+2 −2
Original line number Diff line number Diff line
@@ -45331,7 +45331,7 @@ package android.text { 
    method public final int getParagraphLeft(int);

    method public final int getParagraphRight(int);

    method public float getPrimaryHorizontal(int);

    method @Nullable public int[] getRangeForRect(@NonNull android.graphics.RectF, @NonNull android.text.SegmentFinder, @NonNull android.text.Layout.TextInclusionStrategy);

    method @Nullable public android.util.Range<java.lang.Integer> getRangeForRect(@NonNull android.graphics.RectF, @NonNull android.text.SegmentFinder, @NonNull android.text.Layout.TextInclusionStrategy);

    method public float getSecondaryHorizontal(int);

    method public void getSelectionPath(int, int, android.graphics.Path);

    method public final float getSpacingAdd();
@@ -45746,7 +45746,7 @@ package android.text { 
  }















  public class WordSegmentFinder extends android.text.SegmentFinder {













    ctor public WordSegmentFinder(@NonNull CharSequence, @NonNull java.util.Locale);













    ctor public WordSegmentFinder(@NonNull CharSequence, @NonNull android.icu.util.ULocale);















    method public int nextEndBoundary(@IntRange(from=0) int);















    method public int nextStartBoundary(@IntRange(from=0) int);















    method public int previousEndBoundary(@IntRange(from=0) int);

























core/java/android/text/GraphemeClusterSegmentFinder.java



+7
−0




























Original line number
Diff line number
Diff line








@@ -34,6 +34,13 @@ public class GraphemeClusterSegmentFinder extends SegmentFinder {













    private final CharSequence mText;















    private final TextPaint mTextPaint;





























    /**













     * Constructs a GraphemeClusterSegmentFinder instance for the specified text which uses the













     * provided TextPaint to determine grapheme cluster boundaries.













     *













     * @param text text to be segmented













     * @param textPaint TextPaint used to draw the text













     */















    public GraphemeClusterSegmentFinder(















            @NonNull CharSequence text, @NonNull TextPaint textPaint) {















        mText = text;

































core/java/android/text/Layout.java



+6
−4




























Original line number
Diff line number
Diff line








@@ -36,6 +36,7 @@ import android.text.style.LineBackgroundSpan;













import android.text.style.ParagraphStyle;















import android.text.style.ReplacementSpan;















import android.text.style.TabStopSpan;













import android.util.Range;































import com.android.internal.annotations.VisibleForTesting;















import com.android.internal.util.ArrayUtils;










@@ -1859,11 +1860,12 @@ public abstract class Layout {













     *     text segment















     * @param inclusionStrategy strategy for determining whether a text segment is inside the















     *          specified area













     * @return int array of size 2 containing the start (inclusive) and end (exclusive) character













     *     offsets of the range, or null if there are no text segments inside the area













     * @return an integer range where the endpoints are the start (inclusive) and end (exclusive)













     *     character offsets of the text range, or null if there are no text segments inside the













     *     area















     */















    @Nullable













    public int[] getRangeForRect(@NonNull RectF area, @NonNull SegmentFinder segmentFinder,













    public Range<Integer> getRangeForRect(@NonNull RectF area, @NonNull SegmentFinder segmentFinder,















            @NonNull TextInclusionStrategy inclusionStrategy) {















        // Find the first line whose bottom (without line spacing) is below the top of the area.















        int startLine = getLineForVertical((int) area.top);










@@ -1921,7 +1923,7 @@ public abstract class Layout {













        start = segmentFinder.previousStartBoundary(start + 1);















        end = segmentFinder.nextEndBoundary(end - 1);





























        return new int[] {start, end};













        return new Range(start, end);















    }































    /**

































core/java/android/text/SegmentFinder.java



+5
−0




























Original line number
Diff line number
Diff line








@@ -33,6 +33,11 @@ import android.graphics.RectF;













 * @see Layout#getRangeForRect(RectF, SegmentFinder, Layout.TextInclusionStrategy)















 */















public abstract class SegmentFinder {













    /**













     * Return value of previousStartBoundary(int), previousEndBoundary(int), nextStartBoundary(int),













     * and nextEndBoundary(int) when there are no boundaries of the specified type in the specified













     * direction.













     */















    public static final int DONE = -1;































    /**

































core/java/android/text/WordSegmentFinder.java



+17
−5




























Original line number
Diff line number
Diff line








@@ -18,12 +18,10 @@ package android.text;





























import android.annotation.IntRange;















import android.annotation.NonNull;













import android.annotation.SuppressLint;















import android.icu.text.BreakIterator;













import android.icu.util.ULocale;















import android.text.method.WordIterator;





























import java.util.Locale;





























/**















 * Implementation of {@link SegmentFinder} using words as the text segment. Word boundaries are















 * found using {@link WordIterator}. Whitespace characters are excluded, so they are not included in









@@ -39,14 +37,28 @@ public class WordSegmentFinder extends SegmentFinder {













    private final CharSequence mText;















    private final WordIterator mWordIterator;





























    /**













     * Constructs a WordSegmentFinder instance for the specified text which uses the provided locale













     * to determine word boundaries.













     *













     * @param text text to be segmented













     * @param locale locale used for analyzing the text













     */















    public WordSegmentFinder(













            @NonNull CharSequence text, @SuppressLint("UseIcu") @NonNull Locale locale) {













            @NonNull CharSequence text, @NonNull ULocale locale) {















        mText = text;















        mWordIterator = new WordIterator(locale);















        mWordIterator.setCharSequence(text, 0, text.length());















    }





























    /** @hide */













    /**













     * Constructs a WordSegmentFinder instance for the specified text which uses the provided













     * WordIterator to determine word boundaries.













     *













     * @param text text to be segmented













     * @param wordIterator word iterator used to find word boundaries in the text













     * @hide













     */















    public WordSegmentFinder(@NonNull CharSequence text, @NonNull WordIterator wordIterator) {















        mText = text;















        mWordIterator = wordIterator;