Android APIs
public class

ExtractedText

extends Object
implements Parcelable
java.lang.Object
   ↳ android.view.inputmethod.ExtractedText

Class Overview

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.
[Expand]
Inherited Constants
From interface android.os.Parcelable
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 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's marshalled representation.
void writeToParcel(Parcel dest, int flags)
Used to package this object into a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int FLAG_SELECTING

Added in API level 3

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)

public static final int FLAG_SINGLE_LINE

Added in API level 3

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

Constant Value: 1 (0x00000001)

Fields

public static final Creator<ExtractedText> CREATOR

Added in API level 3

Used to make this class parcelable.

public int flags

Added in API level 3

Additional bit flags of information about the edited text.

public int partialEndOffset

Added in API level 3

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.

public int partialStartOffset

Added in API level 3

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.

public int selectionEnd

Added in API level 3

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

public int selectionStart

Added in API level 3

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

public int startOffset

Added in API level 3

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

public CharSequence text

Added in API level 3

The text that has been extracted.

Public Constructors

public ExtractedText ()

Added in API level 3

Public Methods

public int describeContents ()

Added in API level 3

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

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public void writeToParcel (Parcel dest, int flags)

Added in API level 3

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written.
flags int: The flags used for parceling.