Added in API level 34

GraphemeClusterSegmentFinder


open class GraphemeClusterSegmentFinder : SegmentFinder
kotlin.Any
   ↳ android.text.SegmentFinder
   ↳ android.text.GraphemeClusterSegmentFinder

Implementation of SegmentFinder using grapheme clusters as the text segment. Whitespace characters are included as segments.

For example, the text "a pot" would be divided into five text segments: "a", " ", "p", "o", "t".

Summary

Inherited constants
Public constructors

Constructs a GraphemeClusterSegmentFinder instance for the specified text which uses the provided TextPaint to determine grapheme cluster boundaries.

Public methods
open 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

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

open 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

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

Public constructors

GraphemeClusterSegmentFinder

Added in API level 34
GraphemeClusterSegmentFinder(
    text: CharSequence,
    textPaint: TextPaint)

Constructs a GraphemeClusterSegmentFinder instance for the specified text which uses the provided TextPaint to determine grapheme cluster boundaries.

Parameters
text CharSequence: text to be segmented This value cannot be null.
textPaint TextPaint: TextPaint used to draw 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