# ExtractedText
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Constants](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#constants)\|[Inherited Constants](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#inhconstants)\|[Fields](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#lfields)\|[Ctors](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#pubctors)\|[Methods](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#inhmethods)
# ExtractedText
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/view/inputmethod/ExtractedText "View this page in Kotlin")\|Java
`
public
class
ExtractedText
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
implements
`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`
`
|---|----------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/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](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#FLAG_SELECTING) Bit for[flags](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#flags): set if the editor is currently in selection mode. |
| `int` | [FLAG_SINGLE_LINE](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#FLAG_SINGLE_LINE) Bit for[flags](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#flags): set if the text being edited can only be on a single line. |
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): 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](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[ExtractedText](https://developer.android.com/reference/android/view/inputmethod/ExtractedText)`>` | [CREATOR](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#CREATOR) Used to make this class parcelable. |
| ` public int` | [flags](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#flags) Additional bit flags of information about the edited text. |
| ` public `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | [hint](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#hint) The hint that has been extracted. |
| ` public int` | [partialEndOffset](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#partialEndOffset) If the content is a report of a partial text change, this is the offset where the change ends. |
| ` public int` | [partialStartOffset](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#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](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#partialEndOffset). |
| ` public int` | [selectionEnd](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#selectionEnd) The offset where the selection currently ends within the extracted text. |
| ` public int` | [selectionStart](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#selectionStart) The offset where the selection currently starts within the extracted text. |
| ` public int` | [startOffset](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#startOffset) The offset in the overall text at which the extracted text starts. |
| ` public `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | [text](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#text) The text that has been extracted. |
| ### Public constructors ||
|-------------------------------------------------------------------------------------------------------------------------|---|
| ` `[ExtractedText](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#ExtractedText())`() ` |
| ### Public methods ||
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int` | ` `[describeContents](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Used to package this object into a[Parcel](https://developer.android.com/reference/android/os/Parcel). |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||
## Constants
### FLAG_SELECTING
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int FLAG_SELECTING
```
Bit for[flags](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int FLAG_SINGLE_LINE
```
Bit for[flags](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
Used to make this class parcelable.
### flags
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int flags
```
Additional bit flags of information about the edited text.
### hint
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CharSequence hint
```
The hint that has been extracted.
**See also:**
- [TextView.getHint()](https://developer.android.com/reference/android/widget/TextView#getHint())
### partialEndOffset
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#partialStartOffset), meaning a reduction or increase, respectively, in the total text.
### partialStartOffset
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/reference/android/view/inputmethod/ExtractedText#partialEndOffset). If the content is the full text, this field is -1.
### selectionEnd
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int selectionEnd
```
The offset where the selection currently ends within the extracted text. The real selection end position is atstartOffset+selectionEnd.
### selectionStart
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int selectionStart
```
The offset where the selection currently starts within the extracted text. The real selection start position is atstartOffset+selectionStart.
### startOffset
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int startOffset
```
The offset in the overall text at which the extracted text starts.
### text
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CharSequence text
```
The text that has been extracted.
**See also:**
- [TextView.getText()](https://developer.android.com/reference/android/widget/TextView#getText())
## Public constructors
### ExtractedText
```
public ExtractedText ()
```
## Public methods
### describeContents
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#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](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
|
### writeToParcel
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
Used to package this object into a[Parcel](https://developer.android.com/reference/android/os/Parcel).
| Parameters ||
|---------|-------------------------------------------------------------------------------------------------------|
| `dest` | `Parcel`: The[Parcel](https://developer.android.com/reference/android/os/Parcel)to be written.
|
| `flags` | `int`: The flags used for parceling.
|