InputMethodService.Insets

Kotlin |Java

public static final class InputMethodService.Insets
extends Object

java.lang.Object
↳	android.inputmethodservice.InputMethodService.Insets

Information about where interesting parts of the input method UI appear.

Summary

Constants
`int`	`TOUCHABLE_INSETS_CONTENT` Option for `touchableInsets`: the area inside of the content insets can be touched.
`int`	`TOUCHABLE_INSETS_FRAME` Option for `touchableInsets`: the entire window frame can be touched.
`int`	`TOUCHABLE_INSETS_REGION` Option for `touchableInsets`: the region specified by `touchableRegion` can be touched.
`int`	`TOUCHABLE_INSETS_VISIBLE` Option for `touchableInsets`: the area inside of the visible insets can be touched.

Fields
`public int`	`contentTopInsets` This is the top part of the UI that is the main content.
`public int`	`touchableInsets` Determine which area of the window is touchable by the user.
`public final Region`	`touchableRegion` This is the region of the UI that is touchable.
`public int`	`visibleTopInsets` This is the top part of the UI that is visibly covering the application behind it.

Public constructors
`Insets()`

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.

Constants

TOUCHABLE_INSETS_CONTENT

Added in API level 3

public static final int TOUCHABLE_INSETS_CONTENT

Option for touchableInsets: the area inside of the content insets can be touched.

Constant Value: 1 (0x00000001)

TOUCHABLE_INSETS_FRAME

Added in API level 3

public static final int TOUCHABLE_INSETS_FRAME

Option for touchableInsets: the entire window frame can be touched.

Constant Value: 0 (0x00000000)

TOUCHABLE_INSETS_REGION

Added in API level 11

public static final int TOUCHABLE_INSETS_REGION

Option for touchableInsets: the region specified by touchableRegion can be touched.

Constant Value: 3 (0x00000003)

TOUCHABLE_INSETS_VISIBLE

Added in API level 3

public static final int TOUCHABLE_INSETS_VISIBLE

Option for touchableInsets: the area inside of the visible insets can be touched.

Constant Value: 2 (0x00000002)

Fields

contentTopInsets

Added in API level 3

public int contentTopInsets

This is the top part of the UI that is the main content. It is used to determine the basic space needed, to resize/pan the application behind. It is assumed that this inset does not change very much, since any change will cause a full resize/pan of the application behind. This value is relative to the top edge of the input method window.

touchableInsets

Added in API level 3

public int touchableInsets

Determine which area of the window is touchable by the user. May be one of: TOUCHABLE_INSETS_FRAME, TOUCHABLE_INSETS_CONTENT, TOUCHABLE_INSETS_VISIBLE, or TOUCHABLE_INSETS_REGION.

touchableRegion

Added in API level 11

public final Region touchableRegion

This is the region of the UI that is touchable. It is used when touchableInsets is set to TOUCHABLE_INSETS_REGION. The region should be specified relative to the origin of the window frame.

visibleTopInsets

Added in API level 3

public int visibleTopInsets

This is the top part of the UI that is visibly covering the application behind it. This provides finer-grained control over visibility, allowing you to change it relatively frequently (such as hiding or showing candidates) without disrupting the underlying UI too much. For example, this will never resize the application UI, will only pan if needed to make the current focus visible, and will not aggressively move the pan position when this changes unless needed to make the focus visible. This value is relative to the top edge of the input method window.

Public constructors

Insets

public Insets ()