Added in API level 33
TextSnapshot
public
final
class
TextSnapshot
extends Object
java.lang.Object | |
↳ | android.view.inputmethod.TextSnapshot |
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 |
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 | |
---|---|
Public constructors
TextSnapshot
Added in API level 33
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 | |
---|---|
NullPointerException |
if surroundingText is null . |
IllegalArgumentException |
if compositionStart and/or compositionEnd
is less than -1 . |
Public methods
getCompositionEnd
Added in API level 33
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
Added in API level 33
public int getCompositionStart ()
Returns | |
---|---|
int |
The end index of the composing text. -1 if there is no composing text.
Value is -1 or greater |
getCursorCapsMode
Added in API level 33
public int getCursorCapsMode ()
The capitalization mode of the first character being edited in the text.
Values may be any combination of the following values:
You should generally just take a non-zero value to mean "start out in caps mode" though.
Returns | |
---|---|
int |
See also:
getSelectionEnd
Added in API level 33
public int getSelectionEnd ()
Returns | |
---|---|
int |
The end index of the selection range. -1 if it is not available.
Value is -1 or greater |
getSelectionStart
Added in API level 33
public int getSelectionStart ()
Returns | |
---|---|
int |
The start index of the selection range. -1 if it is not available.
Value is -1 or greater |
getSurroundingText
Added in API level 33
public SurroundingText getSurroundingText ()
Returns | |
---|---|
SurroundingText |
SurroundingText of the current edit field.
This value cannot be null . |