Added in API level 3

ExtractedText

Kotlin |Java

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

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout 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 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

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.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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:

TextView.getHint()

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:

TextView.getText()

Public constructors

ExtractedText

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(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`

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.