WordSegmentFinder

Kotlin |Java

open class WordSegmentFinder : SegmentFinder

kotlin.Any
↳	android.text.SegmentFinder
	↳	android.text.WordSegmentFinder

Implementation of SegmentFinder using words as the text segment. Word boundaries are found using WordIterator. Whitespace characters are excluded, so they are not included in any text segments.

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

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
`WordSegmentFinder(text: CharSequence, locale: ULocale)` Constructs a WordSegmentFinder instance for the specified text which uses the provided locale to determine word boundaries.

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

WordSegmentFinder

Added in API level 34

WordSegmentFinder(
    text: CharSequence, 
    locale: ULocale)

Constructs a WordSegmentFinder instance for the specified text which uses the provided locale to determine word boundaries.

Parameters
`text`	CharSequence: text to be segmented This value cannot be `null`.
`locale`	ULocale: locale used for analyzing the text This value cannot be `null`.

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