Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public static final class

InputMethodService.Insets

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

Class Overview

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
InputMethodService.Insets ()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int TOUCHABLE_INSETS_CONTENT

Added in API level 3

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

Constant Value: 1 (0x00000001)

public static final int TOUCHABLE_INSETS_FRAME

Added in API level 3

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

Constant Value: 0 (0x00000000)

public static final int TOUCHABLE_INSETS_REGION

Added in API level 11

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

Constant Value: 3 (0x00000003)

public static final int TOUCHABLE_INSETS_VISIBLE

Added in API level 3

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

Constant Value: 2 (0x00000002)

Fields

public int contentTopInsets

Added in API level 3

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.

public int touchableInsets

Added in API level 3

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 .

public final Region touchableRegion

Added in API level 11

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.

public int visibleTopInsets

Added in API level 3

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

public InputMethodService.Insets ()

Added in API level 3