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 1ba5395b85a1bdbff81c26c46696238820b1eee2..78a5da0dd4affebe61b9ffab674f0af34cd54912 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -596,9 +596,12 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); **系统能力：** SystemCapability.MiscServices.InputMethodFramework -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| inputAttribute10+ | [InputAttribute](#inputattribute10) | 是 | 是 | 编辑框属性。| +| inputAttribute10+ | [InputAttribute](#inputattribute10) | 否 | 是 | 编辑框属性。| +| cursorInfo10+ | [CursorInfo](#cursorinfo10) | 否 | 否 | 光标信息。| +| selection10+ | [Range](#range10) | 否 | 否 | 文本选区范围。| +| windowId10+ | number | 否 | 否 | 编辑控件所在的窗口Id。| ## CursorInfo10+ 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 ac2557b7bd539963b08a61510a1c4df62d70bf1b..1bff8a6c6862ba5f866812922b879879f43975bf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -789,7 +789,7 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) = | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ----- | -| type | string | 是 | 光标变化事件。
- type为’cursorContextChange‘时，表示订阅光标变化事件。 | +| type | string | 是 | 光标变化事件。
- type为‘cursorContextChange’时，表示订阅光标变化事件。 | | callback | (x: number, y: number, height: number) => void | 是 | 回调函数，返回光标信息。
- x为光标上端的的x坐标值。
- y为光标上端的y坐标值。
- height为光标的高度值。 | **示例：** @@ -814,7 +814,7 @@ off(type: 'cursorContextChange', callback?: (x: number, y: number, height: numbe | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ------ | -| type | string | 是 | 光标变化事件。
- type为’cursorContextChange‘时，表示光标变化。 | +| type | string | 是 | 光标变化事件。
- type为‘cursorContextChange’时，表示光标变化。 | | callback | (x: number, y:number, height:number) => void | 否 | 回调函数，返回光标信息。
- x为光标上端的的x坐标值。
- y为光标上端的y坐标值。
- height为光标的高度值。
| @@ -837,7 +837,7 @@ on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegi | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ---- | -| type | string | 是 | 文本选择变化事件。
- type为’selectionChange‘时，表示选择文本变化。 | +| type | string | 是 | 文本选择变化事件。
- type为‘selectionChange’时，表示选择文本变化。 | | callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 是 | 回调函数，返回文本选择信息。
- oldBegin为变化之前被选中文本的起始下标。
- oldEnd为变化之前被选中文本的终止下标。
- newBegin为变化之后被选中文本的起始下标。
- newEnd为变化之后被选中文本的终止下标。 | **示例：** @@ -863,7 +863,7 @@ off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBe | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ------- | -| type | string | 是 | 文本选择变化事件。
- type为’selectionChange‘时，表示选择文本变化。 | +| type | string | 是 | 文本选择变化事件。
- type为‘selectionChange’时，表示选择文本变化。 | | callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 否 | 回调函数，返回文本选择信息。
- oldBegin为变化之前被选中文本的起始下标。
- oldEnd为变化之前被选中文本的终止下标。
- newBegin为变化之后被选中文本的起始下标。
- newEnd为变化之后被选中文本的终止下标。
| **示例：** @@ -887,7 +887,7 @@ on(type: 'textChange', callback: (text: string) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 文本变化事件。
- type为’textChange‘时，表示订阅文本变化事件。 | +| type | string | 是 | 文本变化事件。
- type为‘textChange’时，表示订阅文本变化事件。 | | callback | (text: string) => void | 是 | 回调函数，返回订阅的文本内容。| **示例：** @@ -910,7 +910,7 @@ off(type: 'textChange', callback?: (text: string) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 文本变化事件。
- type为’textChange‘时，表示取消订阅文本变化事件。 | +| type | string | 是 | 文本变化事件。
- type为‘textChange’时，表示取消订阅文本变化事件。 | | callback | (text: string) => void | 否 | 回调函数，返回取消订阅的文本内容。 | **示例：** @@ -921,6 +921,50 @@ inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => { }); ``` +### on('editorAttributeChanged')10+ + +on(type: 'editorAttributeChanged', callback: (attr: EditorAttribute) => void): void + +订阅编辑框属性变化事件。使用callback异步回调。 + +**系统能力：** SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 文本变化事件。
- type为‘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}`); +}); +``` + +### off('editorAttributeChanged')10+ + +off(type: 'editorAttributeChanged', callback?: (attr: EditorAttribute) => void): void + +取消订阅编辑框属性变化事件。 + +**系统能力：** SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 文本变化事件。
- type为‘editorAttributeChanged’时，表示取消订阅编辑框属性变化事件。 | +| callback | (attr: EditorAttribute) => void | 否 | 所要取消订阅的回调处理函数，和on接口参数对应。 | + +**示例：** + +```js +inputMethodEngine.getKeyboardDelegate().off('editorAttributeChanged'); +``` + ## Panel10+ 下列API示例中都需使用[createPanel](#createpanel10)回调获取到Panel实例，再通过此实例调用对应方法。