# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

# SurroundingText

`public final class SurroundingText`
`extends Object` `implements Parcelable`

java.lang.Object
↳ | android.view.inputmethod.SurroundingText

Information about the surrounding text around the cursor for use by an input method.

This contains information about the text and the selection relative to the text.

## Summary

### 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<SurroundingText>` | `CREATOR`

### Public constructors
`SurroundingText(CharSequence text, int selectionStart, int selectionEnd, int offset)` Constructor.

### Public methods
`int` | `describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int` | `getOffset()` Returns text offset between the start of the editor's text and the start of the surrounding text.
`int` | `getSelectionEnd()` Returns the text offset of the end of the selection in the surrounding text.
`int` | `getSelectionStart()` Returns the text offset of the start of the selection in the surrounding text.
`CharSequence` | `getText()` Returns the surrounding text around the cursor.
`void` | `writeToParcel(Parcel out, int flags)` Flatten this object in to 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
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.

## Fields

### CREATOR

    public static final Creator<SurroundingText> CREATOR

## Public constructors

### SurroundingText

    public SurroundingText (CharSequence text,
                    int selectionStart,
                    int selectionEnd,
                    int offset)

Constructor.

Parameters
`text` | `CharSequence`: The surrounding text. This value cannot be `null`.
`selectionStart` | `int`: The text offset of the start of the selection in the surrounding text. Reversed selection is allowed. Value is 0 or greater
`selectionEnd` | `int`: The text offset of the end of the selection in the surrounding text. Reversed selection is allowed. Value is 0 or greater
`offset` | `int`: The text offset between the start of the editor's text and the start of the surrounding text. -1 indicates the offset is unknown. Value is -1 or greater

## Public methods

### describeContents

    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`

### getOffset

    public int getOffset ()

Returns text offset between the start of the editor's text and the start of the surrounding text.

-1 indicates the offset information is unknown.

Returns
`int` | Value is -1 or greater

### getSelectionEnd

    public int getSelectionEnd ()

Returns the text offset of the end of the selection in the surrounding text.

A selection is the current range of the text that is selected by the user, or the current position of the cursor. A cursor is a selection where the start and end are at the same offset.

Returns
`int` | Value is 0 or greater

### getSelectionStart

    public int getSelectionStart ()

Returns the text offset of the start of the selection in the surrounding text.

A selection is the current range of the text that is selected by the user, or the current position of the cursor. A cursor is a selection where the start and end are at the same offset.

Returns
`int` | Value is 0 or greater

### getText

    public CharSequence getText ()

Returns the surrounding text around the cursor.

Returns
`CharSequence` | This value cannot be `null`.

### writeToParcel

    public void writeToParcel (Parcel out,
                    int flags)

Flatten this object in to a Parcel.

Parameters
`out` | `Parcel`: This value cannot be `null`.
`flags` | `int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*