Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

SegmentFinder

public abstract class SegmentFinder
extends Object

java.lang.Object
↳	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.

See also:

Layout.getRangeForRect(RectF, SegmentFinder, Layout.TextInclusionStrategy)

Summary

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

Constants
`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(int offset)` 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(int offset)` 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(int offset)` 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(int offset)` Returns the character offset of the previous text segment start boundary before the specified character offset, or `DONE` if there are none.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

DONE

Added in API level 34

 public static final 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.

Constant Value: -1 (0xffffffff)

Public constructors

SegmentFinder

 public SegmentFinder ()

Public methods

nextEndBoundary

Added in API level 34

 public abstract int nextEndBoundary (int offset)

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

Returns
`int`

nextStartBoundary

Added in API level 34

 public abstract int nextStartBoundary (int offset)

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

Returns
`int`

previousEndBoundary

Added in API level 34

 public abstract int previousEndBoundary (int offset)

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

Returns
`int`

previousStartBoundary

Added in API level 34

 public abstract int previousStartBoundary (int offset)

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

Returns
`int`

SegmentFinder

Summary

Nested classes

Constants

Public constructors

Public methods

Inherited methods

Constants

DONE

Public constructors

SegmentFinder

Public methods

nextEndBoundary

nextStartBoundary

previousEndBoundary

previousStartBoundary