InputMethodSession

版本：Android 2.3 r1

结构

继承关系

public interfaceInputMethodSession

android.view.inputmethod. InputMethodSession

子类及间接子类

间接子类

AbstractInputMethodService.AbstractInputMethodSessionImpl,InputMethodService.InputMethodSessionImpl

类概述

InputMethodSession接口提供给每个客户端的InputMethod可安全地暴露在应用程序中。

应用程序通常不自己使用本接口，而是依靠TextView和EditText提供的标准交互。

内部类

interface InputMethodSession.EventCallback

公共方法

public abstract voidappPrivateCommand(String action, Bundle data)

执行由应用程序发往输入法的私有命令。它可用于提供专属域功能，仅专属于特定的输入法及其客户端

参数

action执行命名的名称。它必须是一个域名称，如前缀你自己的包名称，这样不同的开发者就不产生命令冲突。

data随命令包括的任何数据。

public abstract voiddispatchKeyEvent(int seq, KeyEvent event, InputMethodSession.EventCallback callback)

当按键按下时调用此方法。完成事件时，本方法的实现方法必须调用callback回调函数并返回结果。

如果输入法处理此事件返回true，否则返回false，调用者（如应用程序）将处理事件。

参数

event按键事件

返回值

输入法是否处理本事件。

参见

ERROR(/#dispatchKeyUp)

KeyEvent

public abstract voiddispatchTrackballEvent(int seq, MotionEvent event, InputMethodSession.EventCallback callback)

发生轨迹球事件时调用此方法。

如果输入法处理此事件返回true，否则返回false，调用者（如应用程序）将处理事件。

参数

event移动事件

返回值

输入法是否处理本事件。

参见

MotionEvent

public abstract voiddisplayCompletions(CompletionInfo[] completions)

由文本编辑器调用自动补全，完成后通知输入法补全有效。可被用于输入法向用户显示备选文本以备插入。

参数

completions补充文本数组有效，并以最佳结果开头。如果数组为空，存在的补充将被移除。

public abstract voidfinishInput()

当应用程序要停止接收文字输入时调用此方法。

public abstract voidtoggleSoftInput(int showFlags, int hideFlags)

切换软键盘(soft input)窗口。应用程序能切换软键盘(soft input)窗口

参数

showFlags提供附加的操作标志。可能为0或设置SHOW_IMPLICIT, SHOW_FORCED位。

hideFlags提供附加的操作标志。可能为0或设置HIDE_IMPLICIT_ONLY, HIDE_NOT_ALWAYS位。

public abstract voidupdateCursor(Rect newCursor)

当目标输入域的光标位置在自身窗口内移动时调用此方法。本方法通常不被调用，但输入法要求更新时可被调用。

参数

newCursor当前输入区域窗口坐标系下光标显示的矩阵区域。

public abstract voidupdateExtractedText(int token, ExtractedText text)

当内容变化时文本编辑器调用此方法，通知其新提取文本。本方法仅在输入法调用InputConnection.getExtractedText()并带有通报更新选项时才被调用。

参数

token输入法提供了分辨要求的令牌。

text新的提取文本。

public abstract voidupdateSelection(int oldSelStart, int oldSelEnd, int newSelStart, int newSelEnd, int candidatesStart, int candidatesEnd)

当目标输入域的光标或选定变化时，调用此方法。

参数

oldSelStart之前的选择开始位置相对于光标的文本偏移。

oldSelEnd之前的选择结束位置相对于光标的文本偏移。

newSelStart新的选择初始位置相对于光标的文本偏移。

newSelEnd新的选择结束位置相对于光标的文本偏移。

candidatesStart当前坐标系下文本文本开始位置的文本偏移。

candidatesEnd当前坐标系下文本文本结束位置的文本偏移。

补充

文章链接

android鍵盤的啟動關閉、顯示、隱藏及其bug