程序包 ohos.accessibility.ability

类 SoftKeyBoardController

java.lang.Object

ohos.accessibility.ability.SoftKeyBoardController

public class SoftKeyBoardController
extends Object

Provides a soft keyboard controller.

This controller offers the following functions:

1. Registering a listener to observe changes of the soft keyboard's show/hide mode.
2. Controlling the soft keyboard's show/hide mode.

从以下版本开始:

3

SystemCapability

SystemCapability.Accessibility#ABILITY

构造器概要

构造器

构造器	说明
SoftKeyBoardController(int connectionId, Object lock)	A constructor used to create a SoftKeyBoardController instance based on the connection ID and lock.

方法概要

限定符和类型	方法	说明
void	addListener(SoftKeyBoardListener listener)	Adds a SoftKeyBoardListener instance to observe changes of the soft keyboard's show/hide mode.
boolean	deleteListener(SoftKeyBoardListener listener)	Removes the specified SoftKeyBoardListener instance.
int	getShowMode()	Obtains the show/hide mode of this soft keyboard.
boolean	setShowMode(int showMode)	Sets the show/hide mode of the soft keyboard.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SoftKeyBoardController

public SoftKeyBoardController(int connectionId,
                              Object lock)

A constructor used to create a SoftKeyBoardController instance based on the connection ID and lock.

参数:

connectionId - Indicates the connection ID used to create SoftKeyBoardController.

lock - Indicates the lock used to create SoftKeyBoardController.

方法详细资料

addListener

public void addListener(SoftKeyBoardListener listener)

Adds a SoftKeyBoardListener instance to observe changes of the soft keyboard's show/hide mode.

参数:

listener - Indicates the listener to add.

deleteListener

public boolean deleteListener(SoftKeyBoardListener listener)

Removes the specified SoftKeyBoardListener instance.

参数:

listener - Indicates the listener to remove.

返回:

Returns true if the listener is successfully removed; returns false otherwise.

getShowMode

public int getShowMode()

Obtains the show/hide mode of this soft keyboard.

返回:

Returns the show/hide mode of this soft keyboard. Value 0 indicates that the soft keyboard is shown, value 1 indicates that the soft keyboard is hidden, and value 2 indicates that the soft keyboard is still shown when an external keyboard is connected.

另请参阅:

AccessibleAbility.SHOW_MODE_AUTO, AccessibleAbility.SHOW_MODE_HIDE, AccessibleAbility.SHOW_MODE_IGNORE_HARD_KEYBOARD

setShowMode

public boolean setShowMode(int showMode)

Sets the show/hide mode of the soft keyboard.

参数:

showMode - Indicates the show/hide mode to set. Value AccessibleAbility#SHOW_MODE_AUTO indicates that the soft keyboard is shown, value AccessibleAbility#SHOW_MODE_HIDE indicates that the soft keyboard is hidden,and value AccessibleAbility#SHOW_MODE_IGNORE_HARD_KEYBOARD indicates that the soft keyboard is still shown when an external keyboard is connected.

返回:

Returns true if the setting is successful; returns false otherwise.