Android使用InputMethodManager显示和隐藏软键盘

时间:2022-06-01 20:55:13

Android主要用InputMethodManager来对软键盘进行管理。手动显示或隐藏软键盘前需要先获取InputMethodManager。

InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
if (imm != null) {
    //...
}

为了避免NullPointException,需要判断imm实例是否为null。

显示软键盘

InputMethodManager显示软键盘有三个方法:

boolean showSoftInput (View view, int flags)
boolean showSoftInput (View view, int flags, ResultReceiver resultReceiver)
void showSoftInputFromInputMethod (IBinder token, int flags)

一般情况下会选择使用第一个方法,即两个参数的showSoftInput,基于两个原因:

  1. showSolftInput的resultReceiver参数用于接收完成输入后返回结果,但由于它可以长时间存在jvm里而不会被gc,使用它需要注意内存泄漏。
  2. showSoftInputFromInputMethod使用不当会存在失效的情况。

所有这里只介绍showSoftInput (View view, int flags)

先上示例

showKeyBoard(View view) {
  InputMethodManager imm = (InputMethodManager) veiw.getContext().getSystemService(Context.INPUT_METHOD_SERVICE);
  if (imm != null) {
    view.requestFocus();
    imm.showSoftInput(view, 0);
  }
}

showSoftInput的第一个参数view需要满足以下条件:

  1. 必须是可获取焦点,即view.isFocusable()为true。这里最好的是EditText 或其子类,它默认是可获取焦点的。
  2. 必须以获取焦点,即view.isFocused()为true。为了避免失焦(布局里可能存在多个可获取焦点的控件),可以先使用requestFocus()获得焦点后再调用showSoftInput(),如示例所示。
  3. 当前布局必须加载完成,所以在onCreate调用showSoftInput是会失效。

为了在布局加载完成后再调用showSoftInput,可以使用postDelayed来延迟执行showSoftInput()

getWindow().getDecorView().postDelayed(new Runnable() {
    @Override
    public void run() {
        showKeyBoard(view);//前面例子的方法
    }
}, 100);

showSoftInput第二个参数为flags,它是提供额外操作的标记。目前可以为两个值0和 SHOW_IMPLICIT。SHOW_IMPLICIT表示不是由用户操作引起显示软键盘的,为隐含显示。一般可以使用0。

隐藏软键盘

Android没有与showSoftInput对应的类似hideSoftInput的方法,我们可以使用hideSoftInputFromWindow隐藏软键盘。

方法原型:

boolean hideSoftInputFromWindow (IBinder windowToken, int flags)
  • windowToken:第一个参数可以使用View.getWindowToken()或者getWindow().getDecorView().getWindowToken()
  • flags:隐藏软键盘的标志位,可以传0

关闭软键盘,windowToken不需要已获取焦点的View,所以可以使用getWindow().getDecorView().getWindowToken()获取一个windowToken用于关闭软键盘。

示例

InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
if (imm != null) {
    imm.hideSoftInputFromWindow(getWindow().getDecorView().getWindowToken(), 0);
}

注意:如果是使用view.getWindowToken(),此view需要被添加到布局里才行,否则不能关闭软键盘。

切换软键盘

InputMehtodManager还提供了toggleSoftInput方法用于切换软键盘显示和隐藏。它不需要向它出入view或windowToken。

方法原型:

void toggleSoftInput (int showFlags, int hideFlags)
  • showFlags:显示使用的标记,和showSoftInput的第二个参数flags一样。
  • hideFlags:隐藏使用的标记,和hideSoftInputFromWindow第二个参数一样。

示例:

 InputMethodManager imm = (InputMethodManager) getSystemService(Activity.INPUT_METHOD_SERVICE);
if (imm.isActive()) {
    imm.toggleSoftInput(InputMethodManager.HIDE_IMPLICIT_ONLY, 0); // 隐藏
} else {
    imm.toggleSoftInput(0, InputMethodManager.HIDE_IMPLICIT_ONLY); // 显示
}