diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md index 4c669662fa819d59ae2409f3c67fa001cfbdcb4d..807e492b61140edaf9d96fc514154e0fb375e069 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md @@ -9,6 +9,12 @@ InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 +## 导入模块 + +``` +import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext'; +``` + ## 使用说明 在使用InputMethodExtensionContext的功能前，需要通过InputMethodExtensionAbility子类实例获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index 05dd6c8f33fe42e5f1a7299e788b07e716f76aa6..fd21f25719ccc7509842bed7b6da19fee55c76c2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -77,12 +77,11 @@ getInputMethodSetting(): InputMethodSetting ``` ## inputMethod.switchInputMethod9+ -switchInputMethod(target: InputmethodProperty, callback: AsyncCallback<boolean>): void; +switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolean>): void 切换输入法。此接口仅可在Stage模型下使用。使用callback形式返回结果。参数个数为2，否则抛出异常。 - -**系统能力**：SystemCapability.Miscservices.InputMethodFramework +**系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -108,11 +107,11 @@ inputmethod.switchInputMethod({packageName:"com.example.kikakeyboard", methodId: }); ``` ## inputMethod.switchInputMethod9+ -switchInputMethod(target: InputmethodProperty): Promise<boolean> +switchInputMethod(target: InputMethodProperty): Promise<boolean> 切换输入法。此接口仅可在Stage模型下使用。使用promise形式返回结果。参数个数为1，否则抛出异常。 -**系统能力**： SystemCapability.Miscservices.InputMethodFramework +**系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -340,7 +339,7 @@ InputMethodSetting.listInputMethod((err,data) => { ### listInputMethod -listInputMethod(): Promise>; +listInputMethod(): Promise<Array> 查询已安装的输入法列表。使用promise形式返回结果。参数个数为0，否则抛出异常。 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 afc27177990b973cf957eb2f7b840dfbac85da8f..4d413c3751adb1c9c975385cdd28308895175a2c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -45,6 +45,11 @@ import inputMethodEngine from '@ohos.inputmethodengine'; | FLAG_SINGLE_LINE | number | 是 | 否 | 编辑框为单行。 | | DISPLAY_MODE_PART | number | 是 | 否 | 编辑框显示为半屏。 | | DISPLAY_MODE_FULL | number | 是 | 否 | 编辑框显示为全屏。 | +| CURSOR_UP9+ | number | 是 | 否 | 光标上移。 | +| CURSOR_DOWN9+ | number | 是 | 否 | 光标下移。 | +| CURSOR_LEFT9+ | number | 是 | 否 | 光标左移。 | +| CURSOR_RIGHT9+ | number | 是 | 否 | 光标右移。 | +| WINDOW_TYPE_INPUT_METHOD_FLOAT9+ | number | 是 | 否 | 输入法应用窗口风格标识。 | ## inputMethodEngine.getInputMethodEngine @@ -139,6 +144,98 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC }); ``` +### on('inputStop')9+ + +on(type: 'inputStop', callback: () => void): void + +订阅停止输入法应用事件，使用callback回调。 + +**系统能力**： SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 设置监听类型。
-type为‘inputStop’时表示订阅停止输入法应用事件。 | +| callback | void | 是 | 回调函数。 | + +**示例：** + + ```js +InputMethodEngine.getInputMethodEngine().on('inputStop', () => { + console.log("inputMethodEngine inputStop"); +}); + ``` + +### off('inputStop')9+ + +off(type: 'inputStop', callback: () => void): void + +取消订阅停止输入法应用事件。使用callback回调。 + +**系统能力**： SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 设置监听类型。
-type为‘inputStop’时表示订阅停止输入法应用事件。 | +| callback | void | 是 | 回调函数。 | + +**示例：** + + ```js +InputMethodEngine.getInputMethodEngine().off('inputStop', () => { + console.log("inputMethodEngine delete inputStop notification."); +}); + ``` + +### on('setCallingWindow')9+ + +on(type: 'setCallingWindow', callback: (wid:number) => void): void + +订阅设置调用窗口事件，使用callback回调。 + +**系统能力**： SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 设置监听类型。
-type为‘setCallingWindow’时表示订阅设置调用窗口事件。 | +| callback | number | 是 | 调用方window id。 | + +**示例：** + + ```js +InputMethodEngine.getInputMethodEngine().on('setCallingWindow', (wid) => { + console.log("inputMethodEngine setCallingWindow"); +}); + ``` + +### off('setCallingWindow')9+ + +off(type: 'setCallingWindow', callback: (wid:number) => void): void + +取消订阅设置调用窗口事件。使用callback回调。 + +**系统能力**： SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 设置监听类型。
-type为‘setCallingWindow’时表示订阅设置调用窗口事件。 | +| callback | number | 是 | 调用方window id。 | + +**示例：** + + ```js +InputMethodEngine.getInputMethodEngine().off('setCallingWindow', () => { + console.log("inputMethodEngine delete setCallingWindow notification."); +}); + ``` + ### on('keyboardShow'|'keyboardHide') on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void @@ -883,7 +980,7 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void ### getEditorAttribute -getEditorAttribute(): Promise +getEditorAttribute(): Promise<EditorAttribute> 获取编辑框属性值。使用promise形式返回结果。参数个数为0，否则抛出异常。 @@ -908,6 +1005,64 @@ getEditorAttribute(): Promise } ``` +### moveCursor9+ + +moveCursor(direction: number, callback: AsyncCallback<void>): void + +移动光标。使用callback形式返回结果。参数个数为1，否则抛出异常。 + +**系统能力**： SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------- | ---- | -------------- | +| direction | number | 是 | 光标移动方向。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**示例：** + +```js +TextInputClient.moveCursor(inputMethodEngine.CURSOR_xxx, (err) => { + if (err == undefined) { + console.error("moveCursor callback result---err: " + err.msg); + return; + } +}); +``` + +### moveCursor9+ + +moveCursor(direction: number): Promise<void> + +移动光标。使用promise形式返回结果。参数个数为1，否则抛出异常。 + +**系统能力**： SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | -------------- | +| direction | number | 是 | 光标移动方向。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | ------------------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例：** + + ```js +async function InputMethodEngine() { + await TextInputClient.moveCursor(inputMethodEngine.CURSOR_xxx).then(async (err) => { + console.log('moveCursor success'); + }).catch((err) => { + console.error("moveCursor success err: " + err.msg); + }); +} + ``` + ## EditorAttribute 编辑框属性值。