ExtractedText

public class ExtractedText
extends Object implements Parcelable

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


Information about text that has been extracted for use by an input method. This contains information about a portion of the currently edited text, that the IME should display into its own interface while in extracted mode.

Summary

Constants

int FLAG_SELECTING

Bit for flags: set if the editor is currently in selection mode.

int FLAG_SINGLE_LINE

Bit for flags: set if the text being edited can only be on a single line.

Inherited constants

Fields

public static final Creator<ExtractedText> CREATOR

Used to make this class parcelable.

public int flags

Additional bit flags of information about the edited text.

public CharSequence hint

The hint that has been extracted.

public int partialEndOffset

If the content is a report of a partial text change, this is the offset where the change ends.

public int partialStartOffset

If the content is a report of a partial text change, this is the offset where the change starts and it runs until partialEndOffset.

public int selectionEnd

The offset where the selection currently ends within the extracted text.

public int selectionStart

The offset where the selection currently starts within the extracted text.

public int startOffset

The offset in the overall text at which the extracted text starts.

public CharSequence text

The text that has been extracted.

Public constructors

ExtractedText()

Public methods

int describeContents()

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

void writeToParcel(Parcel dest, int flags)

Used to package this object into a Parcel.

Inherited methods

Constants

FLAG_SELECTING

added in API level 3
public static final int FLAG_SELECTING

Bit for flags: set if the editor is currently in selection mode. This happens when a hardware keyboard with latched keys is attached and the shift key is currently latched.

Constant Value: 2 (0x00000002)

FLAG_SINGLE_LINE

added in API level 3
public static final int FLAG_SINGLE_LINE

Bit for flags: set if the text being edited can only be on a single line.

Constant Value: 1 (0x00000001)

Fields

CREATOR

added in API level 3
public static final Creator<ExtractedText> CREATOR

Used to make this class parcelable.

flags

added in API level 3
public int flags

Additional bit flags of information about the edited text.

hint

added in API level 28
public CharSequence hint

The hint that has been extracted.

See also:

partialEndOffset

added in API level 3
public int partialEndOffset

If the content is a report of a partial text change, this is the offset where the change ends. Note that the actual text may be larger or smaller than the difference between this and partialStartOffset, meaning a reduction or increase, respectively, in the total text.

partialStartOffset

added in API level 3
public int partialStartOffset

If the content is a report of a partial text change, this is the offset where the change starts and it runs until partialEndOffset. If the content is the full text, this field is -1.

selectionEnd

added in API level 3
public int selectionEnd

The offset where the selection currently ends within the extracted text. The real selection end position is at startOffset+selectionEnd.

selectionStart

added in API level 3
public int selectionStart

The offset where the selection currently starts within the extracted text. The real selection start position is at startOffset+selectionStart.

startOffset

added in API level 3
public int startOffset

The offset in the overall text at which the extracted text starts.

text

added in API level 3
public CharSequence text

The text that has been extracted.

See also:

Public constructors

ExtractedText

added in API level 3
public ExtractedText ()

Public methods

describeContents

added in API level 3
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(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.

writeToParcel

added in API level 3
public void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written.

flags int: The flags used for parceling.