Added in API level 3

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.

Summary

Constants
static Int

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

static Int

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

Inherited constants
Public constructors

Public methods
open Int

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

Used to package this object into a Parcel.

Properties
static Parcelable.Creator<ExtractedText!>

Used to make this class parcelable.

Int

Additional bit flags of information about the edited text.

CharSequence!

The hint that has been extracted.

Int

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

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.

Int

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

Int

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

Int

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

CharSequence!

The text that has been extracted.

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.

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.

Value: 1

Public constructors

ExtractedText

ExtractedText()

Public methods

describeContents

Added in API level 3
open fun describeContents(): Int
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

writeToParcel

Added in API level 3
open fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Used to package this object into a Parcel.

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

Properties

CREATOR

Added in API level 3
static val CREATOR: Parcelable.Creator<ExtractedText!>

Used to make this class parcelable.

flags

Added in API level 3
var flags: Int

Additional bit flags of information about the edited text.

hint

Added in API level 28
var hint: CharSequence!

The hint that has been extracted.

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.

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.

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.

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.

startOffset

Added in API level 3
var startOffset: Int

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

text

Added in API level 3
var text: CharSequence!

The text that has been extracted.