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 ce3eab648d5a2136b2b83385f47d8213041c485b..9488ec2063bc4c03386a1ff20267306704043a81 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
@@ -4,7 +4,7 @@
> **说明：**
>
->本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+> 本模块首批接口从 API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
@@ -18,38 +18,38 @@ import inputMethodEngine from '@ohos.inputMethodEngine';
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 类型 | 值 | 说明 |
-| -------- | -------- | -------- | -------- |
-| ENTER_KEY_TYPE_UNSPECIFIED | number | 0 | 无功能键。 |
-| ENTER_KEY_TYPE_GO | number | 2 | “前往”功能键。 |
-| ENTER_KEY_TYPE_SEARCH | number | 3 | “搜索”功能键。 |
-| ENTER_KEY_TYPE_SEND | number | 4 | “发送”功能键。 |
-| ENTER_KEY_TYPE_NEXT | number | 5 | “下一个”功能键。 |
-| ENTER_KEY_TYPE_DONE | number | 6 | “回车”功能键。 |
-| ENTER_KEY_TYPE_PREVIOUS | number | 7 | “前一个”功能键。 |
-| PATTERN_NULL | number | -1 | 无特殊性编辑框。 |
-| PATTERN_TEXT | number | 0 | 文本编辑框。 |
-| PATTERN_NUMBER | number | 2 | 数字编辑框。 |
-| PATTERN_PHONE | number | 3 | 电话号码编辑框。 |
-| PATTERN_DATETIME | number | 4 | 日期编辑框。 |
-| PATTERN_EMAIL | number | 5 | 邮件编辑框。 |
-| PATTERN_URI | number | 6 | 超链接编辑框。 |
-| PATTERN_PASSWORD | number | 7 | 密码编辑框。 |
-| OPTION_ASCII | number | 20 | 允许输入ASCII值。 |
-| OPTION_NONE | number | 0 | 不指定编辑框输入属性。 |
-| OPTION_AUTO_CAP_CHARACTERS | number | 2 | 允许输入字符。 |
-| OPTION_AUTO_CAP_SENTENCES | number | 8 | 允许输入句子。 |
-| OPTION_AUTO_WORDS | number | 4 | 允许输入单词。 |
-| OPTION_MULTI_LINE | number | 1 | 允许输入多行。 |
-| OPTION_NO_FULLSCREEN | number | 10 | 半屏样式。 |
-| FLAG_SELECTING | number | 2 | 编辑框处于选择状态。 |
-| FLAG_SINGLE_LINE | number | 1 | 编辑框为单行。 |
-| DISPLAY_MODE_PART | number | 0 | 编辑框显示为半屏。 |
-| DISPLAY_MODE_FULL | number | 1 | 编辑框显示为全屏。 |
-| CURSOR_UP9+ | number | 1 | 光标上移。 |
-| CURSOR_DOWN9+ | number | 2 | 光标下移。 |
-| CURSOR_LEFT9+ | number | 3 | 光标左移。 |
-| CURSOR_RIGHT9+ | number | 4 | 光标右移。 |
+| 名称 | 类型 | 值 | 说明 |
+| ------------------------------------------- | ------ | ---- | ------------------------ |
+| ENTER_KEY_TYPE_UNSPECIFIED | number | 0 | 无功能键。 |
+| ENTER_KEY_TYPE_GO | number | 2 | “前往”功能键。 |
+| ENTER_KEY_TYPE_SEARCH | number | 3 | “搜索”功能键。 |
+| ENTER_KEY_TYPE_SEND | number | 4 | “发送”功能键。 |
+| ENTER_KEY_TYPE_NEXT | number | 5 | “下一个”功能键。 |
+| ENTER_KEY_TYPE_DONE | number | 6 | “回车”功能键。 |
+| ENTER_KEY_TYPE_PREVIOUS | number | 7 | “前一个”功能键。 |
+| PATTERN_NULL | number | -1 | 无特殊性编辑框。 |
+| PATTERN_TEXT | number | 0 | 文本编辑框。 |
+| PATTERN_NUMBER | number | 2 | 数字编辑框。 |
+| PATTERN_PHONE | number | 3 | 电话号码编辑框。 |
+| PATTERN_DATETIME | number | 4 | 日期编辑框。 |
+| PATTERN_EMAIL | number | 5 | 邮件编辑框。 |
+| PATTERN_URI | number | 6 | 超链接编辑框。 |
+| PATTERN_PASSWORD | number | 7 | 密码编辑框。 |
+| OPTION_ASCII | number | 20 | 允许输入 ASCII 值。 |
+| OPTION_NONE | number | 0 | 不指定编辑框输入属性。 |
+| OPTION_AUTO_CAP_CHARACTERS | number | 2 | 允许输入字符。 |
+| OPTION_AUTO_CAP_SENTENCES | number | 8 | 允许输入句子。 |
+| OPTION_AUTO_WORDS | number | 4 | 允许输入单词。 |
+| OPTION_MULTI_LINE | number | 1 | 允许输入多行。 |
+| OPTION_NO_FULLSCREEN | number | 10 | 半屏样式。 |
+| FLAG_SELECTING | number | 2 | 编辑框处于选择状态。 |
+| FLAG_SINGLE_LINE | number | 1 | 编辑框为单行。 |
+| DISPLAY_MODE_PART | number | 0 | 编辑框显示为半屏。 |
+| DISPLAY_MODE_FULL | number | 1 | 编辑框显示为全屏。 |
+| CURSOR_UP9+ | number | 1 | 光标上移。 |
+| CURSOR_DOWN9+ | number | 2 | 光标下移。 |
+| CURSOR_LEFT9+ | number | 3 | 光标左移。 |
+| CURSOR_RIGHT9+ | number | 4 | 光标右移。 |
| WINDOW_TYPE_INPUT_METHOD_FLOAT9+ | number | 2105 | 输入法应用窗口风格标识。 |
## inputMethodEngine.getInputMethodAbility9+
@@ -100,7 +100,7 @@ getInputMethodEngine(): InputMethodEngine
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getInputMethodAbility()](#inputmethodenginegetinputmethodability9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getInputMethodAbility()](#inputmethodenginegetinputmethodability9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
@@ -124,7 +124,7 @@ createKeyboardDelegate(): KeyboardDelegate
> **说明：**
>
->从API version 8开始支持，API version 9开始废弃，建议使用[getKeyboardDelegate()](#inputmethodenginegetkeyboarddelegate9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getKeyboardDelegate()](#inputmethodenginegetkeyboarddelegate9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
@@ -142,30 +142,32 @@ let keyboardDelegate = inputMethodEngine.createKeyboardDelegate();
## InputMethodEngine
-下列API均需使用[getInputMethodEngine](#inputmethodenginegetinputmethodenginedeprecated)获取到InputMethodEngine实例后，通过实例调用。
+下列 API 均需使用[getInputMethodEngine](#inputmethodenginegetinputmethodenginedeprecated)获取到 InputMethodEngine 实例后，通过实例调用。
### on('inputStart')
on(type: 'inputStart', callback: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void
-订阅输入法绑定成功事件。使用callback异步回调。
+订阅输入法绑定成功事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
-| callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 是 | 回调函数，返回订阅输入法的KeyboardController和TextInputClient实例。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------------------------------------------------------------------------------------------------------- | ---- | ----------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
+| callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 是 | 回调函数，返回订阅输入法的 KeyboardController 和 TextInputClient 实例。 |
**示例：**
```js
-inputMethodEngine.getInputMethodEngine().on('inputStart', (kbController, textClient) => {
- let keyboardController = kbController;
- let textInputClient = textClient;
-});
+inputMethodEngine
+ .getInputMethodEngine()
+ .on("inputStart", (kbController, textClient) => {
+ let keyboardController = kbController;
+ let textInputClient = textClient;
+ });
```
### off('inputStart')
@@ -178,42 +180,44 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------------------- | ---- | ------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
-| callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------------------------------------------------------------------------------------------------------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
+| callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getInputMethodEngine().off('inputStart', (kbController, textInputClient) => {
- console.log('delete inputStart notification.');
-});
+inputMethodEngine
+ .getInputMethodEngine()
+ .off("inputStart", (kbController, textInputClient) => {
+ console.log("delete inputStart notification.");
+ });
```
### on('keyboardShow'|'keyboardHide')
on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void
-订阅输入法软键盘显示或隐藏事件。使用callback异步回调。
+订阅输入法软键盘显示或隐藏事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型。
-'keyboardShow'表示显示输入法软键盘。
-'keyboardHide'表示隐藏输入法软键盘。 |
-| callback | () => void | 是 | 回调函数。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | -------------------------------------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型。
-'keyboardShow'表示显示输入法软键盘。
-'keyboardHide'表示隐藏输入法软键盘。 |
+| callback | () => void | 是 | 回调函数。 |
**示例：**
```js
-inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
- console.log('inputMethodEngine keyboardShow.');
+inputMethodEngine.getInputMethodEngine().on("keyboardShow", () => {
+ console.log("inputMethodEngine keyboardShow.");
});
-inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
- console.log('inputMethodEngine keyboardHide.');
+inputMethodEngine.getInputMethodEngine().on("keyboardHide", () => {
+ console.log("inputMethodEngine keyboardHide.");
});
```
@@ -221,93 +225,95 @@ inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void
-取消订阅输入法软键盘显示或隐藏事件。使用callback异步回调。
+取消订阅输入法软键盘显示或隐藏事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 要取消监听的输入法软键盘类型。
-'keyboardShow'表示显示输入法软键盘。
-'keyboardHide'表示隐藏输入法软键盘。|
-| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | ------------------------------------------------------------------------------------------------------------------ |
+| type | string | 是 | 要取消监听的输入法软键盘类型。
-'keyboardShow'表示显示输入法软键盘。
-'keyboardHide'表示隐藏输入法软键盘。 |
+| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getInputMethodEngine().off('keyboardShow');
-inputMethodEngine.getInputMethodEngine().off('keyboardHide');
+inputMethodEngine.getInputMethodEngine().off("keyboardShow");
+inputMethodEngine.getInputMethodEngine().off("keyboardHide");
```
## InputMethodAbility
-下列API均需使用[getInputMethodAbility](#inputmethodenginegetinputmethodability9)获取到InputMethodAbility实例后，通过实例调用。
+下列 API 均需使用[getInputMethodAbility](#inputmethodenginegetinputmethodability9)获取到 InputMethodAbility 实例后，通过实例调用。
### on('inputStart')9+
on(type: 'inputStart', callback: (kbController: KeyboardController, inputClient: InputClient) => void): void
-订阅输入法绑定成功事件。使用callback异步回调。
+订阅输入法绑定成功事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
-| callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 是 | 回调函数，返回输入法操作相关实例。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------------------------------------------------------------------------ | ---- | -------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
+| callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 是 | 回调函数，返回输入法操作相关实例。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().on('inputStart', (kbController, client) => {
- let keyboardController = kbController;
- let inputClient = client;
-});
+inputMethodEngine
+ .getInputMethodAbility()
+ .on("inputStart", (kbController, client) => {
+ let keyboardController = kbController;
+ let inputClient = client;
+ });
```
### off('inputStart')9+
off(type: 'inputStart', callback?: (kbController: KeyboardController, inputClient: InputClient) => void): void
-取消订阅输入法绑定成功事件。使用callback异步回调。
+取消订阅输入法绑定成功事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------------------- | ---- | ------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
-| callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------------------------------------------------------------------------ | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 |
+| callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().off('inputStart');
+inputMethodEngine.getInputMethodAbility().off("inputStart");
```
### on('inputStop')9+
on(type: 'inputStop', callback: () => void): void
-订阅停止输入法应用事件。使用callback异步回调。
+订阅停止输入法应用事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'inputStop'。 |
-| callback | () => void | 是 | 回调函数。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | ------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'inputStop'。 |
+| callback | () => void | 是 | 回调函数。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
- console.log('inputMethodAbility inputStop');
+inputMethodEngine.getInputMethodAbility().on("inputStop", () => {
+ console.log("inputMethodAbility inputStop");
});
```
@@ -315,22 +321,22 @@ inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
off(type: 'inputStop', callback: () => void): void
-取消订阅停止输入法应用事件。使用callback异步回调。
+取消订阅停止输入法应用事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'inputStop'。 |
-| callback | () => void | 是 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'inputStop'。 |
+| callback | () => void | 是 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
- console.log('inputMethodAbility delete inputStop notification.');
+inputMethodEngine.getInputMethodAbility().off("inputStop", () => {
+ console.log("inputMethodAbility delete inputStop notification.");
});
```
@@ -338,22 +344,22 @@ inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
on(type: 'setCallingWindow', callback: (wid: number) => void): void
-订阅设置调用窗口事件。使用callback异步回调。
+订阅设置调用窗口事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'setCallingWindow'。 |
-| callback | (wid: number) => void | 是 | 回调函数，返回调用方窗口的Id。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------- | ---- | -------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'setCallingWindow'。 |
+| callback | (wid: number) => void | 是 | 回调函数，返回调用方窗口的 Id。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid) => {
- console.log('inputMethodAbility setCallingWindow');
+inputMethodEngine.getInputMethodAbility().on("setCallingWindow", (wid) => {
+ console.log("inputMethodAbility setCallingWindow");
});
```
@@ -361,22 +367,22 @@ inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid) => {
off(type: 'setCallingWindow', callback: (wid:number) => void): void
-取消订阅设置调用窗口事件。使用callback异步回调。
+取消订阅设置调用窗口事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'setCallingWindow'。|
-| callback | (wid:number) => void | 是 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'setCallingWindow'。 |
+| callback | (wid:number) => void | 是 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().off('setCallingWindow', (wid) => {
- console.log('inputMethodAbility delete setCallingWindow notification.');
+inputMethodEngine.getInputMethodAbility().off("setCallingWindow", (wid) => {
+ console.log("inputMethodAbility delete setCallingWindow notification.");
});
```
@@ -384,25 +390,25 @@ inputMethodEngine.getInputMethodAbility().off('setCallingWindow', (wid) => {
on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void
-订阅输入法软键盘显示或隐藏事件。使用callback异步回调。
+订阅输入法软键盘显示或隐藏事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型。
- 'keyboardShow'表示显示输入法软键盘。
- 'keyboardHide'表示隐藏输入法软键盘。 |
-| callback | () => void | 是 | 回调函数。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | ---------------------------------------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型。
- 'keyboardShow'表示显示输入法软键盘。
- 'keyboardHide'表示隐藏输入法软键盘。 |
+| callback | () => void | 是 | 回调函数。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
- console.log('InputMethodAbility keyboardShow.');
+inputMethodEngine.getInputMethodAbility().on("keyboardShow", () => {
+ console.log("InputMethodAbility keyboardShow.");
});
-inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
- console.log('InputMethodAbility keyboardHide.');
+inputMethodEngine.getInputMethodAbility().on("keyboardHide", () => {
+ console.log("InputMethodAbility keyboardHide.");
});
```
@@ -410,25 +416,25 @@ inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void
-取消订阅输入法事件。使用callback异步回调。
+取消订阅输入法事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型。
- 'keyboardShow'表示显示键盘。
- 'keyboardHide'表示隐藏键盘。 |
-| callback | () => void | 否 | 回调函数。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | ------------------------------------------------------------------------------------ |
+| type | string | 是 | 设置监听类型。
- 'keyboardShow'表示显示键盘。
- 'keyboardHide'表示隐藏键盘。 |
+| callback | () => void | 否 | 回调函数。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
- console.log('InputMethodAbility delete keyboardShow notification.');
+inputMethodEngine.getInputMethodAbility().off("keyboardShow", () => {
+ console.log("InputMethodAbility delete keyboardShow notification.");
});
-inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
- console.log('InputMethodAbility delete keyboardHide notification.');
+inputMethodEngine.getInputMethodAbility().off("keyboardHide", () => {
+ console.log("InputMethodAbility delete keyboardHide notification.");
});
```
@@ -436,45 +442,47 @@ inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
on(type: 'setSubtype', callback: (inputMethodSubtype: InputMethodSubtype) => void): void
-订阅设置输入法子类型事件。使用callback异步回调。
+订阅设置输入法子类型事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | --- | ---- | --- |
-| type | string | 是 | 设置监听类型，固定取值为'setSubtype'。 |
-| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 是 | 回调函数，返回设置的输入法子类型。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------------------------------------------------------------- | ---- | -------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'setSubtype'。 |
+| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 是 | 回调函数，返回设置的输入法子类型。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype) => {
- console.log('InputMethodAbility setSubtype.');
-});
+inputMethodEngine
+ .getInputMethodAbility()
+ .on("setSubtype", (inputMethodSubtype) => {
+ console.log("InputMethodAbility setSubtype.");
+ });
```
### off('setSubtype')9+
off(type: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => void): void
-取消订阅输入法软键盘显示或隐藏事件。使用callback异步回调。
+取消订阅输入法软键盘显示或隐藏事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------- | ----- | ---- | ---- |
-| type | string | 是 | 设置监听类型，固定取值为'setSubtype'。 |
-| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------------------------------------------------------------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'setSubtype'。 |
+| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
- console.log('InputMethodAbility delete setSubtype notification.');
+inputMethodEngine.getInputMethodAbility().off("setSubtype", () => {
+ console.log("InputMethodAbility delete setSubtype notification.");
});
```
@@ -482,40 +490,42 @@ inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
createPanel(ctx: BaseContext, info: PanelInfo, callback: AsyncCallback\): void
-创建输入法面板，仅支持输入法应用调用。使用callback异步回调。
单个输入法应用仅允许创建一个[软键盘类型](#paneltype10)和[状态栏类型](#paneltype10)的面板。
+创建输入法面板，仅支持输入法应用调用。使用 callback 异步回调。
单个输入法应用仅允许创建一个[软键盘类型](#paneltype10)和[状态栏类型](#paneltype10)的面板。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------- | ----------- | ---- | ------------------------ |
-| ctx | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 当前输入法应用上下文信息。 |
-| info | [PanelInfo](#panelinfo10) | 是 | 输入法应用信息。 |
-| callback | AsyncCallback\<[Panel](#panel10)> | 是 | 回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------------------- | ---- | -------------------------------------------------------------- |
+| ctx | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 当前输入法应用上下文信息。 |
+| info | [PanelInfo](#panelinfo10) | 是 | 输入法应用信息。 |
+| callback | AsyncCallback\<[Panel](#panel10)> | 是 | 回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。 |
**错误码：**
-| 错误码ID | 错误信息 |
-| ---------- | ----------------------------- |
-| 12800004 | not an input method extension. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800004 | not an input method extension. |
**示例：**
```js
let panelInfo: inputMethodEngine.PanelInfo = {
- panelType: inputMethodEngine.PanelType.SOFT_KEYBOARD,
- panelFlag: inputMethodEngine.PanelFlag.FLG_FIXED
-}
+ type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
+ flag: inputMethodEngine.PanelFlag.FLG_FIXED,
+};
try {
- inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo, (err, panel) => {
- if (err) {
- console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
- return;
- }
- console.log('Succeed in creating panel.');
- })
-} catch(err) {
+ inputMethodEngine
+ .getInputMethodAbility()
+ .createPanel(this.context, panelInfo, (err, panel) => {
+ if (err) {
+ console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
+ return;
+ }
+ console.log("Succeed in creating panel.");
+ });
+} catch (err) {
console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
}
```
@@ -524,86 +534,94 @@ try {
createPanel(ctx: BaseContext, info: PanelInfo): Promise\
-创建输入法面板，仅支持输入法应用调用。使用promise异步回调。
单个输入法应用仅允许创建一个[软键盘类型](#paneltype10)和[状态栏类型](#paneltype10)的面板。
+创建输入法面板，仅支持输入法应用调用。使用 promise 异步回调。
单个输入法应用仅允许创建一个[软键盘类型](#paneltype10)和[状态栏类型](#paneltype10)的面板。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------- | ----------- | ---- | ------------------------ |
-| ctx | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 当前输入法应用上下文信息。 |
-| info | [PanelInfo](#panelinfo10) | 是 | 输入法面板信息。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------------------------------------------------------- | ---- | -------------------------- |
+| ctx | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 当前输入法应用上下文信息。 |
+| info | [PanelInfo](#panelinfo10) | 是 | 输入法面板信息。 |
**返回值：**
-| 类型 | 说明 |
+| 类型 | 说明 |
| ------- | ------------------------------------------------------------------ |
-| Promise\<[Panel](#panel10)> | 回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。 |
+| Promise\<[Panel](#panel10)> | 回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。 |
**错误码：**
-| 错误码ID | 错误信息 |
-| ---------- | ----------------------------- |
-| 12800004 | not an input method extension. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800004 | not an input method extension. |
**示例：**
```js
let panelInfo: inputMethodEngine.PanelInfo = {
- panelType: inputMethodEngine.PanelType.SOFT_KEYBOARD,
- panelFlag: inputMethodEngine.PanelFlag.FLG_FIXED
-}
-inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo).then((panel) => {
- console.log('Succeed in creating panel.');
-}).catch((err) => {
- console.error(`Failed to create panel: ${JSON.stringify(err)}`);
-})
+ type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
+ flag: inputMethodEngine.PanelFlag.FLG_FIXED,
+};
+inputMethodEngine
+ .getInputMethodAbility()
+ .createPanel(this.context, panelInfo)
+ .then((panel) => {
+ console.log("Succeed in creating panel.");
+ })
+ .catch((err) => {
+ console.error(`Failed to create panel: ${JSON.stringify(err)}`);
+ });
```
### destroyPanel10+
destroyPanel(panel: Panel, callback: AsyncCallback\): void;
-销毁输入法面板。使用callback异步回调。
+销毁输入法面板。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------- | ----------- | ---- | ------------------------ |
-| panel | [Panel](#panel10) | 是 | 要销毁的面板对象。 |
-| callback | AsyncCallback\ | 是 | 回调函数。当输入法面板销毁成功，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | ------------------------------------------------------------------ |
+| panel | [Panel](#panel10) | 是 | 要销毁的面板对象。 |
+| callback | AsyncCallback\ | 是 | 回调函数。当输入法面板销毁成功，err 为 undefined，否则为错误对象。 |
**示例：**
```js
let panelInfo: inputMethodEngine.PanelInfo = {
- panelType: inputMethodEngine.PanelType.SOFT_KEYBOARD,
- panelFlag: inputMethodEngine.PanelFlag.FLG_FIXED
-}
+ type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
+ flag: inputMethodEngine.PanelFlag.FLG_FIXED,
+};
try {
- inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo, (err, panel) => {
- if (err) {
- console.error(`Failed to create panel: ${JSON.stringify(err)}`);
- return;
- }
- globalThis.inputMethodPanel = panel;
- console.log('Succeed in creating panel.');
- })
-} catch(err) {
+ inputMethodEngine
+ .getInputMethodAbility()
+ .createPanel(this.context, panelInfo, (err, panel) => {
+ if (err) {
+ console.error(`Failed to create panel: ${JSON.stringify(err)}`);
+ return;
+ }
+ globalThis.inputMethodPanel = panel;
+ console.log("Succeed in creating panel.");
+ });
+} catch (err) {
console.error(`Failed to create panel: ${JSON.stringify(err)}`);
}
try {
- inputMethodEngine.getInputMethodAbility().destroyPanel(globalThis.inputMethodPanel, (err) => {
- if(err !== undefined) {
- console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
- return;
- }
- console.log('Succeed in destroying panel.');
- })
-} catch(err) {
+ inputMethodEngine
+ .getInputMethodAbility()
+ .destroyPanel(globalThis.inputMethodPanel, (err) => {
+ if (err !== undefined) {
+ console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
+ return;
+ }
+ console.log("Succeed in destroying panel.");
+ });
+} catch (err) {
console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
}
```
@@ -612,47 +630,53 @@ try {
destroyPanel(panel: Panel): Promise\;
-销毁输入法面板。使用promise异步回调。
+销毁输入法面板。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ---------| ----------- | ---- | ------------------------ |
-| panel | [Panel](#panel10) | 是 | 要销毁的面板对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ----------------- | ---- | ------------------ |
+| panel | [Panel](#panel10) | 是 | 要销毁的面板对象。 |
**返回值：**
-| 类型 | 说明 |
+| 类型 | 说明 |
| ------- | -------------------------------------------------------------------- |
-| Promise\ | 无返回结果的Promise对象。|
+| Promise\ | 无返回结果的 Promise 对象。|
**示例：**
```js
let panelInfo: inputMethodEngine.PanelInfo = {
- panelType: inputMethodEngine.PanelType.SOFT_KEYBOARD,
- panelFlag: inputMethodEngine.PanelFlag.FLG_FIXED
-}
+ type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
+ flag: inputMethodEngine.PanelFlag.FLG_FIXED,
+};
try {
- inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo, (err, panel) => {
- if (err) {
- console.error(`Failed to create panel: ${JSON.stringify(err)}`);
- return;
- }
- globalThis.inputMethodPanel = panel;
- console.log('Succeed in creating panel.');
- })
-} catch(err) {
+ inputMethodEngine
+ .getInputMethodAbility()
+ .createPanel(this.context, panelInfo, (err, panel) => {
+ if (err) {
+ console.error(`Failed to create panel: ${JSON.stringify(err)}`);
+ return;
+ }
+ globalThis.inputMethodPanel = panel;
+ console.log("Succeed in creating panel.");
+ });
+} catch (err) {
console.error(`Failed to create panel: ${JSON.stringify(err)}`);
}
try {
- inputMethodEngine.getInputMethodAbility().destroyPanel(globalThis.inputMethodPanel).then(() => {
- console.log('Succeed in destroying panel.');
- }).catch((err) => {
- console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
- });
+ inputMethodEngine
+ .getInputMethodAbility()
+ .destroyPanel(globalThis.inputMethodPanel)
+ .then(() => {
+ console.log("Succeed in destroying panel.");
+ })
+ .catch((err) => {
+ console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
}
@@ -660,34 +684,43 @@ try {
## KeyboardDelegate
-下列API均需使用[getKeyboardDelegate](#inputmethodenginegetkeyboarddelegate9)获取到KeyboardDelegate实例后，通过实例调用。
+下列 API 均需使用[getKeyboardDelegate](#inputmethodenginegetkeyboarddelegate9)获取到 KeyboardDelegate 实例后，通过实例调用。
### on('keyDown'|'keyUp')
on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void
-订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。
+订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型。
- 'keyDown'表示键盘按下。
- 'keyUp'表示键盘抬起。 |
-| callback | (event: [KeyEvent](#keyevent)) => boolean | 是 | 回调函数，返回按键信息。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------------------ |
+| type | string | 是 | 设置监听类型。
- 'keyDown'表示键盘按下。
- 'keyUp'表示键盘抬起。 |
+| callback | (event: [KeyEvent](#keyevent)) => boolean | 是 | 回调函数，返回按键信息。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent) => {
- console.log('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
- console.log('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
+inputMethodEngine.getKeyboardDelegate().on("keyUp", (keyEvent) => {
+ console.log(
+ "inputMethodEngine keyCode.(keyUp):" + JSON.stringify(keyEvent.keyCode)
+ );
+ console.log(
+ "inputMethodEngine keyAction.(keyUp):" + JSON.stringify(keyEvent.keyAction)
+ );
return true;
});
-inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
- console.log('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
- console.log('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
+inputMethodEngine.getKeyboardDelegate().on("keyDown", (keyEvent) => {
+ console.log(
+ "inputMethodEngine keyCode.(keyDown):" + JSON.stringify(keyEvent.keyCode)
+ );
+ console.log(
+ "inputMethodEngine keyAction.(keyDown):" +
+ JSON.stringify(keyEvent.keyAction)
+ );
return true;
});
```
@@ -696,26 +729,26 @@ inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void
-取消订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。
+取消订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------- | ---- | ----- |
-| type | string | 是 | 设置监听类型。
- 'keyDown'表示键盘按下。
- 'keyUp'表示键盘抬起。 |
-| callback | (event: [KeyEvent](#keyevent)) => boolean | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------------------ |
+| type | string | 是 | 设置监听类型。
- 'keyDown'表示键盘按下。
- 'keyUp'表示键盘抬起。 |
+| callback | (event: [KeyEvent](#keyevent)) => boolean | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent) => {
- console.log('delete keyUp notification.');
+inputMethodEngine.getKeyboardDelegate().off("keyUp", (keyEvent) => {
+ console.log("delete keyUp notification.");
return true;
});
-inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
- console.log('delete keyDown notification.');
+inputMethodEngine.getKeyboardDelegate().off("keyDown", (keyEvent) => {
+ console.log("delete keyDown notification.");
return true;
});
```
@@ -724,24 +757,30 @@ inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
on(type: 'keyEvent', callback: (event: InputKeyEvent) => boolean): void
-订阅硬键盘（即物理键盘）事件。使用callback异步回调。
+订阅硬键盘（即物理键盘）事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'keyEvent'。 |
-| callback | function | 是 | 回调函数，入参为按键事件信息，返回值类型为布尔类型。
- 入参按键事件信息的数据类型为[InputKeyEvent](js-apis-keyevent.md#KeyEvent)。
- 若按键事件被事件订阅者消费，则callback应返回true，否则返回false。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'keyEvent'。 |
+| callback | function | 是 | 回调函数，入参为按键事件信息，返回值类型为布尔类型。
- 入参按键事件信息的数据类型为[InputKeyEvent](js-apis-keyevent.md#KeyEvent)。
- 若按键事件被事件订阅者消费，则 callback 应返回 true，否则返回 false。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().on('keyEvent', (keyEvent) => {
- console.log('inputMethodEngine keyEvent.action:' + JSON.stringify(keyEvent.action));
- console.log('inputMethodEngine keyEvent.key.code:' + JSON.stringify(keyEvent.key.code));
- console.log('inputMethodEngine keyEvent.ctrlKey:' + JSON.stringify(keyEvent.ctrlKey));
+inputMethodEngine.getKeyboardDelegate().on("keyEvent", (keyEvent) => {
+ console.log(
+ "inputMethodEngine keyEvent.action:" + JSON.stringify(keyEvent.action)
+ );
+ console.log(
+ "inputMethodEngine keyEvent.key.code:" + JSON.stringify(keyEvent.key.code)
+ );
+ console.log(
+ "inputMethodEngine keyEvent.ctrlKey:" + JSON.stringify(keyEvent.ctrlKey)
+ );
return true;
});
```
@@ -750,145 +789,160 @@ inputMethodEngine.getKeyboardDelegate().on('keyEvent', (keyEvent) => {
off(type: 'keyEvent', callback?: (event: InputKeyEvent) => boolean): void
-取消订阅硬键盘（即物理键盘）事件。使用callback异步回调。
+取消订阅硬键盘（即物理键盘）事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 设置监听类型，固定取值为'keyEvent'。 |
-| callback | function | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 设置监听类型，固定取值为'keyEvent'。 |
+| callback | function | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().off('keyEvent', (keyEvent) => {
- console.log('This is a callback function which will be deregistered.');
+inputMethodEngine.getKeyboardDelegate().off("keyEvent", (keyEvent) => {
+ console.log("This is a callback function which will be deregistered.");
return true;
});
-inputMethodEngine.getKeyboardDelegate().off('keyEvent');
+inputMethodEngine.getKeyboardDelegate().off("keyEvent");
```
### on('cursorContextChange')
on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) => void): void
-订阅光标变化事件。使用callback异步回调。
+订阅光标变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---- | ---- | ----- |
-| type | string | 是 | 光标变化事件，固定取值为'cursorContextChange'。 |
-| callback | (x: number, y: number, height: number) => void | 是 | 回调函数，返回光标信息。
-x为光标上端的的x坐标值，y为光标上端的y坐标值，height为光标的高度值。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------------------------- | ---- | --------------------------------------------------------------------------------------------------------- |
+| type | string | 是 | 光标变化事件，固定取值为'cursorContextChange'。 |
+| callback | (x: number, y: number, height: number) => void | 是 | 回调函数，返回光标信息。
-x 为光标上端的的 x 坐标值，y 为光标上端的 y 坐标值，height 为光标的高度值。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().on('cursorContextChange', (x, y, height) => {
- console.log('inputMethodEngine cursorContextChange x:' + x);
- console.log('inputMethodEngine cursorContextChange y:' + y);
- console.log('inputMethodEngine cursorContextChange height:' + height);
-});
+inputMethodEngine
+ .getKeyboardDelegate()
+ .on("cursorContextChange", (x, y, height) => {
+ console.log("inputMethodEngine cursorContextChange x:" + x);
+ console.log("inputMethodEngine cursorContextChange y:" + y);
+ console.log("inputMethodEngine cursorContextChange height:" + height);
+ });
```
### off('cursorContextChange')
off(type: 'cursorContextChange', callback?: (x: number, y: number, height: number) => void): void
-取消订阅光标变化事件。使用callback异步回调。
+取消订阅光标变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
- **参数：**
-
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---- | ---- | ------ |
-| type | string | 是 | 光标变化事件，固定取值为'cursorContextChange' |
-| callback | (x: number, y:number, height:number) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+**参数：**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------------------------------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 光标变化事件，固定取值为'cursorContextChange' |
+| callback | (x: number, y:number, height:number) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
- **示例：**
+**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x, y, height) => {
- console.log('delete cursorContextChange notification.');
-});
+inputMethodEngine
+ .getKeyboardDelegate()
+ .off("cursorContextChange", (x, y, height) => {
+ console.log("delete cursorContextChange notification.");
+ });
```
+
### on('selectionChange')
on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void
-订阅文本选择范围变化事件。使用callback异步回调。
+订阅文本选择范围变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ----- | ---- | ---- |
-| type | string | 是 | 文本选择变化事件，固定取值为'selectionChange'。 |
-| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 是 | 回调函数，返回文本选择信息。
- oldBegin为变化前被选中文本的起始下标，oldEnd为变化前被选中文本的终止下标。
- newBegin为变化后被选中文本的起始下标，newEnd为变化后被选中文本的终止下标。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------------------------------------------------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| type | string | 是 | 文本选择变化事件，固定取值为'selectionChange'。 |
+| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 是 | 回调函数，返回文本选择信息。
- oldBegin 为变化前被选中文本的起始下标，oldEnd 为变化前被选中文本的终止下标。
- newBegin 为变化后被选中文本的起始下标，newEnd 为变化后被选中文本的终止下标。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().on('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
- console.log('inputMethodEngine beforeEach selectionChange oldBegin:' + oldBegin);
- console.log('inputMethodEngine beforeEach selectionChange oldEnd:' + oldEnd);
- console.log('inputMethodEngine beforeEach selectionChange newBegin:' + newBegin);
- console.log('inputMethodEngine beforeEach selectionChange newEnd:' + newEnd);
-});
+inputMethodEngine
+ .getKeyboardDelegate()
+ .on("selectionChange", (oldBegin, oldEnd, newBegin, newEnd) => {
+ console.log(
+ "inputMethodEngine beforeEach selectionChange oldBegin:" + oldBegin
+ );
+ console.log(
+ "inputMethodEngine beforeEach selectionChange oldEnd:" + oldEnd
+ );
+ console.log(
+ "inputMethodEngine beforeEach selectionChange newBegin:" + newBegin
+ );
+ console.log(
+ "inputMethodEngine beforeEach selectionChange newEnd:" + newEnd
+ );
+ });
```
### off('selectionChange')
off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void
-取消订阅文本选择范围变化事件。使用callback异步回调。
+取消订阅文本选择范围变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------- | ---- | ------- |
-| type | string | 是 | 文本选择变化事件，固定取值为'selectionChange'。 |
-| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------------------------------------------------------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 文本选择变化事件，固定取值为'selectionChange'。 |
+| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().off('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
- console.log('delete selectionChange notification.');
-});
+inputMethodEngine
+ .getKeyboardDelegate()
+ .off("selectionChange", (oldBegin, oldEnd, newBegin, newEnd) => {
+ console.log("delete selectionChange notification.");
+ });
```
-
### on('textChange')
on(type: 'textChange', callback: (text: string) => void): void
-订阅文本内容变化事件。使用callback异步回调。
+订阅文本内容变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 文本变化事件，固定取值为'textChange'。 |
-| callback | (text: string) => void | 是 | 回调函数，返回订阅的文本内容。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------- | ---- | -------------------------------------- |
+| type | string | 是 | 文本变化事件，固定取值为'textChange'。 |
+| callback | (text: string) => void | 是 | 回调函数，返回订阅的文本内容。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => {
- console.log('inputMethodEngine textChange. text:' + text);
+inputMethodEngine.getKeyboardDelegate().on("textChange", (text) => {
+ console.log("inputMethodEngine textChange. text:" + text);
});
```
@@ -896,22 +950,22 @@ inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => {
off(type: 'textChange', callback?: (text: string) => void): void
-取消订阅文本内容变化事件。使用callback异步回调。
+取消订阅文本内容变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 文本变化事件，固定取值为'textChange'。 |
-| callback | (text: string) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 文本变化事件，固定取值为'textChange'。 |
+| callback | (text: string) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {
- console.log('delete textChange notification. text:' + text);
+inputMethodEngine.getKeyboardDelegate().off("textChange", (text) => {
+ console.log("delete textChange notification. text:" + text);
});
```
@@ -919,22 +973,24 @@ inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {
on(type: 'editorAttributeChanged', callback: (attr: EditorAttribute) => void): void
-订阅编辑框属性变化事件。使用callback异步回调。
+订阅编辑框属性变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 文本变化事件，固定取值为'editorAttributeChanged'。 |
-| callback | (attr: EditorAttribute) => void | 是 | 回调函数，返回变化的编辑框属性。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------- | ---- | -------------------------------------------------- |
+| type | string | 是 | 文本变化事件，固定取值为'editorAttributeChanged'。 |
+| callback | (attr: EditorAttribute) => void | 是 | 回调函数，返回变化的编辑框属性。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().on('editorAttributeChanged', (attr) => {
- console.log(`Succeeded in receiving attribute of editor, inputPattern = ${attr.inputPattern}, enterKeyType = ${attr.enterKeyType}`);
+inputMethodEngine.getKeyboardDelegate().on("editorAttributeChanged", (attr) => {
+ console.log(
+ `Succeeded in receiving attribute of editor, inputPattern = ${attr.inputPattern}, enterKeyType = ${attr.enterKeyType}`
+ );
});
```
@@ -942,52 +998,52 @@ inputMethodEngine.getKeyboardDelegate().on('editorAttributeChanged', (attr) => {
off(type: 'editorAttributeChanged', callback?: (attr: EditorAttribute) => void): void
-取消订阅编辑框属性变化事件。使用callback异步回调。
+取消订阅编辑框属性变化事件。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | 是 | 文本变化事件，固定取值为'editorAttributeChanged'。 |
-| callback | (attr: EditorAttribute) => void | 否 | 所要取消订阅的回调处理函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------- | ---- | ---------------------------------------------------------------------------- |
+| type | string | 是 | 文本变化事件，固定取值为'editorAttributeChanged'。 |
+| callback | (attr: EditorAttribute) => void | 否 | 所要取消订阅的回调处理函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-inputMethodEngine.getKeyboardDelegate().off('editorAttributeChanged');
+inputMethodEngine.getKeyboardDelegate().off("editorAttributeChanged");
```
## Panel10+
-下列API均需使用[createPanel](#createpanel10)获取到Panel实例后，通过实例调用。
+下列 API 均需使用[createPanel](#createpanel10)获取到 Panel 实例后，通过实例调用。
### setUiContent10+
setUiContent(path: string, callback: AsyncCallback\): void
-为当前的输入法面板加载具体页面内容，使用callback异步回调。
+为当前的输入法面板加载具体页面内容，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| path | string | 是 | 具体页面的路径。 |
-| callback | AsyncCallback\ | 是 | 回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | ------------------------------------------------------------------------- |
+| path | string | 是 | 具体页面的路径。 |
+| callback | AsyncCallback\ | 是 | 回调函数。当面板页面内容加载成功，err 为 undefined，否则 err 为错误对象。 |
**示例：**
```js
try {
- panel.setUiContent('pages/page2/page2', (err) => {
+ panel.setUiContent("pages/page2/page2", (err) => {
if (err) {
console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in setting the content.');
+ console.log("Succeeded in setting the content.");
});
} catch (err) {
console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
@@ -998,32 +1054,34 @@ try {
setUiContent(path: string): Promise\
-为当前的输入法面板加载具体页面内容，使用Promise异步回调。
+为当前的输入法面板加载具体页面内容，使用 Promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| path | string | 是 | 具体页面的路径。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------------- |
+| path | string | 是 | 具体页面的路径。 |
**返回值：**
-| 类型 | 说明 |
-| ------- | ------------------------------ |
-| Promise\ | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| -------------- | --------------------------- |
+| Promise\ | 无返回结果的 Promise 对象。 |
**示例：**
```js
try {
- let promise = panel.setUiContent('pages/page2/page2');
- promise.then(() => {
- console.log('Succeeded in setting the content.');
- }).catch((err) =>{
- console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
- });
+ let promise = panel.setUiContent("pages/page2/page2");
+ promise
+ .then(() => {
+ console.log("Succeeded in setting the content.");
+ })
+ .catch((err) => {
+ console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}
@@ -1033,30 +1091,30 @@ try {
setUiContent(path: string, storage: LocalStorage, callback: AsyncCallback\): void
-为当前的输入法面板加载与LocalStorage相关联的具体页面内容，使用callback异步回调。
+为当前的输入法面板加载与 LocalStorage 相关联的具体页面内容，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| path | string | 是 | LocalStorage相关联的具体页面的路径。 |
-| storage | [LocalStorage](../arkui-ts/ts-state-management.md#localstorage9) | 是 | 存储单元，为应用程序范围内的可变和不可变状态属性提供存储。|
-| callback | AsyncCallback\ | 是 | 回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------------------------------------------- | ---- | ------------------------------------------------------------------------- |
+| path | string | 是 | LocalStorage 相关联的具体页面的路径。 |
+| storage | [LocalStorage](../arkui-ts/ts-state-management.md#localstorage9) | 是 | 存储单元，为应用程序范围内的可变和不可变状态属性提供存储。 |
+| callback | AsyncCallback\ | 是 | 回调函数。当面板页面内容加载成功，err 为 undefined，否则 err 为错误对象。 |
**示例：**
```js
let storage = new LocalStorage();
-storage.setOrCreate('storageSimpleProp',121);
+storage.setOrCreate("storageSimpleProp", 121);
try {
- panel.setUiContent('pages/page2/page2', storage, (err) => {
+ panel.setUiContent("pages/page2/page2", storage, (err) => {
if (err) {
console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in setting the content.');
+ console.log("Succeeded in setting the content.");
});
} catch (err) {
console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
@@ -1067,35 +1125,37 @@ try {
setUiContent(path: string, storage: LocalStorage): Promise\
-为当前面板加载与LocalStorage相关联的具体页面内容，使用Promise异步回调。
+为当前面板加载与 LocalStorage 相关联的具体页面内容，使用 Promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| path | string | 是 | 设置加载页面的路径。 |
-| storage | [LocalStorage](../arkui-ts/ts-state-management.md#localstorage9) | 是 | 存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。|
+| 参数名 | 类型 | 必填 | 说明 |
+| ------- | ---------------------------------------------------------------- | ---- | ------------------------------------------------------------------ |
+| path | string | 是 | 设置加载页面的路径。 |
+| storage | [LocalStorage](../arkui-ts/ts-state-management.md#localstorage9) | 是 | 存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。 |
**返回值：**
-| 类型 | 说明 |
-| ------- | ------------------------------ |
-| Promise\ | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| -------------- | --------------------------- |
+| Promise\ | 无返回结果的 Promise 对象。 |
**示例：**
```js
let storage = new LocalStorage();
-storage.setOrCreate('storageSimpleProp',121);
+storage.setOrCreate("storageSimpleProp", 121);
try {
- let promise = panel.setUiContent('pages/page2/page2');
- promise.then(() => {
- console.log('Succeeded in setting the content.');
- }).catch((err) =>{
- console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
- });
+ let promise = panel.setUiContent("pages/page2/page2");
+ promise
+ .then(() => {
+ console.log("Succeeded in setting the content.");
+ })
+ .catch((err) => {
+ console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}
@@ -1105,21 +1165,21 @@ try {
resize(width: number, height: number, callback: AsyncCallback\): void
-改变当前输入法面板的大小，使用callback异步回调。
+改变当前输入法面板的大小，使用 callback 异步回调。
> **说明**
>
-> 面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.6倍。
+> 面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的 0.6 倍。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| width | number | 是 | 目标面板的宽度，单位为px。|
-| height | number | 是 | 目标面板的高度，单位为px。|
-| callback | AsyncCallback\ | 是 | 回调函数。当面板大小改变成功，err为undefined，否则err为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | --------------------------------------------------------------------- |
+| width | number | 是 | 目标面板的宽度，单位为 px。 |
+| height | number | 是 | 目标面板的高度，单位为 px。 |
+| callback | AsyncCallback\ | 是 | 回调函数。当面板大小改变成功，err 为 undefined，否则 err 为错误对象。 |
**示例：**
@@ -1130,7 +1190,7 @@ try {
console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in changing the panel size.');
+ console.log("Succeeded in changing the panel size.");
});
} catch (err) {
console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
@@ -1141,37 +1201,39 @@ try {
resize(width: number, height: number): Promise\;
-改变当前输入法面板的大小，使用Promise异步回调。
+改变当前输入法面板的大小，使用 Promise 异步回调。
> **说明**
>
-> 面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.6倍。
+> 面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的 0.6 倍。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| width | number | 是 | 目标面板的宽度，单位为px。|
-| height | number | 是 | 目标面板的高度，单位为px。|
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | --------------------------- |
+| width | number | 是 | 目标面板的宽度，单位为 px。 |
+| height | number | 是 | 目标面板的高度，单位为 px。 |
**返回值：**
-| 类型 | 说明 |
-| ------- | ------------------------------ |
-| Promise\ | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| -------------- | --------------------------- |
+| Promise\ | 无返回结果的 Promise 对象。 |
**示例：**
```js
try {
let promise = panel.resize(500, 1000);
- promise.then(() => {
- console.log('Succeeded in changing the panel size.');
- }).catch((err) =>{
- console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
- });
+ promise
+ .then(() => {
+ console.log("Succeeded in changing the panel size.");
+ })
+ .catch((err) => {
+ console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
}
@@ -1181,31 +1243,31 @@ try {
moveTo(x: number, y: number, callback: AsyncCallback\): void
-移动面板位置，使用callback异步回调。[面板状态](#panelflag10)为固定态时，不产生实际移动效果。
+移动面板位置，使用 callback 异步回调。[面板状态](#panelflag10)为固定态时，不产生实际移动效果。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| x | number | 是 | x轴方向移动的值，值大于0表示右移，单位为px。|
-| y | number | 是 | y轴方向移动的值，值大于0表示下移，单位为px。|
-| callback | AsyncCallback\ | 是 | 回调函数。当面板位置移动成功，err为undefined，否则err为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | --------------------------------------------------------------------- |
+| x | number | 是 | x 轴方向移动的值，值大于 0 表示右移，单位为 px。 |
+| y | number | 是 | y 轴方向移动的值，值大于 0 表示下移，单位为 px。 |
+| callback | AsyncCallback\ | 是 | 回调函数。当面板位置移动成功，err 为 undefined，否则 err 为错误对象。 |
**示例：**
```js
try {
- panel.moveTo(300, 300, (err) =>{
+ panel.moveTo(300, 300, (err) => {
if (err) {
console.error(`Failed to move panel: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in moving the panel.');
+ console.log("Succeeded in moving the panel.");
});
} catch (err) {
- console.error(`Failed to move panel: ${JSON.stringify(err)}`);
+ console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}
```
@@ -1213,33 +1275,35 @@ try {
moveTo(x: number, y: number): Promise\
-移动面板位置，使用promise异步回调。[面板状态](#panelflag10)为固定态时，不产生实际移动效果。
+移动面板位置，使用 promise 异步回调。[面板状态](#panelflag10)为固定态时，不产生实际移动效果。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| x | number | 是 |x轴方向移动的值，值大于0表示右移，单位为px。|
-| y | number | 是 |y轴方向移动的值，值大于0表示下移，单位为px。|
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ------------------------------------------------ |
+| x | number | 是 | x 轴方向移动的值，值大于 0 表示右移，单位为 px。 |
+| y | number | 是 | y 轴方向移动的值，值大于 0 表示下移，单位为 px。 |
**返回值：**
-| 类型 | 说明 |
-| ------- | ------------------------------ |
-| Promise\ | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| -------------- | --------------------------- |
+| Promise\ | 无返回结果的 Promise 对象。 |
**示例：**
```js
try {
let promise = panel.moveTo(300, 300);
- promise.then(() => {
- console.log('Succeeded in moving the panel.');
- }).catch((err) =>{
- console.error(`Failed to move panel: ${JSON.stringify(err)}`);
- });
+ promise
+ .then(() => {
+ console.log("Succeeded in moving the panel.");
+ })
+ .catch((err) => {
+ console.error(`Failed to move panel: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}
@@ -1249,15 +1313,15 @@ try {
show(callback: AsyncCallback\): void
-显示当前输入法面板，使用callback异步回调。
+显示当前输入法面板，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| callback | AsyncCallback\ | 是 | 回调函数。当面板显示成功，err为undefined，否则err为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | ----------------------------------------------------------------- |
+| callback | AsyncCallback\ | 是 | 回调函数。当面板显示成功，err 为 undefined，否则 err 为错误对象。 |
**示例：**
@@ -1267,7 +1331,7 @@ panel.show((err) => {
console.error(`Failed to show panel: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in showing the panel.');
+ console.log("Succeeded in showing the panel.");
});
```
@@ -1275,40 +1339,42 @@ panel.show((err) => {
show(): Promise\
-显示当前输入法面板，使用promise异步回调。
+显示当前输入法面板，使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| ------- | ------------------------------ |
-| Promise\ | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| -------------- | --------------------------- |
+| Promise\ | 无返回结果的 Promise 对象。 |
**示例：**
```js
let promise = panel.show();
-promise.then(() => {
- console.log('Succeeded in showing the panel.');
-}).catch((err) =>{
- console.error(`Failed to show panel: ${JSON.stringify(err)}`);
-});
+promise
+ .then(() => {
+ console.log("Succeeded in showing the panel.");
+ })
+ .catch((err) => {
+ console.error(`Failed to show panel: ${JSON.stringify(err)}`);
+ });
```
### hide10+
hide(callback: AsyncCallback\): void
-隐藏当前输入法面板，使用callback异步回调。
+隐藏当前输入法面板，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| callback | AsyncCallback\ | 是 | 回调函数。当面板隐藏成功，err为undefined，否则err为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------- | ---- | ----------------------------------------------------------------- |
+| callback | AsyncCallback\ | 是 | 回调函数。当面板隐藏成功，err 为 undefined，否则 err 为错误对象。 |
**示例：**
@@ -1318,7 +1384,7 @@ panel.hide((err) => {
console.error(`Failed to hide panel: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in hiding the panel.');
+ console.log("Succeeded in hiding the panel.");
});
```
@@ -1326,47 +1392,49 @@ panel.hide((err) => {
hide(): Promise\
-隐藏当前输入法面板，使用promise异步回调。
+隐藏当前输入法面板，使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| ------- | ------------------------------ |
-| Promise\ | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| -------------- | --------------------------- |
+| Promise\ | 无返回结果的 Promise 对象。 |
**示例：**
```js
let promise = panel.hide();
-promise.then(() => {
- console.log('Succeeded in hiding the panel.');
-}).catch((err) =>{
- console.error(`Failed to hide panel: ${JSON.stringify(err)}`);
-});
+promise
+ .then(() => {
+ console.log("Succeeded in hiding the panel.");
+ })
+ .catch((err) => {
+ console.error(`Failed to hide panel: ${JSON.stringify(err)}`);
+ });
```
### on('show')10+
on(type: 'show', callback: () => void): void
-监听当前面板显示状态，使用callback异步回调。
+监听当前面板显示状态，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| type | string | 是 | 监听当前面板的状态类型，固定取值为'show'。 |
-| callback | () => void | 是 | 回调函数。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | ------------------------------------------ |
+| type | string | 是 | 监听当前面板的状态类型，固定取值为'show'。 |
+| callback | () => void | 是 | 回调函数。 |
**示例：**
```js
-panel.on('show', () => {
- console.log('Panel is showing.');
+panel.on("show", () => {
+ console.log("Panel is showing.");
});
```
@@ -1374,22 +1442,22 @@ panel.on('show', () => {
on(type: 'hide', callback: () => void): void
-监听当前面板隐藏状态，使用callback异步回调。
+监听当前面板隐藏状态，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| type | string | 是 | 监听当前面板的状态类型，固定取值为'hide'。 |
-| callback | () => void | 是 | 回调函数。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | ------------------------------------------ |
+| type | string | 是 | 监听当前面板的状态类型，固定取值为'hide'。 |
+| callback | () => void | 是 | 回调函数。 |
**示例：**
```js
-panel.on('hide', () => {
- console.log('Panel is hiding.');
+panel.on("hide", () => {
+ console.log("Panel is hiding.");
});
```
@@ -1397,42 +1465,42 @@ panel.on('hide', () => {
off(type: 'show', callback?: () => void): void
-取消监听当前输入法面板的隐藏状态，使用callback异步回调。
+取消监听当前输入法面板的隐藏状态，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| type | string | 是 | 取消监听当前面板的状态类型，固定取值为'show'。 |
-| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 取消监听当前面板的状态类型，固定取值为'show'。 |
+| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-panel.off('show');
+panel.off("show");
```
### off('hide')10+
off(type: 'hide', callback?: () => void): void
-取消监听当前面板隐藏状态，使用callback异步回调。
+取消监听当前面板隐藏状态，使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| type | string | 是 | 要取消监听的当前面板状态类型，固定取值为'hide'。 |
-| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------- | ---- | -------------------------------------------------------------------- |
+| type | string | 是 | 要取消监听的当前面板状态类型，固定取值为'hide'。 |
+| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅 type 对应的所有回调事件。 |
**示例：**
```js
-panel.off('hide');
+panel.off("hide");
```
### changeFlag10+
@@ -1445,9 +1513,9 @@ changeFlag(flag: PanelFlag): void
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| flag | [PanelFlag](#panelflag10) | 是 | 目标面板状态类型。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------------------------- | ---- | ------------------ |
+| flag | [PanelFlag](#panelflag10) | 是 | 目标面板状态类型。 |
**示例：**
@@ -1458,29 +1526,29 @@ panel.changeFlag(panelFlag);
## KeyboardController
-下列API均需使用[on('inputStart')](#oninputstart9)获取到KeyboardController实例后，通过实例调用。
+下列 API 均需使用[on('inputStart')](#oninputstart9)获取到 KeyboardController 实例后，通过实例调用。
### hide9+
hide(callback: AsyncCallback<void>): void
-隐藏输入法。使用callback异步回调。
+隐藏输入法。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| callback | AsyncCallback<void> | 是 | 回调函数。当输入法隐藏成功，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------- | ---- | -------------------------------------------------------------- |
+| callback | AsyncCallback<void> | 是 | 回调函数。当输入法隐藏成功，err 为 undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
@@ -1490,7 +1558,7 @@ keyboardController.hide((err) => {
console.error(`Failed to hide: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in hiding keyboard.');
+ console.log("Succeeded in hiding keyboard.");
});
```
@@ -1498,51 +1566,54 @@ keyboardController.hide((err) => {
hide(): Promise<void>
-隐藏输入法。使用promise异步回调。
+隐藏输入法。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| ---------------- | ------------------------- |
-| Promise<void> | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| ---------------- | --------------------------- |
+| Promise<void> | 无返回结果的 Promise 对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
```js
-keyboardController.hide().then(() => {
- console.log('Succeeded in hiding keyboard.');
-}).catch((err) => {
- console.log(`Failed to hide: ${JSON.stringify(err)}`);
-});
+keyboardController
+ .hide()
+ .then(() => {
+ console.log("Succeeded in hiding keyboard.");
+ })
+ .catch((err) => {
+ console.log(`Failed to hide: ${JSON.stringify(err)}`);
+ });
```
### hideKeyboard(deprecated)
hideKeyboard(callback: AsyncCallback<void>): void
-隐藏输入法。使用callback异步回调。
+隐藏输入法。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[hide](#hide9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[hide](#hide9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------- | ---- | -------- |
-| callback | AsyncCallback<void> | 是 | 回调函数。当输入法隐藏成功，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------- | ---- | -------------------------------------------------------------- |
+| callback | AsyncCallback<void> | 是 | 回调函数。当输入法隐藏成功，err 为 undefined，否则为错误对象。 |
**示例：**
@@ -1552,7 +1623,7 @@ keyboardController.hideKeyboard((err) => {
console.error(`Failed to hideKeyboard: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in hiding keyboard.');
+ console.log("Succeeded in hiding keyboard.");
});
```
@@ -1560,28 +1631,31 @@ keyboardController.hideKeyboard((err) => {
hideKeyboard(): Promise<void>
-隐藏输入法。使用promise异步回调。
+隐藏输入法。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[hide](#hide9-1)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[hide](#hide9-1)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| ---------------- | ------------------------- |
-| Promise<void> | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| ---------------- | --------------------------- |
+| Promise<void> | 无返回结果的 Promise 对象。 |
**示例：**
```js
-keyboardController.hideKeyboard().then(() => {
- console.log('Succeeded in hiding keyboard.');
-}).catch((err) => {
- console.log(`Failed to hideKeyboard: ${JSON.stringify(err)}`);
-});
+keyboardController
+ .hideKeyboard()
+ .then(() => {
+ console.log("Succeeded in hiding keyboard.");
+ })
+ .catch((err) => {
+ console.log(`Failed to hideKeyboard: ${JSON.stringify(err)}`);
+ });
```
## ExtendAction10+
@@ -1590,12 +1664,12 @@ keyboardController.hideKeyboard().then(() => {
**系统能力**: SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 值 |说明 |
-| -------- | -------- |-------- |
-| SELECT_ALL | 0 |全选。 |
-| CUT | 3 |剪切。 |
-| COPY | 4 |复制。 |
-| PASTE | 5 |粘贴。 |
+| 名称 | 值 | 说明 |
+| ---------- | --- | ------ |
+| SELECT_ALL | 0 | 全选。 |
+| CUT | 3 | 剪切。 |
+| COPY | 4 | 复制。 |
+| PASTE | 5 | 粘贴。 |
## Direction10+
@@ -1603,12 +1677,12 @@ keyboardController.hideKeyboard().then(() => {
**系统能力**: SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 值 |说明 |
-| -------- | -------- |-------- |
-| CURSOR_UP | 1 |向上。 |
-| CURSOR_DOWN | 2 |向下。 |
-| CURSOR_LEFT | 3 |向左。 |
-| CURSOR_RIGHT | 4 |向右。 |
+| 名称 | 值 | 说明 |
+| ------------ | --- | ------ |
+| CURSOR_UP | 1 | 向上。 |
+| CURSOR_DOWN | 2 | 向下。 |
+| CURSOR_LEFT | 3 | 向左。 |
+| CURSOR_RIGHT | 4 | 向右。 |
## Range10+
@@ -1616,10 +1690,10 @@ keyboardController.hideKeyboard().then(() => {
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| start | number | 是 | 是 | 选中文本的首字符在编辑框的索引值。|
-| end | number | 是 | 是 | 选中文本的末字符在编辑框的索引值。|
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| ----- | ------ | ---- | ---- | ---------------------------------- |
+| start | number | 是 | 是 | 选中文本的首字符在编辑框的索引值。 |
+| end | number | 是 | 是 | 选中文本的末字符在编辑框的索引值。 |
## Movement10+
@@ -1627,38 +1701,38 @@ keyboardController.hideKeyboard().then(() => {
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| direction | [Direction](#direction10) | 是 | 是 | 选中文本时，光标的移动方向。|
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| --------- | ------------------------- | ---- | ---- | ---------------------------- |
+| direction | [Direction](#direction10) | 是 | 是 | 选中文本时，光标的移动方向。 |
## InputClient9+
-下列API均需使用[on('inputStart')](#oninputstart9)获取到InputClient实例后，通过实例调用。
+下列 API 均需使用[on('inputStart')](#oninputstart9)获取到 InputClient 实例后，通过实例调用。
### sendKeyFunction9+
sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void
-发送功能键。使用callback异步回调。
+发送功能键。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
- **参数：**
+**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| action | number | 是 | 功能键键值。
- 当值为0时，表示无效按键。
- 当值为1时，表示确认键（即回车键）。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ |
+| action | number | 是 | 功能键键值。
- 当值为 0 时，表示无效按键。
- 当值为 1 时，表示确认键（即回车键）。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功，err 为 undefined，data 为 true；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
- **示例：**
+**示例：**
```js
let action = 1;
@@ -1669,9 +1743,9 @@ try {
return;
}
if (result) {
- console.log('Succeeded in sending key function.');
+ console.log("Succeeded in sending key function.");
} else {
- console.error('Failed to sendKeyFunction.');
+ console.error("Failed to sendKeyFunction.");
}
});
} catch (err) {
@@ -1683,44 +1757,47 @@ try {
sendKeyFunction(action: number): Promise<boolean>
-发送功能键。使用promise异步回调。
+发送功能键。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| action | number | 是 | 功能键键值。
当值为0时，表示无效按键；
当值为1时，表示确认键（即回车键）。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | -------------------------------------------------------------------------------------- |
+| action | number | 是 | 功能键键值。
当值为 0 时，表示无效按键；
当值为 1 时，表示确认键（即回车键）。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise对象。返回true表示功能键发送成功；返回false表示功能键发送失败。|
+| 类型 | 说明 |
+| ---------------------- | --------------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示功能键发送成功；返回 false 表示功能键发送失败。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
```js
let action = 1;
try {
- inputClient.sendKeyFunction(action).then((result) => {
- if (result) {
- console.log('Succeeded in sending key function.');
- } else {
- console.error('Failed to sendKeyFunction.');
- }
- }).catch((err) => {
- console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .sendKeyFunction(action)
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in sending key function.");
+ } else {
+ console.error("Failed to sendKeyFunction.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
}
@@ -1730,25 +1807,25 @@ try {
getForward(length:number, callback: AsyncCallback<string>): void
-获取光标前固定长度的文本。使用callback异步回调。
+获取光标前固定长度的文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<string> | 是 | 回调函数。当光标前固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------------- | ---- | ------------------------------------------------------------------------------------------------- |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<string> | 是 | 回调函数。当光标前固定长度的文本获取成功，err 为 undefined，data 为获取到的文本；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
@@ -1760,7 +1837,7 @@ try {
console.error(`Failed to getForward: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in getting forward, text: ' + text);
+ console.log("Succeeded in getting forward, text: " + text);
});
} catch (err) {
console.error(`Failed to getForward: ${JSON.stringify(err)}`);
@@ -1771,41 +1848,44 @@ try {
getForward(length:number): Promise<string>
-获取光标前固定长度的文本。使用promise异步回调。
+获取光标前固定长度的文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| length | number | 是 | 文本长度。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<string> | Promise对象，返回光标前固定长度的文本。 |
+| 类型 | 说明 |
+| --------------------- | ---------------------------------------- |
+| Promise<string> | Promise 对象，返回光标前固定长度的文本。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
```js
let length = 1;
try {
- inputClient.getForward(length).then((text) => {
- console.log('Succeeded in getting forward, text: ' + text);
- }).catch((err) => {
- console.error(`Failed to getForward: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .getForward(length)
+ .then((text) => {
+ console.log("Succeeded in getting forward, text: " + text);
+ })
+ .catch((err) => {
+ console.error(`Failed to getForward: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to getForward: ${JSON.stringify(err)}`);
}
@@ -1815,25 +1895,25 @@ try {
getBackward(length:number, callback: AsyncCallback<string>): void
-获取光标后固定长度的文本。使用callback异步回调。
+获取光标后固定长度的文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<string> | 是 | 回调函数。当光标后固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------------- | ---- | ------------------------------------------------------------------------------------------------- |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<string> | 是 | 回调函数。当光标后固定长度的文本获取成功，err 为 undefined，data 为获取到的文本；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
@@ -1845,7 +1925,7 @@ try {
console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in getting backward, text: ' + text);
+ console.log("Succeeded in getting backward, text: " + text);
});
} catch (err) {
console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
@@ -1856,41 +1936,44 @@ try {
getBackward(length:number): Promise<string>
-获取光标后固定长度的文本。使用promise异步回调。
+获取光标后固定长度的文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| length | number | 是 | 文本长度。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<string> | Promise对象，返回光标后固定长度的文本。 |
+| 类型 | 说明 |
+| --------------------- | ---------------------------------------- |
+| Promise<string> | Promise 对象，返回光标后固定长度的文本。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
```js
let length = 1;
try {
- inputClient.getBackward(length).then((text) => {
- console.log('Succeeded in getting backward, text: ' + text);
- }).catch((err) => {
- console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .getBackward(length)
+ .then((text) => {
+ console.log("Succeeded in getting backward, text: " + text);
+ })
+ .catch((err) => {
+ console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
}
@@ -1900,25 +1983,25 @@ try {
deleteForward(length:number, callback: AsyncCallback<boolean>): void
-删除光标前固定长度的文本。使用callback异步回调。
+删除光标前固定长度的文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标前固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标前固定长度的文本删除成功，err 为 undefined，data 为 true；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800002 | Input method engine error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800002 | Input method engine error. |
+| 12800003 | input method client error. |
**示例：**
@@ -1931,7 +2014,7 @@ try {
return;
}
if (result) {
- console.log('Succeeded in deleting forward.');
+ console.log("Succeeded in deleting forward.");
} else {
console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
}
@@ -1945,7 +2028,7 @@ try {
deleteForward(length:number): Promise<boolean>
-删除光标前固定长度的文本。使用promise异步回调。
+删除光标前固定长度的文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
@@ -1955,35 +2038,38 @@ deleteForward(length:number): Promise<boolean>
| ------ | ------ | ---- | ---------- |
| length | number | 是 | 文本长度。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ---------------------- | -------------- |
-| Promise<boolean> | Promise对象。返回true表示删除光标前固定长度的文本成功；返回false表示删除光标前固定长度的文本失败。|
+| 类型 | 说明 |
+| ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示删除光标前固定长度的文本成功；返回 false 表示删除光标前固定长度的文本失败。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800002 | Input method engine error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800002 | Input method engine error. |
+| 12800003 | input method client error. |
**示例：**
```js
let length = 1;
try {
- inputClient.deleteForward(length).then((result) => {
- if (result) {
- console.log('Succeeded in deleting forward.');
- } else {
- console.error('Failed to delete Forward.');
- }
- }).catch((err) => {
- console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .deleteForward(length)
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in deleting forward.");
+ } else {
+ console.error("Failed to delete Forward.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
}
@@ -1993,25 +2079,25 @@ try {
deleteBackward(length:number, callback: AsyncCallback<boolean>): void
-删除光标后固定长度的文本。使用callback异步回调。
+删除光标后固定长度的文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------------- | ---- | -------------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标后固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标后固定长度的文本删除成功，err 为 undefined，data 为 true；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800002 | Input method engine error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800002 | Input method engine error. |
+| 12800003 | input method client error. |
**示例：**
@@ -2024,13 +2110,13 @@ try {
return;
}
if (result) {
- console.log('Succeeded in deleting backward.');
+ console.log("Succeeded in deleting backward.");
} else {
console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
}
});
} catch (err) {
- console.error('deleteBackward err: ' + JSON.stringify(err));
+ console.error("deleteBackward err: " + JSON.stringify(err));
}
```
@@ -2038,82 +2124,85 @@ try {
deleteBackward(length:number): Promise<boolean>
-删除光标后固定长度的文本。使用promise异步回调。
+删除光标后固定长度的文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| length | number | 是 | 文本长度。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise对象。返回true表示删除光标后固定长度的文本成功；返回false表示删除光标后固定长度的文本失败。 |
+| 类型 | 说明 |
+| ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示删除光标后固定长度的文本成功；返回 false 表示删除光标后固定长度的文本失败。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800002 | Input method engine error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800002 | Input method engine error. |
+| 12800003 | input method client error. |
**示例：**
```js
let length = 1;
-inputClient.deleteBackward(length).then((result) => {
- if (result) {
- console.log('Succeeded in deleting backward.');
- } else {
- console.error('Failed to deleteBackward.');
- }
-}).catch((err) => {
- console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
-});
+inputClient
+ .deleteBackward(length)
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in deleting backward.");
+ } else {
+ console.error("Failed to deleteBackward.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
+ });
```
### insertText9+
insertText(text:string, callback: AsyncCallback<boolean>): void
-插入文本。使用callback异步回调。
+插入文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| text | string | 是 | 文本内容。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | -------------------------------------------------------------------------- |
+| text | string | 是 | 文本内容。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功，err 为 undefined，data 为 true；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800002 | Input method engine error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800002 | Input method engine error. |
+| 12800003 | input method client error. |
**示例：**
```js
-inputClient.insertText('test', (err, result) => {
+inputClient.insertText("test", (err, result) => {
if (err) {
console.error(`Failed to insertText: ${JSON.stringify(err)}`);
return;
}
if (result) {
- console.log('Succeeded in inserting text.');
+ console.log("Succeeded in inserting text.");
} else {
- console.error('Failed to insertText.');
+ console.error("Failed to insertText.");
}
});
```
@@ -2122,44 +2211,47 @@ inputClient.insertText('test', (err, result) => {
insertText(text:string): Promise<boolean>
-插入文本。使用promise异步回调。
+插入文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| text | string | 是 | 文本。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ------ |
+| text | string | 是 | 文本。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise对象。返回true表示插入文本成功；返回false表示插入文本失败。 |
+| 类型 | 说明 |
+| ---------------------- | ----------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示插入文本成功；返回 false 表示插入文本失败。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800002 | Input method engine error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800002 | Input method engine error. |
+| 12800003 | input method client error. |
**示例：**
```js
try {
- inputClient.insertText('test').then((result) => {
- if (result) {
- console.log('Succeeded in inserting text.');
- } else {
- console.error('Failed to insertText.');
- }
- }).catch((err) => {
- console.error(`Failed to insertText: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .insertText("test")
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in inserting text.");
+ } else {
+ console.error("Failed to insertText.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to insertText: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to insertText: ${JSON.stringify(err)}`);
}
@@ -2169,23 +2261,23 @@ try {
getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
-获取编辑框属性值。使用callback异步回调。
+获取编辑框属性值。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| callback | AsyncCallback<[EditorAttribute](#editorattribute)> | 是 | 回调函数。当编辑框属性值获取成功，err为undefined，data为编辑框属性值；否则为错误对象。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------------------------------------------- | ---- | ----------------------------------------------------------------------------------------- |
+| callback | AsyncCallback<[EditorAttribute](#editorattribute)> | 是 | 回调函数。当编辑框属性值获取成功，err 为 undefined，data 为编辑框属性值；否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
@@ -2195,8 +2287,14 @@ inputClient.getEditorAttribute((err, editorAttribute) => {
console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
return;
}
- console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
- console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
+ console.log(
+ "editorAttribute.inputPattern: " +
+ JSON.stringify(editorAttribute.inputPattern)
+ );
+ console.log(
+ "editorAttribute.enterKeyType: " +
+ JSON.stringify(editorAttribute.enterKeyType)
+ );
});
```
@@ -2204,57 +2302,66 @@ inputClient.getEditorAttribute((err, editorAttribute) => {
getEditorAttribute(): Promise<EditorAttribute>
-获取编辑框属性值。使用promise异步回调。
+获取编辑框属性值。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<[EditorAttribute](#editorattribute)> | Promise对象，返回编辑框属性值。 |
+| 类型 | 说明 |
+| -------------------------------------------------- | -------------------------------- |
+| Promise<[EditorAttribute](#editorattribute)> | Promise 对象，返回编辑框属性值。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
```js
-inputClient.getEditorAttribute().then((editorAttribute) => {
- console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
- console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
-}).catch((err) => {
- console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
-});
+inputClient
+ .getEditorAttribute()
+ .then((editorAttribute) => {
+ console.log(
+ "editorAttribute.inputPattern: " +
+ JSON.stringify(editorAttribute.inputPattern)
+ );
+ console.log(
+ "editorAttribute.enterKeyType: " +
+ JSON.stringify(editorAttribute.enterKeyType)
+ );
+ })
+ .catch((err) => {
+ console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
+ });
```
### moveCursor9+
moveCursor(direction: number, callback: AsyncCallback<void>): void
-移动光标。使用callback异步回调。
+移动光标。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| --------- | ------------------------- | ---- | -------------- |
-| direction | number | 是 | 光标移动方向。 |
-| callback | AsyncCallback<void> | 是 | 回调函数。当光标移动成功，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
+| direction | number | 是 | 光标移动方向。 |
+| callback | AsyncCallback<void> | 是 | 回调函数。当光标移动成功，err 为 undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
@@ -2265,7 +2372,7 @@ try {
console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in moving cursor.');
+ console.log("Succeeded in moving cursor.");
});
} catch (err) {
console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
@@ -2276,7 +2383,7 @@ try {
moveCursor(direction: number): Promise<void>
-移动光标。使用promise异步回调。
+移动光标。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
@@ -2286,29 +2393,32 @@ moveCursor(direction: number): Promise<void>
| --------- | ------ | ---- | -------------- |
| direction | number | 是 | 光标移动方向。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ------------------- | ------------------------- |
-| Promise<void> | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| ------------------- | --------------------------- |
+| Promise<void> | 无返回结果的 Promise 对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 12800003 | input method client error. |
**示例：**
```js
try {
- inputClient.moveCursor(inputMethodEngine.CURSOR_UP).then(() => {
- console.log('Succeeded in moving cursor.');
- }).catch((err) => {
- console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .moveCursor(inputMethodEngine.CURSOR_UP)
+ .then(() => {
+ console.log("Succeeded in moving cursor.");
+ })
+ .catch((err) => {
+ console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
}
@@ -2318,36 +2428,36 @@ try {
selectByRange(range: Range, callback: AsyncCallback<void>): void
-根据索引范围选中文本。使用callback异步回调。
+根据索引范围选中文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
-| range | [Range](#range10) | 是 | 选中文本的范围。 |
-| callback | AsyncCallback<void> | 是 | 回调函数。当成功发送选中事件后，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------- | ---- | ------------------------------------------------------------------ |
+| range | [Range](#range10) | 是 | 选中文本的范围。 |
+| callback | AsyncCallback<void> | 是 | 回调函数。当成功发送选中事件后，err 为 undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 401 | parameter error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 401 | parameter error. |
+| 12800003 | input method client error. |
**示例：**
```js
try {
- inputClient.selectByRange({start: 0, end: 1}, (err) => {
+ inputClient.selectByRange({ start: 0, end: 1 }, (err) => {
if (err) {
console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in selecting by range.');
+ console.log("Succeeded in selecting by range.");
});
} catch (err) {
console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
@@ -2358,40 +2468,43 @@ try {
selectByRange(range: Range): Promise<void>
-根据索引范围选中文本。使用promise异步回调。
+根据索引范围选中文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------ | --------------------------------------------------------- | ---- | ---------------- |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ----------------- | ---- | ---------------- |
| range | [Range](#range10) | 是 | 选中文本的范围。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------- | ------------------------- |
-| Promise<void> | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| ------------------- | --------------------------- |
+| Promise<void> | 无返回结果的 Promise 对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 401 | parameter error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 401 | parameter error. |
+| 12800003 | input method client error. |
**示例：**
```js
try {
- inputClient.selectByRange({start: 0, end:1}).then(() => {
- console.log('Succeeded in selecting by range.');
- }).catch((err) => {
- console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .selectByRange({ start: 0, end: 1 })
+ .then(() => {
+ console.log("Succeeded in selecting by range.");
+ })
+ .catch((err) => {
+ console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
}
@@ -2401,36 +2514,36 @@ try {
selectByMovement(movement: Movement, callback: AsyncCallback<void>): void
-根据光标移动方向选中文本。使用callback异步回调。
+根据光标移动方向选中文本。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------ | ---- | ------ |
-| movement | [Movement](#movement10) | 是 | 选中时光标移动的方向。 |
-| callback | AsyncCallback<void> | 是 | 回调函数。当成功发送选中事件后，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------- | ---- | ------------------------------------------------------------------ |
+| movement | [Movement](#movement10) | 是 | 选中时光标移动的方向。 |
+| callback | AsyncCallback<void> | 是 | 回调函数。当成功发送选中事件后，err 为 undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 401 | parameter error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 401 | parameter error. |
+| 12800003 | input method client error. |
**示例：**
```js
try {
- inputClient.selectByMovement({direction: 1}, (err) => {
+ inputClient.selectByMovement({ direction: 1 }, (err) => {
if (err) {
console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in selecting by movement.');
+ console.log("Succeeded in selecting by movement.");
});
} catch (err) {
console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
@@ -2441,40 +2554,43 @@ try {
selectByMovement(movement: Movement): Promise<void>
-根据索引范围选中文本。使用promise异步回调。
+根据索引范围选中文本。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------------------------------------------------------------ | ---- | ---------------------- |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------- | ---- | ---------------------- |
| movement | [Movement](#movement10) | 是 | 选中时光标移动的方向。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------- | ------------------------- |
-| Promise<void> | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| ------------------- | --------------------------- |
+| Promise<void> | 无返回结果的 Promise 对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | -------------------------- |
-| 401 | parameter error. |
-| 12800003 | input method client error. |
+| 错误码 ID | 错误信息 |
+| --------- | -------------------------- |
+| 401 | parameter error. |
+| 12800003 | input method client error. |
**示例：**
```js
try {
- inputClient.selectByMovement({direction: 1}).then(() => {
- console.log('Succeeded in selecting by movement.');
- }).catch((err) => {
- console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
- });
+ inputClient
+ .selectByMovement({ direction: 1 })
+ .then(() => {
+ console.log("Succeeded in selecting by movement.");
+ })
+ .catch((err) => {
+ console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
+ });
} catch (err) {
console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}
@@ -2484,24 +2600,24 @@ try {
getTextIndexAtCursor(callback: AsyncCallback<number>): void
-获取光标所在处的文本索引。使用callback异步回调。
+获取光标所在处的文本索引。使用 callback 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
-| callback | AsyncCallback<number> | 是 | 回调函数。当文本索引获取成功，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------------- | ---- | ---------------------------------------------------------------- |
+| callback | AsyncCallback<number> | 是 | 回调函数。当文本索引获取成功，err 为 undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
@@ -2511,7 +2627,7 @@ inputClient.getTextIndexAtCursor((err, index) => {
console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in getTextIndexAtCursor: ' + index);
+ console.log("Succeeded in getTextIndexAtCursor: " + index);
});
```
@@ -2519,40 +2635,43 @@ inputClient.getTextIndexAtCursor((err, index) => {
getTextIndexAtCursor(): Promise<number>
-获取光标所在处的文本索引。使用promise异步回调。
+获取光标所在处的文本索引。使用 promise 异步回调。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| --------------------- | --------------------------------------- |
-| Promise<number> | Promise对象，返回光标所在处的文本索引。 |
+| 类型 | 说明 |
+| --------------------- | ---------------------------------------- |
+| Promise<number> | Promise 对象，返回光标所在处的文本索引。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
```js
-inputClient.getTextIndexAtCursor().then((index) => {
- console.log('Succeeded in getTextIndexAtCursor: ' + index);
-}).catch((err) => {
- console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
-});
+inputClient
+ .getTextIndexAtCursor()
+ .then((index) => {
+ console.log("Succeeded in getTextIndexAtCursor: " + index);
+ })
+ .catch((err) => {
+ console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
+ });
```
### sendExtendAction10+
sendExtendAction(action: ExtendAction, callback: AsyncCallback<void>): void
-发送扩展编辑操作。使用callback异步回调。
+发送扩展编辑操作。使用 callback 异步回调。
> **说明**
>
@@ -2562,19 +2681,19 @@ sendExtendAction(action: ExtendAction, callback: AsyncCallback<void>): voi
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
-| action | [ExtendAction](#extendaction10) | 是 | 要发送的扩展操作。 |
-| callback | AsyncCallback<void> | 是 | 回调函数。发送成功，err为undefined，否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------- | ---- | ------------------------------------------------------ |
+| action | [ExtendAction](#extendaction10) | 是 | 要发送的扩展操作。 |
+| callback | AsyncCallback<void> | 是 | 回调函数。发送成功，err 为 undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
@@ -2585,9 +2704,9 @@ try {
console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in sending extend action.');
+ console.log("Succeeded in sending extend action.");
});
-} catch(err) {
+} catch (err) {
console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
}
```
@@ -2596,9 +2715,9 @@ try {
sendExtendAction(action: ExtendAction): Promise<void>
-发送扩展编辑操作。使用promise异步回调。
+发送扩展编辑操作。使用 promise 异步回调。
->**说明**
+> **说明**
>
> 输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件[on('handleExtendAction')](./js-apis-inputmethod.md#onhandleextendaction10)，从而进一步做出处理。
@@ -2606,35 +2725,38 @@ sendExtendAction(action: ExtendAction): Promise<void>
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| action | [ExtendAction](#extendaction10) | 是 | 要发送的扩展操作。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------------------------------- | ---- | ------------------ |
+| action | [ExtendAction](#extendaction10) | 是 | 要发送的扩展操作。 |
**返回值：**
-| 类型 | 说明 |
-| --------------------- | --------------------------------------- |
-| Promise<void> | 无返回结果的Promise对象。 |
+| 类型 | 说明 |
+| ------------------- | --------------------------- |
+| Promise<void> | 无返回结果的 Promise 对象。 |
**错误码：**
以下错误码的详细介绍请参见[输入法框架错误码](../errorcodes/errorcode-inputmethod-framework.md)。
-| 错误码ID | 错误信息 |
-| -------- | ------------------------------ |
-| 12800003 | input method client error. |
-| 12800006 | Input method controller error. |
+| 错误码 ID | 错误信息 |
+| --------- | ------------------------------ |
+| 12800003 | input method client error. |
+| 12800006 | Input method controller error. |
**示例：**
```js
try {
- inputClient.sendExtendAction(inputMethodEngine.ExtendAction.COPY).then(() => {
- console.log('Succeeded in sending extend action.');
- }).catch((err) => {
- console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
- });
-} catch(err) {
+ inputClient
+ .sendExtendAction(inputMethodEngine.ExtendAction.COPY)
+ .then(() => {
+ console.log("Succeeded in sending extend action.");
+ })
+ .catch((err) => {
+ console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
+ });
+} catch (err) {
console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
}
```
@@ -2645,10 +2767,10 @@ try {
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| ------------ | -------- | ---- | ---- | ------------------ |
-| enterKeyType | number | 是 | 否 | 编辑框的功能属性。 |
-| inputPattern | number | 是 | 否 | 编辑框的文本属性。 |
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| ------------ | ------ | ---- | ---- | ------------------ |
+| enterKeyType | number | 是 | 否 | 编辑框的功能属性。 |
+| inputPattern | number | 是 | 否 | 编辑框的文本属性。 |
## KeyEvent
@@ -2656,10 +2778,10 @@ try {
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| --------- | -------- | ---- | ---- | ------------ |
-| keyCode | number | 是 | 否 | 按键的键值。键码值说明参考[KeyCode](js-apis-keycode.md#keycode)。 |
-| keyAction | number | 是 | 否 | 按键事件类型。
- 当值为2时，表示按下事件；
- 当值为3时，表示抬起事件。 |
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| --------- | ------ | ---- | ---- | ---------------------------------------------------------------------------------- |
+| keyCode | number | 是 | 否 | 按键的键值。键码值说明参考[KeyCode](js-apis-keycode.md#keycode)。 |
+| keyAction | number | 是 | 否 | 按键事件类型。
- 当值为 2 时，表示按下事件；
- 当值为 3 时，表示抬起事件。 |
## PanelFlag10+
@@ -2667,10 +2789,10 @@ try {
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 值 | 说明 |
-| ------------ | -- | ------------------ |
-| FLG_FIXED | 0 | 固定态面板类型。 |
-| FLG_FLOATING | 1 | 悬浮态面板类型。 |
+| 名称 | 值 | 说明 |
+| ------------ | --- | ---------------- |
+| FLG_FIXED | 0 | 固定态面板类型。 |
+| FLG_FLOATING | 1 | 悬浮态面板类型。 |
## PanelType10+
@@ -2678,10 +2800,10 @@ try {
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
-| 名称 | 值 | 说明 |
-| ------------ | -- | ------------------ |
-| SOFT_KEYBOARD | 0 | 软键盘类型。 |
-| STATUS_BAR | 1 | 状态栏类型。 |
+| 名称 | 值 | 说明 |
+| ------------- | --- | ------------ |
+| SOFT_KEYBOARD | 0 | 软键盘类型。 |
+| STATUS_BAR | 1 | 状态栏类型。 |
## PanelInfo10+
@@ -2689,37 +2811,37 @@ try {
输入法面板属性。
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| --------- | -------- | ---- | ---- | ------------ |
-| type | number | 是 | 是 | 面板的类型。 |
-| flag | number | 是 | 是 | 面板的状态类型。 |
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| ---- | ------ | ---- | ---- | ---------------- |
+| type | number | 是 | 是 | 面板的类型。 |
+| flag | number | 是 | 是 | 面板的状态类型。 |
## TextInputClient(deprecated)
-> **说明：**
+> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[InputClient](#inputclient9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[InputClient](#inputclient9)替代。
-下列API示例中都需使用[on('inputStart')](#oninputstart)回调获取到TextInputClient实例，再通过此实例调用对应方法。
+下列 API 示例中都需使用[on('inputStart')](#oninputstart)回调获取到 TextInputClient 实例，再通过此实例调用对应方法。
### getForward(deprecated)
getForward(length:number, callback: AsyncCallback<string>): void
-获取光标前固定长度的文本。使用callback异步回调。
+获取光标前固定长度的文本。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getForward](#getforward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getForward](#getforward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<string> | 是 | 回调函数。当光标前固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------------- | ---- | ------------------------------------------------------------------------------------------------- |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<string> | 是 | 回调函数。当光标前固定长度的文本获取成功，err 为 undefined，data 为获取到的文本；否则为错误对象。 |
**示例：**
@@ -2730,7 +2852,7 @@ textInputClient.getForward(length, (err, text) => {
console.error(`Failed to getForward: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in getting forward, text: ' + text);
+ console.log("Succeeded in getting forward, text: " + text);
});
```
@@ -2738,55 +2860,58 @@ textInputClient.getForward(length, (err, text) => {
getForward(length:number): Promise<string>
-获取光标前固定长度的文本。使用promise异步回调。
+获取光标前固定长度的文本。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getForward](#getforward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getForward](#getforward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| length | number | 是 | 文本长度。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<string> | Promise对象，返回光标前固定长度的文本。 |
+| 类型 | 说明 |
+| --------------------- | ---------------------------------------- |
+| Promise<string> | Promise 对象，返回光标前固定长度的文本。 |
**示例：**
```js
let length = 1;
-textInputClient.getForward(length).then((text) => {
- console.log('Succeeded in getting forward, text: ' + text);
-}).catch((err) => {
- console.error(`Failed to getForward: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .getForward(length)
+ .then((text) => {
+ console.log("Succeeded in getting forward, text: " + text);
+ })
+ .catch((err) => {
+ console.error(`Failed to getForward: ${JSON.stringify(err)}`);
+ });
```
### getBackward(deprecated)
getBackward(length:number, callback: AsyncCallback<string>): void
-获取光标后固定长度的文本。使用callback异步回调。
+获取光标后固定长度的文本。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getBackward](#getbackward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getBackward](#getbackward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<string> | 是 | 回调函数。当光标后固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------------- | ---- | ------------------------------------------------------------------------------------------------- |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<string> | 是 | 回调函数。当光标后固定长度的文本获取成功，err 为 undefined，data 为获取到的文本；否则为错误对象。 |
**示例：**
@@ -2797,7 +2922,7 @@ textInputClient.getBackward(length, (err, text) => {
console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
return;
}
- console.log('Succeeded in getting borward, text: ' + text);
+ console.log("Succeeded in getting borward, text: " + text);
});
```
@@ -2805,55 +2930,58 @@ textInputClient.getBackward(length, (err, text) => {
getBackward(length:number): Promise<string>
-获取光标后固定长度的文本。使用promise异步回调。
+获取光标后固定长度的文本。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getBackward](#getbackward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getBackward](#getbackward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| length | number | 是 | 文本长度。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<string> | Promise对象，返回光标后固定长度的文本。 |
+| 类型 | 说明 |
+| --------------------- | ---------------------------------------- |
+| Promise<string> | Promise 对象，返回光标后固定长度的文本。 |
**示例：**
```js
let length = 1;
-textInputClient.getBackward(length).then((text) => {
- console.log('Succeeded in getting backward: ' + JSON.stringify(text));
-}).catch((err) => {
- console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .getBackward(length)
+ .then((text) => {
+ console.log("Succeeded in getting backward: " + JSON.stringify(text));
+ })
+ .catch((err) => {
+ console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
+ });
```
### deleteForward(deprecated)
deleteForward(length:number, callback: AsyncCallback<boolean>): void
-删除光标前固定长度的文本。使用callback异步回调。
+删除光标前固定长度的文本。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[deleteForward](#deleteforward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[deleteForward](#deleteforward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标前固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标前固定长度的文本删除成功，err 为 undefined，data 为 true；否则为错误对象。 |
**示例：**
@@ -2865,9 +2993,9 @@ textInputClient.deleteForward(length, (err, result) => {
return;
}
if (result) {
- console.log('Succeeded in deleting forward.');
+ console.log("Succeeded in deleting forward.");
} else {
- console.error('Failed to deleteForward.');
+ console.error("Failed to deleteForward.");
}
});
```
@@ -2876,11 +3004,11 @@ textInputClient.deleteForward(length, (err, result) => {
deleteForward(length:number): Promise<boolean>
-删除光标前固定长度的文本。使用promise异步回调。
+删除光标前固定长度的文本。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[deleteForward](#deleteforward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[deleteForward](#deleteforward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
@@ -2890,45 +3018,48 @@ deleteForward(length:number): Promise<boolean>
| ------ | ------ | ---- | ---------- |
| length | number | 是 | 文本长度。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ---------------------- | -------------- |
-| Promise<boolean> | Promise对象。返回true表示删除光标前固定长度的文本成功；返回false表示删除光标前固定长度的文本失败。|
+| 类型 | 说明 |
+| ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示删除光标前固定长度的文本成功；返回 false 表示删除光标前固定长度的文本失败。 |
**示例：**
```js
let length = 1;
-textInputClient.deleteForward(length).then((result) => {
- if (result) {
- console.log('Succeeded in deleting forward.');
- } else {
- console.error('Failed to delete forward.');
- }
-}).catch((err) => {
- console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .deleteForward(length)
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in deleting forward.");
+ } else {
+ console.error("Failed to delete forward.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
+ });
```
### deleteBackward(deprecated)
deleteBackward(length:number, callback: AsyncCallback<boolean>): void
-删除光标后固定长度的文本。使用callback异步回调。
+删除光标后固定长度的文本。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[deleteBackward](#deletebackward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[deleteBackward](#deletebackward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ---------------------------- | ---- | -------------- |
-| length | number | 是 | 文本长度。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标后固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ |
+| length | number | 是 | 文本长度。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当光标后固定长度的文本删除成功，err 为 undefined，data 为 true；否则为错误对象。 |
**示例：**
@@ -2940,9 +3071,9 @@ textInputClient.deleteBackward(length, (err, result) => {
return;
}
if (result) {
- console.log('Succeeded in deleting backward.');
+ console.log("Succeeded in deleting backward.");
} else {
- console.error('Failed to deleteBackward.');
+ console.error("Failed to deleteBackward.");
}
});
```
@@ -2951,58 +3082,62 @@ textInputClient.deleteBackward(length, (err, result) => {
deleteBackward(length:number): Promise<boolean>
-删除光标后固定长度的文本。使用promise异步回调。
+删除光标后固定长度的文本。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[deleteBackward](#deletebackward9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[deleteBackward](#deletebackward9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| length | number | 是 | 文本长度。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ---------- |
+| length | number | 是 | 文本长度。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise对象。返回true表示删除光标后固定长度的文本成功；返回false表示删除光标后固定长度的文本失败。|
+| 类型 | 说明 |
+| ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示删除光标后固定长度的文本成功；返回 false 表示删除光标后固定长度的文本失败。 |
**示例：**
```js
let length = 1;
-textInputClient.deleteBackward(length).then((result) => {
- if (result) {
- console.log('Succeeded in deleting backward.');
- } else {
- console.error('Failed to deleteBackward.');
- }
-}).catch((err) => {
- console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .deleteBackward(length)
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in deleting backward.");
+ } else {
+ console.error("Failed to deleteBackward.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
+ });
```
+
### sendKeyFunction(deprecated)
sendKeyFunction(action: number, callback: AsyncCallback<boolean>): void
-发送功能键。使用callback异步回调。
+发送功能键。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[sendKeyFunction](#sendkeyfunction9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[sendKeyFunction](#sendkeyfunction9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| action | number | 是 | 功能键键值。
- 当值为0时，表示无效按键；
- 当值为1时，表示确认键（即回车键）。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ |
+| action | number | 是 | 功能键键值。
- 当值为 0 时，表示无效按键；
- 当值为 1 时，表示确认键（即回车键）。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功，err 为 undefined，data 为 true；否则为错误对象。 |
**示例：**
@@ -3014,9 +3149,9 @@ textInputClient.sendKeyFunction(action, (err, result) => {
return;
}
if (result) {
- console.log('Succeeded in sending key function.');
+ console.log("Succeeded in sending key function.");
} else {
- console.error('Failed to sendKeyFunction.');
+ console.error("Failed to sendKeyFunction.");
}
});
```
@@ -3025,72 +3160,75 @@ textInputClient.sendKeyFunction(action, (err, result) => {
sendKeyFunction(action: number): Promise<boolean>
-发送功能键。使用promise异步回调。
+发送功能键。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[sendKeyFunction](#sendkeyfunction9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[sendKeyFunction](#sendkeyfunction9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| action | number | 是 | 功能键键值。
当值为0时，表示无效按键；
当值为1时，表示确认键（即回车键）。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | -------------------------------------------------------------------------------------- |
+| action | number | 是 | 功能键键值。
当值为 0 时，表示无效按键；
当值为 1 时，表示确认键（即回车键）。 |
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise对象。返回true表示发送功能键成功；返回false表示发送功能键失败。 |
+| 类型 | 说明 |
+| ---------------------- | --------------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示发送功能键成功；返回 false 表示发送功能键失败。 |
**示例：**
```js
let action = 1;
-textInputClient.sendKeyFunction(action).then((result) => {
- if (result) {
- console.log('Succeeded in sending key function.');
- } else {
- console.error('Failed to sendKeyFunction.');
- }
-}).catch((err) => {
- console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .sendKeyFunction(action)
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in sending key function.");
+ } else {
+ console.error("Failed to sendKeyFunction.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
+ });
```
### insertText(deprecated)
insertText(text:string, callback: AsyncCallback<boolean>): void
-插入文本。使用callback异步回调。
+插入文本。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[insertText](#inserttext9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[insertText](#inserttext9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| text | string | 是 | 文本。 |
-| callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功，err为undefined，data为true；否则为错误对象。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ---------------------------- | ---- | -------------------------------------------------------------------------- |
+| text | string | 是 | 文本。 |
+| callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功，err 为 undefined，data 为 true；否则为错误对象。 |
**示例：**
```js
-textInputClient.insertText('test', (err, result) => {
+textInputClient.insertText("test", (err, result) => {
if (err) {
console.error(`Failed to insertText: ${JSON.stringify(err)}`);
return;
}
if (result) {
- console.log('Succeeded in inserting text.');
+ console.log("Succeeded in inserting text.");
} else {
- console.error('Failed to insertText.');
+ console.error("Failed to insertText.");
}
});
```
@@ -3099,57 +3237,60 @@ textInputClient.insertText('test', (err, result) => {
insertText(text:string): Promise<boolean>
-插入文本。使用promise异步回调。
+插入文本。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[insertText](#inserttext9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[insertText](#inserttext9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| text | string | 是 | 文本。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ------ |
+| text | string | 是 | 文本。 |
-**返回值：**
+**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise对象。返回true表示插入文本成功；返回false表示插入文本失败。 |
+| 类型 | 说明 |
+| ---------------------- | ----------------------------------------------------------------------- |
+| Promise<boolean> | Promise 对象。返回 true 表示插入文本成功；返回 false 表示插入文本失败。 |
**示例：**
```js
-textInputClient.insertText('test').then((result) => {
- if (result) {
- console.log('Succeeded in inserting text.');
- } else {
- console.error('Failed to insertText.');
- }
-}).catch((err) => {
- console.error(`Failed to insertText: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .insertText("test")
+ .then((result) => {
+ if (result) {
+ console.log("Succeeded in inserting text.");
+ } else {
+ console.error("Failed to insertText.");
+ }
+ })
+ .catch((err) => {
+ console.error(`Failed to insertText: ${JSON.stringify(err)}`);
+ });
```
### getEditorAttribute(deprecated)
getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
-获取编辑框属性值。使用callback异步回调。
+获取编辑框属性值。使用 callback 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getEditorAttribute](#geteditorattribute9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getEditorAttribute](#geteditorattribute9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ----- | ----- | ----- |
-| callback | AsyncCallback<[EditorAttribute](#editorattribute)> | 是 | 回调函数。当编辑框的属性值获取成功，err为undefined，data为编辑框属性值；否则为错误对象。|
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------------- |
+| callback | AsyncCallback<[EditorAttribute](#editorattribute)> | 是 | 回调函数。当编辑框的属性值获取成功，err 为 undefined，data 为编辑框属性值；否则为错误对象。 |
**示例：**
@@ -3159,8 +3300,14 @@ textInputClient.getEditorAttribute((err, editorAttribute) => {
console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
return;
}
- console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
- console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
+ console.log(
+ "editorAttribute.inputPattern: " +
+ JSON.stringify(editorAttribute.inputPattern)
+ );
+ console.log(
+ "editorAttribute.enterKeyType: " +
+ JSON.stringify(editorAttribute.enterKeyType)
+ );
});
```
@@ -3168,28 +3315,38 @@ textInputClient.getEditorAttribute((err, editorAttribute) => {
getEditorAttribute(): Promise<EditorAttribute>
-获取编辑框属性值。使用promise异步回调。
+获取编辑框属性值。使用 promise 异步回调。
> **说明：**
>
-> 从API version 8开始支持，API version 9开始废弃，建议使用[getEditorAttribute](#geteditorattribute9)替代。
+> 从 API version 8 开始支持，API version 9 开始废弃，建议使用[getEditorAttribute](#geteditorattribute9)替代。
**系统能力：** SystemCapability.MiscServices.InputMethodFramework
**返回值：**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<[EditorAttribute](#editorattribute)> | Promise对象，返回编辑框属性值。 |
+| 类型 | 说明 |
+| -------------------------------------------------- | -------------------------------- |
+| Promise<[EditorAttribute](#editorattribute)> | Promise 对象，返回编辑框属性值。 |
**示例：**
```js
-textInputClient.getEditorAttribute().then((editorAttribute) => {
- console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
- console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
-}).catch((err) => {
- console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
-});
+textInputClient
+ .getEditorAttribute()
+ .then((editorAttribute) => {
+ console.log(
+ "editorAttribute.inputPattern: " +
+ JSON.stringify(editorAttribute.inputPattern)
+ );
+ console.log(
+ "editorAttribute.enterKeyType: " +
+ JSON.stringify(editorAttribute.enterKeyType)
+ );
+ })
+ .catch((err) => {
+ console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
+ });
```
-
\ No newline at end of file
+
+