Stay organized with collections
Save and categorize content based on your preferences.
Highlights.Builder
public
static
final
class
Highlights.Builder
extends Object
A builder for the Highlights.
Summary
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public constructors
Builder
public Builder ()
Public methods
addRange
public Highlights.Builder addRange (Paint paint,
int start,
int end)
Add single range highlight.
The TextView and underlying Layout draws highlight in the
order of the addRange(Paint, int, int) calls.
For example, the following code draws (1, 2) with red and (2, 5) with blue.
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()
| Parameters |
|---|
paint |
Paint: a paint object used for drawing highlight path. |
start |
int: an inclusive offset of the text. |
end |
int: an exclusive offset of the text. |
addRanges
public Highlights.Builder addRanges (Paint paint,
int... ranges)
Add multiple ranges highlight.
For example, the following code draws (1, 2) with red and (2, 5) with blue.
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()
| Parameters |
|---|
paint |
Paint: a paint object used for drawing highlight path. |
ranges |
int: a flatten ranges. The 2 * i-th element is an inclusive start offset
of the i-th character. The 2 * i + 1-th element is an
exclusive end offset of the i-th character. |
build
public Highlights build ()
Build a new Highlights instance.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# Highlights.Builder\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nHighlights.Builder\n==================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/text/Highlights.Builder \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nHighlights.Builder\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|---------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.text.Highlights.Builder |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA builder for the Highlights.\n\nSummary\n-------\n\n| ### Public constructors ||\n|-------------------------------------------------------------------------|---|\n| ` `[Builder](/reference/android/text/Highlights.Builder#Builder())`() ` |\n\n| ### Public methods ||\n|---------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[Highlights.Builder](/reference/android/text/Highlights.Builder) | ` `[addRange](/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int))`(`[Paint](/reference/android/graphics/Paint)` paint, int start, int end) ` Add single range highlight. |\n| ` `[Highlights.Builder](/reference/android/text/Highlights.Builder) | ` `[addRanges](/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[]))`(`[Paint](/reference/android/graphics/Paint)` paint, int... ranges) ` Add multiple ranges highlight. |\n| ` `[Highlights](/reference/android/text/Highlights) | ` `[build](/reference/android/text/Highlights.Builder#build())`() ` Build a new Highlights instance. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic constructors\n-------------------\n\n### Builder\n\n```\npublic Builder ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### addRange\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Highlights.Builder addRange (Paint paint, \n int start, \n int end)\n```\n\nAdd single range highlight.\n\nThe [TextView](/reference/android/widget/TextView) and underlying [Layout](/reference/android/text/Layout) draws highlight in the\norder of the [addRange(Paint, int, int)](/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int)) calls.\n\nFor example, the following code draws (1, 2) with red and (2, 5) with blue.\n`\nval redPaint = Paint().apply { color = Color.RED }\nval bluePaint = Paint().apply { color = Color.BLUE }\nval highlight = Highlights.Builder()\n.addRange(redPaint, 1, 4)\n.addRange(bluePaint, 2, 5)\n.build()\n`\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|-----------------------------------------------------------------|\n| `paint` | `Paint`: a paint object used for drawing highlight path. \u003cbr /\u003e |\n| `start` | `int`: an inclusive offset of the text. \u003cbr /\u003e |\n| `end` | `int`: an exclusive offset of the text. \u003cbr /\u003e |\n\n| Returns ||\n|------------------------------------------------------------------|-------------------------------|\n| [Highlights.Builder](/reference/android/text/Highlights.Builder) | this builder instance. \u003cbr /\u003e |\n\n### addRanges\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Highlights.Builder addRanges (Paint paint, \n int... ranges)\n```\n\nAdd multiple ranges highlight.\n\nFor example, the following code draws (1, 2) with red and (2, 5) with blue.\n`\nval redPaint = Paint().apply { color = Color.RED }\nval bluePaint = Paint().apply { color = Color.BLUE }\nval highlight = Highlights.Builder()\n.addRange(redPaint, 1, 4)\n.addRange(bluePaint, 2, 5)\n.build()\n`\n\n\u003cbr /\u003e\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `paint` | `Paint`: a paint object used for drawing highlight path. \u003cbr /\u003e |\n| `ranges` | `int`: a flatten ranges. The `2 * i`-th element is an inclusive start offset of the `i`-th character. The `2 * i + 1`-th element is an exclusive end offset of the `i`-th character. \u003cbr /\u003e |\n\n| Returns ||\n|------------------------------------------------------------------|-------------------------------|\n| [Highlights.Builder](/reference/android/text/Highlights.Builder) | this builder instance. \u003cbr /\u003e |\n\n### build\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Highlights build ()\n```\n\nBuild a new Highlights instance.\n\n\u003cbr /\u003e\n\n| Returns ||\n|--------------------------------------------------|-----------------------------------|\n| [Highlights](/reference/android/text/Highlights) | a new Highlights instance. \u003cbr /\u003e |"]]
