Added in API level 34
Highlights
public
class
Highlights
extends Object
| java.lang.Object | |
| ↳ | android.text.Highlights |
A class that represents of the highlight of the text.
Summary
Nested classes | |
|---|---|
class |
Highlights.Builder
A builder for the Highlights. |
Public methods | |
|---|---|
Paint
|
getPaint(int index)
Returns a paint used for the i-th highlight. |
int[]
|
getRanges(int index)
Returns ranges of the i-th highlight. |
int
|
getSize()
Returns the number of highlight. |
Inherited methods | |
|---|---|
Public methods
getPaint
Added in API level 34
public Paint getPaint (int index)
Returns a paint used for the i-th highlight.
| Parameters | |
|---|---|
index |
int: an index of the highlight. Must be between 0 and getSize() |
| Returns | |
|---|---|
Paint |
the paint object |
getRanges
Added in API level 34
public int[] getRanges (int index)
Returns ranges of the i-th highlight.
Ranges are represented of flattened inclusive start and exclusive end integers array. The
inclusive start offset of the i-th range is stored in 2 * i-th of the array.
The exclusive end offset of the i-th range is stored in 2* i + 1-th of the
array. For example, the two ranges: (1, 2) and (3, 4) are flattened into single int array
[1, 2, 3, 4].
| Parameters | |
|---|---|
index |
int: an index of the highlight. Must be between 0 and getSize() |
| Returns | |
|---|---|
int[] |
the flattened ranges. |
getSize
Added in API level 34
public int getSize ()
Returns the number of highlight.
| Returns | |
|---|---|
int |
the number of highlight. |
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\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Nested Classes](#nestedclasses) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nHighlights\n==========\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/text/Highlights \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\n\nclass\nHighlights\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 |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA class that represents of the highlight of the text.\n\nSummary\n-------\n\n| ### Nested classes ||\n|----------|------------------------------------------------------------------------------------------------|\n| ` class` | [Highlights.Builder](/reference/android/text/Highlights.Builder) A builder for the Highlights. |\n\n| ### Public methods ||\n|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| ` `[Paint](/reference/android/graphics/Paint) | ` `[getPaint](/reference/android/text/Highlights#getPaint(int))`(int index) ` Returns a paint used for the i-th highlight. |\n| ` int[]` | ` `[getRanges](/reference/android/text/Highlights#getRanges(int))`(int index) ` Returns ranges of the i-th highlight. |\n| ` int` | ` `[getSize](/reference/android/text/Highlights#getSize())`() ` Returns the number of highlight. |\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 methods\n--------------\n\n### getPaint\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Paint getPaint (int index)\n```\n\nReturns a paint used for the i-th highlight.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|--------------------------------------------------------------------------------------------------------------------------|\n| `index` | `int`: an index of the highlight. Must be between 0 and [getSize()](/reference/android/text/Highlights#getSize()) \u003cbr /\u003e |\n\n| Returns ||\n|--------------------------------------------|-------------------------|\n| [Paint](/reference/android/graphics/Paint) | the paint object \u003cbr /\u003e |\n\n**See also:**\n\n- [Highlights.Builder.addRange(Paint, int, int)](/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int))\n- [Highlights.Builder.addRanges(Paint, int)](/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[])) \n\n### getRanges\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic int[] getRanges (int index)\n```\n\nReturns ranges of the i-th highlight.\n\nRanges are represented of flattened inclusive start and exclusive end integers array. The\ninclusive start offset of the `i`-th range is stored in `2 * i`-th of the array.\nThe exclusive end offset of the `i`-th range is stored in `2* i + 1`-th of the\narray. For example, the two ranges: (1, 2) and (3, 4) are flattened into single int array\n\\[1, 2, 3, 4\\].\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|--------------------------------------------------------------------------------------------------------------------------|\n| `index` | `int`: an index of the highlight. Must be between 0 and [getSize()](/reference/android/text/Highlights#getSize()) \u003cbr /\u003e |\n\n| Returns ||\n|---------|------------------------------|\n| `int[]` | the flattened ranges. \u003cbr /\u003e |\n\n**See also:**\n\n- [Highlights.Builder.addRange(Paint, int, int)](/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int))\n- [Highlights.Builder.addRanges(Paint, int)](/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[])) \n\n### getSize\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic int getSize ()\n```\n\nReturns the number of highlight.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|---------------------------------|\n| `int` | the number of highlight. \u003cbr /\u003e |\n\n**See also:**\n\n- [Highlights.Builder.addRange(Paint, int, int)](/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int))\n- [Highlights.Builder.addRanges(Paint, int)](/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[]))"]]