Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/text/Highlights#nestedclasses) \| [Methods](https://developer.android.com/reference/android/text/Highlights#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/text/Highlights#inhmethods)

# Highlights

*** ** * ** ***

` public class Highlights `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.text.Highlights |

<br />

*** ** * ** ***

A class that represents of the highlight of the text.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/text/Highlights.Builder` A builder for the Highlights. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/Paint` | ` https://developer.android.com/reference/android/text/Highlights#getPaint(int)(int index) ` Returns a paint used for the i-th highlight. |
| ` int[]` | ` https://developer.android.com/reference/android/text/Highlights#getRanges(int)(int index) ` Returns ranges of the i-th highlight. |
| ` int` | ` https://developer.android.com/reference/android/text/Highlights#getSize()() ` Returns the number of highlight. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/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 https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/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` ` https://developer.android.com/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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public methods

### getPaint

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Paint getPaint (int index)
```

Returns a paint used for the i-th highlight.

<br />

| Parameters ||
|---|---|
| `index` | `int`: an index of the highlight. Must be between 0 and `https://developer.android.com/reference/android/text/Highlights#getSize()` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Paint` | the paint object <br /> |

**See also:**

- `https://developer.android.com/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int)`
- `https://developer.android.com/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[])`

### getRanges

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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\].

<br />

| Parameters ||
|---|---|
| `index` | `int`: an index of the highlight. Must be between 0 and `https://developer.android.com/reference/android/text/Highlights#getSize()` <br /> |

| Returns ||
|---|---|
| `int[]` | the flattened ranges. <br /> |

**See also:**

- `https://developer.android.com/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int)`
- `https://developer.android.com/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[])`

### getSize

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSize ()
```

Returns the number of highlight.

<br />

| Returns ||
|---|---|
| `int` | the number of highlight. <br /> |

**See also:**

- `https://developer.android.com/reference/android/text/Highlights.Builder#addRange(android.graphics.Paint,%20int,%20int)`
- `https://developer.android.com/reference/android/text/Highlights.Builder#addRanges(android.graphics.Paint,%20int[])`