目录

@ohos.InputMethodSubtype (输入法子类型)

@ohos.InputMethodSubtype模块提供输入法子类型的属性数据定义,支持描述输入法在不同语言或模式下的子类型信息。

本模块是输入法框架的子类型数据模块,定义了InputMethodSubtype接口,用于描述输入法的一种具体输入模式或语言——如中文键盘、英文键盘、大写模式键盘等,每个子类型代表输入法在特定语言或模式下的形态。

本模块提供输入法子类型的属性描述能力。通过InputMethodSubtype可获取子类型的标识(id、name)、语言和区域(locale、language)、显示标签(label)、模式(mode:大写/小写)、图标等属性,用于输入法子类型的识别、展示和切换。

当需要查询、展示或切换输入法的不同语言/模式子类型时使用本模块。典型场景包括:系统设置应用展示输入法子类型列表供用户选择、输入法应用根据子类型信息切换语言或模式、应用获取当前输入法子类型信息等。

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

InputMethodSubtype是纯数据定义模块,其对象由系统框架创建和返回,开发者不可自行构造。典型跨模块使用流程:

  1. 编辑框应用侧(@ohos.inputMethod模块):通过InputMethodSetting.listInputMethodSubtype()查询输入法子类型列表,通过inputMethod.switchCurrentInputMethodSubtype()切换到指定子类型。
  2. 输入法应用侧(@ohos.inputMethodEngine模块):通过InputMethodAbility.on('setSubtype')监听子类型切换事件,回调参数为InputMethodSubtype对象,据此调整键盘布局和语言。

本模块的核心开放能力由以下关键接口承载:

Interface 说明
InputMethodSubtype 输入法子类型属性接口,描述输入法的一种具体语言或模式形态。必填属性包括:name(所属应用包名)、id(子类型ID)、locale(区域)、language(语言);可选属性包括:label(标签)、labelId(标签资源号)、mode(大写/小写模式)、icon(图标)、iconId(图标ID)、extra(额外信息)。

本模块为纯数据定义模块,InputMethodSubtype作为子类型描述数据需与其他模块的API组合使用。典型组合场景为:在@ohos.inputMethod模块中,通过InputMethodSetting查询和切换子类型;在@ohos.inputMethodEngine模块中,通过InputMethodAbility监听子类型切换事件。

// 以下为阐述调用逻辑的伪代码

// 1. 查询输入法子类型列表(@ohos.inputMethod模块组合)
let setting = inputMethod.getSetting();
let subtypes = setting.listInputMethodSubtype(inputMethodProperty);

// 2. 切换到指定子类型
inputMethod.switchCurrentInputMethodSubtype(targetSubtype);

InputMethodSubtype对象由系统框架创建和返回,开发者通过其他模块的查询接口获取,不可自行构造。

导入模块

import { InputMethodSubtype } from '@kit.IMEKit';

InputMethodSubtype

输入法子类型属性。用于描述输入法的一种具体语言或模式形态,每个子类型代表输入法在特定语言或模式下的形态(如中文键盘、英文键盘、大写模式键盘等)。InputMethodSubtype对象由系统框架创建和返回,开发者不可自行构造。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称 类型 只读 可选 说明
label string 是 是 输入法子类型的标签。用于在UI界面展示子类型的名称,如"中文(简体)"、"English"等。
labelId10+ number 是 是 输入法子类型的标签资源号。用于通过资源ID加载标签文本,支持多语言场景下的标签国际化显示。
name string 是 否 输入法子类型所属应用的包名。与输入法应用在module.json5中配置的bundleName保持一致,用于标识该子类型属于哪个输入法应用。
id string 是 否 输入法子类型的id。与输入法应用在module.json5中配置的subtype id保持一致,用于在同一输入法应用内唯一标识一个子类型。
mode 'upper' | 'lower' 是 是 输入法子类型的模式,包括upper(大写)和lower(小写)。用于描述键盘的大小写状态模式。
locale string 是 否 输入法子类型的区域。遵循ICU Locale格式(下划线分隔,如'zh_CN'),也兼容POSIX风格(连字符分隔,如'zh-CN')。用于标识子类型的语言和地区。
language string 是 否 输入法子类型的语言,如'zh'(中文)、'en'(英文)。用于标识子类型的语言,是locale的子集。
icon string 是 是 输入法子类型的图标。规格限制:当前不可通过该参数获取或显示子类型图标。
iconId number 是 是 输入法子类型的图标id。用于通过资源ID加载子类型图标。
extra object 否 是

输入法子类型的其他信息。

说明:

- 从API version 10开始为非必填参数。

[h2]参数使用建议

name参数:

id参数:

locale参数:

language参数:

mode参数:

label参数:

labelId参数:

icon和iconId参数:

extra参数: