diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index 2caea7b961c8486bd0bd9e545fd045939ab0bf68..5be5ae82734b49c43d287f74f092372f0975fd64 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -14,19 +14,23 @@ import inputMethod from '@ohos.inputMethod'; 常量值。 +**系统能力**:以下各项对应的系统能力均为SystemCapability.MiscServices.InputMethodFramework + | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| MAX_TYPE_NUM | number | 是 | 否 | 可支持的最大输入法个数。
**系统能力**: SystemCapability.MiscServices.InputMethod | +| MAX_TYPE_NUM | number | 是 | 否 | 可支持的最大输入法个数。 | ## InputMethodProperty8+ 输入法应用属性。 +**系统能力**:以下各项对应的系统能力均为SystemCapability.MiscServices.InputMethodFramework + | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| packageName | string | 是 | 否 | 包名。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| methodId | string | 是 | 否 | Ability名。
**系统能力**: SystemCapability.MiscServices.InputMethod | +| packageName | string | 是 | 否 | 包名。 | +| methodId | string | 是 | 否 | Ability名。 | ## inputMethod.getInputMethodController @@ -34,7 +38,7 @@ getInputMethodController(): InputMethodController 获取客户端实例[InputMethodController](#InputMethodController)。 -**系统能力**:SystemCapability.MiscServices.InputMethod +**系统能力**:SystemCapability.MiscServices.InputMethodFramework - 返回值 @@ -52,7 +56,7 @@ getInputMethodSetting(): InputMethodSetting 获取客户端设置实例[InputMethodSetting](#InputMethodSetting)。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 @@ -76,7 +80,7 @@ stopInput(callback: AsyncCallback<boolean>): void 隐藏输入法。 -**系统能力**:SystemCapability.MiscServices.InputMethod +**系统能力**:SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -98,7 +102,7 @@ stopInput(): Promise<boolean> 隐藏输入法。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 @@ -124,7 +128,7 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>) 查询已安装的输入法列表。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 | 参数名 | 类型 | 必填 | 说明 | @@ -147,7 +151,7 @@ listInputMethod(): Promise<Array<InputMethodProperty>> 查询已安装的输入法列表。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 | 类型 | 说明 | @@ -169,7 +173,7 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void 显示输入法选择对话框。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -190,7 +194,7 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void 显示输入法选择对话框。 - **系统能力**: SystemCapability.MiscServices.InputMethod + **系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md index 3c35b43547852bb063dd3a03f5d2fb1ad484788e..afbd6f22ebe353652f01932f81408287d92155c2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -13,34 +13,36 @@ import inputMethodEngine from '@ohos.inputMethodEngine'; 常量值。 +**系统能力**:以下各项对应的系统能力均为SystemCapability.MiscServices.InputMethodFramework + | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| ENTER_KEY_TYPE_UNSPECIFIED | number | 是 | 否 | 无功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| ENTER_KEY_TYPE_GO | number | 是 | 否 | “前往”功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| ENTER_KEY_TYPE_SEARCH | number | 是 | 否 | “搜索”功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| ENTER_KEY_TYPE_SEND | number | 是 | 否 | “发送”功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| ENTER_KEY_TYPE_NEXT | number | 是 | 否 | “下一个”功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| ENTER_KEY_TYPE_DONE | number | 是 | 否 | “回车”功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| ENTER_KEY_TYPE_PREVIOUS | number | 是 | 否 | “前一个”功能键。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_NULL | number | 是 | 否 | 无特殊性编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_TEXT | number | 是 | 否 | 文本编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_NUMBER | number | 是 | 否 | 数字编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_PHONE | number | 是 | 否 | 电话编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_DATETIME | number | 是 | 否 | 日期编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_EMAIL | number | 是 | 否 | 邮件编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_URI | number | 是 | 否 | 超链接编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| PATTERN_PASSWORD | number | 是 | 否 | 密码编辑框。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_ASCII | number | 是 | 否 | 允许输入ASCII值。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_NONE | number | 是 | 否 | 不指定编辑框输入属性。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_AUTO_CAP_CHARACTERS | number | 是 | 否 | 允许输入字符。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_AUTO_CAP_SENTENCES | number | 是 | 否 | 允许输入句子。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_AUTO_WORDS | number | 是 | 否 | 允许输入单词。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_MULTI_LINE | number | 是 | 否 | 允许输入多行。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| OPTION_NO_FULLSCREEN | number | 是 | 否 | 半屏样式。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| FLAG_SELECTING | number | 是 | 否 | 编辑框处于选择状态。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| FLAG_SINGLE_LINE | number | 是 | 否 | 编辑框为单行。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| DISPLAY_MODE_PART | number | 是 | 否 | 编辑框显示为半屏。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| DISPLAY_MODE_FULL | number | 是 | 否 | 编辑框显示为全屏。
**系统能力**: SystemCapability.MiscServices.InputMethod | +| ENTER_KEY_TYPE_UNSPECIFIED | number | 是 | 否 | 无功能键。 | +| ENTER_KEY_TYPE_GO | number | 是 | 否 | “前往”功能键。 | +| ENTER_KEY_TYPE_SEARCH | number | 是 | 否 | “搜索”功能键。 | +| ENTER_KEY_TYPE_SEND | number | 是 | 否 | “发送”功能键。 | +| ENTER_KEY_TYPE_NEXT | number | 是 | 否 | “下一个”功能键。 | +| ENTER_KEY_TYPE_DONE | number | 是 | 否 | “回车”功能键。 | +| ENTER_KEY_TYPE_PREVIOUS | number | 是 | 否 | “前一个”功能键。 | +| PATTERN_NULL | number | 是 | 否 | 无特殊性编辑框。 | +| PATTERN_TEXT | number | 是 | 否 | 文本编辑框。 | +| PATTERN_NUMBER | number | 是 | 否 | 数字编辑框。 | +| PATTERN_PHONE | number | 是 | 否 | 电话编辑框。 | +| PATTERN_DATETIME | number | 是 | 否 | 日期编辑框。 | +| PATTERN_EMAIL | number | 是 | 否 | 邮件编辑框。 | +| PATTERN_URI | number | 是 | 否 | 超链接编辑框。 | +| PATTERN_PASSWORD | number | 是 | 否 | 密码编辑框。 | +| OPTION_ASCII | number | 是 | 否 | 允许输入ASCII值。 | +| OPTION_NONE | number | 是 | 否 | 不指定编辑框输入属性。 | +| OPTION_AUTO_CAP_CHARACTERS | number | 是 | 否 | 允许输入字符。 | +| OPTION_AUTO_CAP_SENTENCES | number | 是 | 否 | 允许输入句子。 | +| OPTION_AUTO_WORDS | number | 是 | 否 | 允许输入单词。 | +| OPTION_MULTI_LINE | number | 是 | 否 | 允许输入多行。 | +| OPTION_NO_FULLSCREEN | number | 是 | 否 | 半屏样式。 | +| FLAG_SELECTING | number | 是 | 否 | 编辑框处于选择状态。 | +| FLAG_SINGLE_LINE | number | 是 | 否 | 编辑框为单行。 | +| DISPLAY_MODE_PART | number | 是 | 否 | 编辑框显示为半屏。 | +| DISPLAY_MODE_FULL | number | 是 | 否 | 编辑框显示为全屏。 | ## inputMethodEngine.getInputMethodEngine @@ -48,7 +50,7 @@ getInputMethodEngine(): InputMethodEngine 获取服务端实例。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 @@ -68,7 +70,7 @@ createKeyboardDelegate(): KeyboardDelegate 获取客户端监听实例。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 @@ -92,7 +94,7 @@ on(type: 'inputStart', callback: (kbController: KeyboardController, textInputCli 订阅输入法绑定成功事件,使用callback回调返回输入法操作相关实例。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -116,7 +118,7 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC 取消订阅输入法绑定成功事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -139,7 +141,7 @@ on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void 订阅输入法事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -162,7 +164,7 @@ off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void 取消订阅输入法事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -188,7 +190,7 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void 订阅硬键盘事件,使用callback回调返回按键信息。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -213,7 +215,7 @@ off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void 取消订阅硬键盘事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -234,7 +236,7 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) = 订阅光标变化事件,使用callback回调返回光标信息。 - **系统能力**: SystemCapability.MiscServices.InputMethod + **系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -259,7 +261,7 @@ off(type: 'cursorContextChange', callback?: (x: number, y:number, height:number) 取消订阅光标变化事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -280,7 +282,7 @@ on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegi 订阅文本选择变化事件,使用callback回调返回文本选择信息。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -303,7 +305,7 @@ off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBe 取消订阅文本选择变化事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -325,7 +327,7 @@ on(type: 'textChange', callback: (text: string) => void): void 订阅文本变化事件,使用callback回调返回当前文本内容。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -348,7 +350,7 @@ off(type: 'textChange', callback?: (text: string) => void): void 取消订阅文本变化事件。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -373,7 +375,7 @@ hideKeyboard(callback: AsyncCallback<void>): void 隐藏输入法。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数: @@ -395,7 +397,7 @@ hideKeyboard(): Promise<void> 隐藏输入法。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 @@ -420,7 +422,7 @@ getForward(length:number, callback: AsyncCallback<string>): void 获取光标前固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -442,7 +444,7 @@ getForward(length:number): Promise<string> 获取光标前固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -467,7 +469,7 @@ getBackward(length:number, callback: AsyncCallback<string>): void 获取光标后固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -489,7 +491,7 @@ getBackward(length:number): Promise<string> 获取光标后固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -514,7 +516,7 @@ deleteForward(length:number, callback: AsyncCallback<boolean>): void 删除光标前固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -535,7 +537,7 @@ deleteForward(length:number): Promise<boolean> 删除光标前固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -560,7 +562,7 @@ deleteBackward(length:number, callback: AsyncCallback<boolean>): void 删除光标后固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -582,7 +584,7 @@ deleteBackward(length:number): Promise<boolean> 删除光标后固定长度的文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 | 参数名 | 类型 | 必填 | 说明 | @@ -606,7 +608,7 @@ sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void 发送功能键。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -628,7 +630,7 @@ sendKeyFunction(action:number): Promise<boolean> 发送功能键。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 | 参数名 | 类型 | 必填 | 说明 | @@ -653,7 +655,7 @@ insertText(text:string, callback: AsyncCallback<boolean>): void 插入文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 @@ -675,7 +677,7 @@ insertText(text:string): Promise<boolean> 插入文本。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 | 参数名 | 类型 | 必填 | 说明 | @@ -700,7 +702,7 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void 获取编辑框属性值。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 参数 | 参数名 | 类型 | 必填 | 说明 | @@ -719,7 +721,7 @@ getEditorAttribute(): Promise<EditorAttribute> 获取编辑框属性值。 -**系统能力**: SystemCapability.MiscServices.InputMethod +**系统能力**: SystemCapability.MiscServices.InputMethodFramework - 返回值 | 类型 | 说明 | @@ -735,17 +737,21 @@ getEditorAttribute(): Promise<EditorAttribute> 编辑框属性值。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| ------------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| enterKeyType | number | 是 | 否 | 编辑框的功能属性。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| inputPattern | number | 是 | 否 | 编辑框的文本属性。
**系统能力**: SystemCapability.MiscServices.InputMethod | +**系统能力**:以下各项对应的系统能力均为SystemCapability.MiscServices.InputMethodFramework + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------------ | -------- | ---- | ---- | ------------------ | +| enterKeyType | number | 是 | 否 | 编辑框的功能属性。 | +| inputPattern | number | 是 | 否 | 编辑框的文本属性。 | ## KeyEvent 按键属性值。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| --------- | -------- | ---- | ---- | ------------------------------------------------------------ | -| keyCode | number | 是 | 否 | 按键的键值。
**系统能力**: SystemCapability.MiscServices.InputMethod | -| keyAction | number | 是 | 否 | 按键的状态。
**系统能力**: SystemCapability.MiscServices.InputMethod | +**系统能力**:以下各项对应的系统能力均为SystemCapability.MiscServices.InputMethodFramework + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| --------- | -------- | ---- | ---- | ------------ | +| keyCode | number | 是 | 否 | 按键的键值。 | +| keyAction | number | 是 | 否 | 按键的状态。 |