TextSnapshot

Summary: Ctors | Methods | Inherited Methods

public final class TextSnapshot
extends Object

An immutable data snapshot of text editing state.

Summary

Public constructors
`TextSnapshot(SurroundingText surroundingText, int compositionStart, int compositionEnd, int cursorCapsMode)` Creates a new instance of `TextSnapshot`

Public methods
`int`	`getCompositionEnd()`
`int`	`getCompositionStart()`
`int`	`getCursorCapsMode()` The capitalization mode of the first character being edited in the text.
`int`	`getSelectionEnd()`
`int`	`getSelectionStart()`
`SurroundingText`	`getSurroundingText()`

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.

Public constructors

public TextSnapshot (SurroundingText surroundingText, 
                int compositionStart, 
                int compositionEnd, 
                int cursorCapsMode)

Creates a new instance of TextSnapshot

Parameters
`surroundingText`	`SurroundingText`: `SurroundingText` of the current edit field. This value cannot be `null`.
`compositionStart`	`int`: The start index of the composing text. `-1` if there is no composing text. Value is -1 or greater
`compositionEnd`	`int`: The end index of the composing text. `-1` if there is no composing text. Value is -1 or greater
`cursorCapsMode`	`int`: The capitalization mode of the first character being edited in the text. See `EditorInfo.initialCapsMode`.

Throws
`IllegalArgumentException`	if `compositionStart` and/or `compositionEnd` is less than `-1`.
`NullPointerException`	if `surroundingText` is `null`.

Public methods

getCompositionEnd

public int getCompositionEnd ()

Returns
`int`	The end index of the composing text. `-1` if there is no composing text. Value is -1 or greater

getCompositionStart

public int getCompositionStart ()

Returns
`int`	The end index of the composing text. `-1` if there is no composing text. Value is -1 or greater

getSelectionEnd

public int getSelectionEnd ()

Returns
`int`	The end index of the selection range. `-1` if it is not available. Value is -1 or greater

getSelectionStart

public int getSelectionStart ()

Returns
`int`	The start index of the selection range. `-1` if it is not available. Value is -1 or greater

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.