SurroundingText

public final class SurroundingText
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.inputmethod.SurroundingText


Information about the surrounding text around the cursor for use by an input method.

This contains information about the text and the selection relative to the text.

Summary

Inherited constants

Fields

public static final Creator<SurroundingText> CREATOR

Public constructors

SurroundingText(CharSequence text, int selectionStart, int selectionEnd, int offset)

Constructor.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getOffset()

Returns text offset between the start of the editor's text and the start of the surrounding text.

int getSelectionEnd()

Returns the text offset of the end of the selection in the surrounding text.

int getSelectionStart()

Returns the text offset of the start of the selection in the surrounding text.

CharSequence getText()

Returns the surrounding text around the cursor.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 31
public static final Creator<SurroundingText> CREATOR

Public constructors

SurroundingText

Added in API level 31
public SurroundingText (CharSequence text, 
                int selectionStart, 
                int selectionEnd, 
                int offset)

Constructor.

Parameters
text CharSequence: The surrounding text. This value cannot be null.

selectionStart int: The text offset of the start of the selection in the surrounding text. Reversed selection is allowed. Value is 0 or greater

selectionEnd int: The text offset of the end of the selection in the surrounding text. Reversed selection is allowed. Value is 0 or greater

offset int: The text offset between the start of the editor's text and the start of the surrounding text. -1 indicates the offset is unknown. Value is -1 or greater

Public methods

describeContents

Added in API level 31
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getOffset

Added in API level 31
public int getOffset ()

Returns text offset between the start of the editor's text and the start of the surrounding text.

-1 indicates the offset information is unknown.

Returns
int Value is -1 or greater

getSelectionEnd

Added in API level 31
public int getSelectionEnd ()

Returns the text offset of the end of the selection in the surrounding text.

A selection is the current range of the text that is selected by the user, or the current position of the cursor. A cursor is a selection where the start and end are at the same offset.

Returns
int Value is 0 or greater

getSelectionStart

Added in API level 31
public int getSelectionStart ()

Returns the text offset of the start of the selection in the surrounding text.

A selection is the current range of the text that is selected by the user, or the current position of the cursor. A cursor is a selection where the start and end are at the same offset.

Returns
int Value is 0 or greater

getText

Added in API level 31
public CharSequence getText ()

Returns the surrounding text around the cursor.

Returns
CharSequence This value cannot be null.

writeToParcel

Added in API level 31
public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES