AccessibilityService.SoftKeyboardController

public static final class AccessibilityService.SoftKeyboardController
extends Object

java.lang.Object
   ↳ android.accessibilityservice.AccessibilityService.SoftKeyboardController

Used to control, query, and listen for changes to the soft keyboard show mode.

Accessibility services may request to override the decisions normally made about whether or not the soft keyboard is shown.

If multiple services make conflicting requests, the last request is honored. A service may register a listener to find out if the mode has changed under it.

If the user takes action to override the behavior behavior requested by an accessibility service, the user's request takes precendence, the show mode will be reset to AccessibilityService#SHOW_MODE_AUTO, and services will no longer be able to control that aspect of the soft keyboard's behavior.

Note: Because soft keyboards are independent apps, the framework does not have total control over their behavior. They may choose to show themselves, or not, without regard to requests made here. So the framework will make a best effort to deliver the behavior requested, but cannot guarantee success.

Summary

Nested classes

interface AccessibilityService.SoftKeyboardController.OnShowModeChangedListener

Listener for changes in the soft keyboard show mode. 

Public methods

void addOnShowModeChangedListener(AccessibilityService.SoftKeyboardController.OnShowModeChangedListener listener, Handler handler)

Adds the specified change listener to the list of soft keyboard show mode change listeners.

void addOnShowModeChangedListener(AccessibilityService.SoftKeyboardController.OnShowModeChangedListener listener)

Adds the specified change listener to the list of show mode change listeners.

int getShowMode()

Returns the show mode of the soft keyboard.

boolean removeOnShowModeChangedListener(AccessibilityService.SoftKeyboardController.OnShowModeChangedListener listener)

Removes the specified change listener from the list of keyboard show mode change listeners.

boolean setShowMode(int showMode)

Sets the soft keyboard show mode.

Inherited methods

Public methods

addOnShowModeChangedListener

Added in API level 24 
public void addOnShowModeChangedListener (AccessibilityService.SoftKeyboardController.OnShowModeChangedListener listener, 
                Handler handler)

Adds the specified change listener to the list of soft keyboard show mode change listeners. The callback will occur on the specified Handler's thread, or on the services's main thread if the handler is null.

Parameters
listener AccessibilityService.SoftKeyboardController.OnShowModeChangedListener: the listener to add, must be non-null This value must never be null.
handler Handler: the handler on which to callback should execute, or null to execute on the service's main thread This value may be null.

addOnShowModeChangedListener

Added in API level 24 
public void addOnShowModeChangedListener (AccessibilityService.SoftKeyboardController.OnShowModeChangedListener listener)

Adds the specified change listener to the list of show mode change listeners. The callback will occur on the service's main thread. Listener is not called on registration.

Parameters
listener AccessibilityService.SoftKeyboardController.OnShowModeChangedListener: This value must never be null.

removeOnShowModeChangedListener

Added in API level 24 
public boolean removeOnShowModeChangedListener (AccessibilityService.SoftKeyboardController.OnShowModeChangedListener listener)

Removes the specified change listener from the list of keyboard show mode change listeners.

Parameters
listener AccessibilityService.SoftKeyboardController.OnShowModeChangedListener: the listener to remove, must be non-null This value must never be null.
Returns
boolean true if the listener was removed, false otherwise

setShowMode

Added in API level 24 
public boolean setShowMode (int showMode)

Sets the soft keyboard show mode.

Note: If the service is not yet connected (e.g. AccessibilityService#onServiceConnected() has not yet been called) or the service has been disconnected, this method will have no effect and return false.

Parameters
showMode int: the new show mode for the soft keyboard Value is AccessibilityService.SHOW_MODE_AUTO, AccessibilityService.SHOW_MODE_HIDDEN, or AccessibilityService.SHOW_MODE_IGNORE_HARD_KEYBOARD
Returns
boolean true on success