PrescribedSegmentFinder

Kotlin |Java

open class PrescribedSegmentFinder : SegmentFinder

kotlin.Any
↳	android.text.SegmentFinder
	↳	android.text.SegmentFinder.PrescribedSegmentFinder

The default SegmentFinder implementation based on given segment ranges.

Summary

Inherited constants

From class SegmentFinder

Int

DONE

Return value of previousStartBoundary(int), previousEndBoundary(int), nextStartBoundary(int), and nextEndBoundary(int) when there are no boundaries of the specified type in the specified direction.

Public constructors
`PrescribedSegmentFinder(segments: IntArray)` Create a SegmentFinder with segments stored in an array, where i-th segment's start is stored at segments[2 * i] and end is stored at segments[2 * i + 1] respectively.

Public methods
open Int	`nextEndBoundary(offset: Int)` Returns the character offset of the next text segment end boundary after the specified character offset, or `DONE` if there are none.
open Int	`nextStartBoundary(offset: Int)` Returns the character offset of the next text segment start boundary after the specified character offset, or `DONE` if there are none.
open Int	`previousEndBoundary(offset: Int)` Returns the character offset of the previous text segment end boundary before the specified character offset, or `DONE` if there are none.
open Int	`previousStartBoundary(offset: Int)` Returns the character offset of the previous text segment start boundary before the specified character offset, or `DONE` if there are none.

Public constructors

PrescribedSegmentFinder

Added in API level 34

PrescribedSegmentFinder(segments: IntArray)

Create a SegmentFinder with segments stored in an array, where i-th segment's start is stored at segments[2 * i] and end is stored at segments[2 * i + 1] respectively.

It is required that segments do not overlap, and are already sorted by their start indices.

Parameters
`segments`	IntArray: the array that stores the segment ranges.

Exceptions
`java.lang.IllegalArgumentException`	if the given segments array's length is not even; the given segments are not sorted or there are segments overlap with others.

Public methods

nextEndBoundary

Added in API level 34

open fun nextEndBoundary(offset: Int): Int

Returns the character offset of the next text segment end boundary after the specified character offset, or DONE if there are none.

Parameters
`offset`	Int: Value is 0 or greater

nextStartBoundary

Added in API level 34

open fun nextStartBoundary(offset: Int): Int

Returns the character offset of the next text segment start boundary after the specified character offset, or DONE if there are none.

Parameters
`offset`	Int: Value is 0 or greater

previousEndBoundary

Added in API level 34

open fun previousEndBoundary(offset: Int): Int

Returns the character offset of the previous text segment end boundary before the specified character offset, or DONE if there are none.

Parameters
`offset`	Int: Value is 0 or greater

previousStartBoundary

Added in API level 34

open fun previousStartBoundary(offset: Int): Int

Returns the character offset of the previous text segment start boundary before the specified character offset, or DONE if there are none.

Parameters
`offset`	Int: Value is 0 or greater