Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revisit API comment again with code example

Browse Source 
Bug: 266591082
Test: N/A
Change-Id: I90635b488d807526e782e6d7d82436ccbde14e91
This commit is contained in:
Seigo Nonaka
2023-02-14 09:31:29 +09:00
parent 011451e5fb
commit e94bf55619
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
core/java/android/text/Highlights.java
View File

@@ -90,8 +90,19 @@ public class Highlights {
/**
* Add single range highlight.
*
* If the given range has overlaps with the already added ranges, the previous highlights
* are overdrawn by this range.
* The {@link android.widget.TextView} and underlying {@link Layout} draws highlight in the
* order of the {@link #addRange} calls.
*
* For example, the following code draws (1, 2) with red and (2, 5) with blue.
* <code>
* val redPaint = Paint().apply { color = Color.RED }
* val bluePaint = Paint().apply { color = Color.BLUE }
* val highlight = Highlights.Builder()
* .addRange(redPaint, 1, 4)
* .addRange(bluePaint, 2, 5)
* .build()
* </code>
*
*
* @param paint a paint object used for drawing highlight path.
* @param start an inclusive offset of the text.
@@ -114,8 +125,15 @@ public class Highlights {
/**
* Add multiple ranges highlight.
*
* If the given ranges have overlap with the already added ranges, the previous highlights
* are overdrawn by this range.
* For example, the following code draws (1, 2) with red and (2, 5) with blue.
* <code>
* val redPaint = Paint().apply { color = Color.RED }
* val bluePaint = Paint().apply { color = Color.BLUE }
* val highlight = Highlights.Builder()
* .addRange(redPaint, 1, 4)
* .addRange(bluePaint, 2, 5)
* .build()
* </code>
*
* @param paint a paint object used for drawing highlight path.
* @param ranges a flatten ranges. The {@code 2 * i}-th element is an inclusive start offset