IME Kit简介
IME Kit 负责建立编辑框所在应用与输入法应用之间的通信通道,确保两者可以共同协作提供文本输入功能,也为系统应用提供管理输入法应用的能力。
Kit使用场景
IME Kit提供输入法框架和输入法服务两类API。用于实现输入法应用,也可以用于实现自绘编辑框以及实现对输入法应用的控制。
框架原理
功能特点
-
输入法应用:
支持创建固定态、悬浮态和状态栏三种类型的Panel,可支持开发一个输入法应用同时部署在手机、平板等多设备中。
-
自定义编辑框:
支持开发者自定义编辑框,实现绑定输入法应用,并实现输入法应用的文字输入、删除、选中、光标移动等操作。
能力范围
- 提供输入法服务相关API,用于输入法应用,包括:创建软键盘窗口、插入/删除字符、选中文本、监听物理键盘按键事件等。
- 提供输入法框架相关API,可用于自绘编辑框,包括绑定输入法,实现输入、删除、选中、光标移动等。
- 提供系统应用管理输入法应用能力,实现对输入法应用的控制,包括显示/隐藏输入法软键盘、切换输入法、获取所有输入法列表。
实现一个输入法应用
[InputMethodExtensionAbility]提供了onCreate()和onDestroy()生命周期回调,根据需要重写对应的回调方法。InputMethodExtensionAbility的生命周期如下:
-
onCreate()
服务被首次创建时触发该回调,开发者可以在此进行一些初始化的操作,例如注册公共事件监听等。
说明:
如果服务已创建,再次启动该InputMethodExtensionAbility不会触发onCreate()回调。
-
onDestroy()
当不再使用服务且准备将该实例销毁时,触发该回调。开发者可以在该回调中清理资源,如注销监听等。
开发步骤
开发者在实现一个输入法应用时,需要在DevEco Studio工程中新建一个InputMethodExtensionAbility,具体步骤如下:
- 在工程Module对应的ets目录下,右键选择“New > Directory”,新建一个目录,并命名为InputMethodExtensionAbility。
- 在InputMethodExtensionAbility目录下,右键选择“New > File”,新建四个文件,分别为KeyboardController.ts、InputMethodService.ts、Index.ets以及KeyboardKeyData.ts。目录如下:
/src/main/
├── ets/InputMethodExtensionAbility
│ └──model/KeyboardController.ts # 显示键盘
│ └──InputMethodService.ts # 自定义类继承InputMethodExtensionAbility并加上需要的生命周期回调
│ └──pages
│ └── Index.ets # 绘制键盘,添加输入删除功能
│ └── KeyboardKeyData.ts # 键盘属性定义
├── resources/base/profile/main_pa