ExtractedText

open class ExtractedText : Parcelable

kotlin.Any
↳	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.
Requires API level 3 (Android 1.5, Cupcake)

Summary

Constants
static Int	`FLAG_SELECTING` Bit for `#flags`: set if the editor is currently in selection mode.
static Int	`FLAG_SINGLE_LINE` Bit for `#flags`: set if the text being edited can only be on a single line.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`<init>()`

Public methods
open Unit	`writeToParcel(dest: Parcel!, flags: Int)` Used to package this object into a `Parcel`.
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Properties
Int	`flags` Additional bit flags of information about the edited text.
CharSequence!	`hint` The hint that has been extracted.
Int	`partialEndOffset` If the content is a report of a partial text change, this is the offset where the change ends.
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`.
Int	`selectionEnd` The offset where the selection currently ends within the extracted text.
Int	`selectionStart` The offset where the selection currently starts within the extracted text.
Int	`startOffset` The offset in the overall text at which the extracted text starts.
CharSequence!	`text` The text that has been extracted.
static Parcelable.Creator<ExtractedText!>!	`CREATOR` Used to make this class parcelable.

Constants

FLAG_SELECTING

added in API level 3

static val FLAG_SELECTING: Int

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.
Requires API level 3 (Android 1.5, Cupcake)

Value: 2

FLAG_SINGLE_LINE

added in API level 3

static val FLAG_SINGLE_LINE: Int

Bit for #flags: set if the text being edited can only be on a single line.
Requires API level 3 (Android 1.5, Cupcake)

Value: 1

Public constructors

<init>

ExtractedText()

Public methods

writeToParcel

added in API level 3

open fun writeToParcel(dest: Parcel!, flags: Int): Unit

Used to package this object into a Parcel.
Requires API level 3 (Android 1.5, Cupcake)

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

describeContents

added in API level 3

open fun describeContents(): Int

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. Requires API level 3 (Android 1.5, Cupcake)

Return
Int: a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

Properties

flags

added in API level 3

var flags: Int

Additional bit flags of information about the edited text.
Requires API level 3 (Android 1.5, Cupcake)

hint

added in API level 28

var hint: CharSequence!

The hint that has been extracted.
Requires API level 28 (Android 8.+, P)

See Also

android.widget.TextView#getHint()

partialEndOffset

added in API level 3

var partialEndOffset: Int

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.
Requires API level 3 (Android 1.5, Cupcake)

partialStartOffset

added in API level 3

var partialStartOffset: Int

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.
Requires API level 3 (Android 1.5, Cupcake)

selectionEnd

added in API level 3

var selectionEnd: Int

The offset where the selection currently ends within the extracted text. The real selection end position is at startOffset+selectionEnd.
Requires API level 3 (Android 1.5, Cupcake)

selectionStart

added in API level 3

var selectionStart: Int

The offset where the selection currently starts within the extracted text. The real selection start position is at startOffset+selectionStart.
Requires API level 3 (Android 1.5, Cupcake)

startOffset

added in API level 3

var startOffset: Int

The offset in the overall text at which the extracted text starts.
Requires API level 3 (Android 1.5, Cupcake)

text

added in API level 3

var text: CharSequence!

The text that has been extracted.
Requires API level 3 (Android 1.5, Cupcake)

See Also

android.widget.TextView#getText()

CREATOR

added in API level 3

static val CREATOR: Parcelable.Creator<ExtractedText!>!

Used to make this class parcelable.
Requires API level 3 (Android 1.5, Cupcake)