Highlights.Builder


public static final class Highlights.Builder
extends Object

java.lang.Object
   ↳ android.text.Highlights.Builder


A builder for the Highlights.

Summary

Public constructors

Builder()

Public methods

Highlights.Builder addRange(Paint paint, int start, int end)

Add single range highlight.

Highlights.Builder addRanges(Paint paint, int... ranges)

Add multiple ranges highlight.

Highlights build()

Build a new Highlights instance.

Inherited methods

Public constructors

Builder

public Builder ()

Public methods

addRange

Added in API level 34
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.

Returns
Highlights.Builder this builder instance.

addRanges

Added in API level 34
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.

Returns
Highlights.Builder this builder instance.

build

Added in API level 34
public Highlights build ()

Build a new Highlights instance.

Returns
Highlights a new Highlights instance.