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

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 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.