SegmentFinder

Kotlin |Java

abstract class SegmentFinder

kotlin.Any
↳	android.text.SegmentFinder

Known Direct Subclasses

GraphemeClusterSegmentFinder, SegmentFinder.PrescribedSegmentFinder, WordSegmentFinder

GraphemeClusterSegmentFinder	Implementation of `SegmentFinder` using grapheme clusters as the text segment.
SegmentFinder.PrescribedSegmentFinder	The default `SegmentFinder` implementation based on given segment ranges.
WordSegmentFinder	Implementation of `SegmentFinder` using words as the text segment.

Finds text segment boundaries within text. Subclasses can implement different types of text segments. Grapheme clusters and words are examples of possible text segments. These are implemented by GraphemeClusterSegmentFinder and WordSegmentFinder.

Text segments may not overlap, so every character belongs to at most one text segment. A character may belong to no text segments.

For example, WordSegmentFinder subdivides the text "Hello, World!" into four text segments: "Hello", ",", "World", "!". The space character does not belong to any text segments.

Summary

Nested classes
open	`PrescribedSegmentFinder` The default `SegmentFinder` implementation based on given segment ranges.

Constants
static 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
`SegmentFinder()`

Public methods
abstract 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.
abstract 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.
abstract 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.
abstract 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.

Constants

DONE

Added in API level 34

static val DONE: Int

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.

Value: -1

Public constructors

SegmentFinder

SegmentFinder()

Public methods

nextEndBoundary

Added in API level 34

abstract 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

abstract 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

abstract 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

abstract 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