Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
2b737903
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
2b737903
编写于
7月 09, 2023
作者:
C
cy7717
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
新增文本信息获取回调接口
Signed-off-by:
N
cy7717
<
chenyu301@huawei.com
>
上级
08c013a3
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
174 addition
and
0 deletion
+174
-0
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+174
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
2b737903
...
...
@@ -2107,6 +2107,180 @@ off(type: 'selectByMovement'): void
inputMethodController
.
off
(
'
selectByMovement
'
);
```
### on('getLeftTextOfCursor')<sup>10+</sup>
on(type: 'getLeftTextOfCursor', callback: (length: number) => string): void;
订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----- | ---- | ------ |
| type | string | 是 | 设置监听类型。
<br/>
- type为‘getLeftTextOfCursor’时表示订阅输入法应用获取光标左侧指定长度文本事件监听。 |
| callback | (length: number) => string | 是 | 回调函数,返回光标左侧指定长度文本内容。
<br/>
开发者需要在回调函数中根据传入的长度,获取编辑框最新状态下光标左侧该长度的文本并返回。 |
**示例:**
```
js
try
{
inputMethodController
.
on
(
'
getLeftTextOfCursor
'
,
(
length
)
=>
{
console
.
log
(
`Succeeded in subscribing getLeftTextOfCursor, length:
${
length
}
`
);
let
text
:
string
=
""
;
retutn
text
;
});
}
catch
(
err
)
{
console
.
error
(
`Failed to subscribe getLeftTextOfCursor:
${
JSON
.
stringify
(
err
)}
`
);
}
```
### off('getLeftTextOfCursor')<sup>10+</sup>
off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void;
取消订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
- type为‘getLeftTextOfCursor’时表示取消订阅输入法应用获取光标左侧指定长度文本事件监听。 |
| callback | (length: number) => string | 否 | 回调函数,返回光标左侧指定长度文本内容。|
**示例:**
```
js
try
{
inputMethodController
.
off
(
'
getLeftTextOfCursor
'
,
(
length
)
=>
{
console
.
log
(
`Succeeded in unsubscribing getLeftTextOfCursor, length:
${
length
}
`
);
let
text
:
string
=
""
;
retutn
text
;
});
}
catch
(
err
)
{
console
.
error
(
`Failed to unsubscribing getLeftTextOfCursor:
${
JSON
.
stringify
(
err
)}
`
);
}
```
### on('getRightTextOfCursor')<sup>10+</sup>
on(type: 'getRightTextOfCursor', callback: (length: number) => string): void;
订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----- | ---- | ------ |
| type | string | 是 | 设置监听类型。
<br/>
- type为‘getRightTextOfCursor’时表示订阅输入法应用获取光标右侧指定长度文本事件监听。 |
| callback | (length: number) => string | 是 | 回调函数,返回光标右侧指定长度文本内容。
<br/>
开发者需要在回调函数中根据传入的长度,获取编辑框最新状态下光标右侧该长度的文本并返回。 |
**示例:**
```
js
try
{
inputMethodController
.
on
(
'
getRightTextOfCursor
'
,
(
length
)
=>
{
console
.
log
(
`Succeeded in subscribing getRightTextOfCursor, length:
${
length
}
`
);
let
text
:
string
=
""
;
retutn
text
;
});
}
catch
(
err
)
{
console
.
error
(
`Failed to subscribe getRightTextOfCursor:
${
JSON
.
stringify
(
err
)}
`
);
}
```
### off('getRightTextOfCursor')<sup>10+</sup>
off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void;
取消订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
- type为‘getRightTextOfCursor’时表示取消订阅输入法应用获取光标右侧指定长度文本事件监听。 |
| callback | (length: number) => string | 否 | 回调函数,返回光标右侧指定长度文本内容。|
**示例:**
```
js
try
{
inputMethodController
.
off
(
'
getRightTextOfCursor
'
,
(
length
)
=>
{
console
.
log
(
`Succeeded in unsubscribing getRightTextOfCursor, length:
${
length
}
`
);
let
text
:
string
=
""
;
retutn
text
;
});
}
catch
(
err
)
{
console
.
error
(
`Failed to unsubscribing getRightTextOfCursor:
${
JSON
.
stringify
(
err
)}
`
);
}
```
### on('getTextIndexAtCursor')<sup>10+</sup>
on(type: 'getTextIndexAtCursor', callback: () => number): void;
订阅输入法应用获取光标处文本索引事件。使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----- | ---- | ------ |
| type | string | 是 | 设置监听类型。
<br/>
- type为‘getTextIndexAtCursor’时表示订阅输入法应用获取光标处文本索引事件监听。 |
| callback | () => number | 是 | 回调函数,返回光标处文本索引。
<br/>
开发者需要在回调函数中,获取编辑框最新状态下光标处文本索引并返回。 |
**示例:**
```
js
try
{
inputMethodController
.
on
(
'
getTextIndexAtCursor
'
,
()
=>
{
console
.
log
(
`Succeeded in subscribing getTextIndexAtCursor, length:
${
length
}
`
);
let
index
:
number
=
0
;
retutn
index
;
});
}
catch
(
err
)
{
console
.
error
(
`Failed to subscribe getTextIndexAtCursor:
${
JSON
.
stringify
(
err
)}
`
);
}
```
### off('getTextIndexAtCursor')<sup>10+</sup>
off(type: 'getTextIndexAtCursor', callback?: () => number): void;
取消订阅输入法应用获取光标处文本索引事件。使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
- type为‘getTextIndexAtCursor’时表示取消订阅输入法应用获取光标处文本索引事件监听。 |
| callback | () => number | 否 | 回调函数,返回光标处文本索引。|
**示例:**
```
js
try
{
inputMethodController
.
off
(
'
getTextIndexAtCursor
'
,
()
=>
{
console
.
log
(
`Succeeded in unsubscribing getTextIndexAtCursor, length:
${
length
}
`
);
let
index
:
number
=
0
;
retutn
index
;
});
}
catch
(
err
)
{
console
.
error
(
`Failed to unsubscribing getTextIndexAtCursor:
${
JSON
.
stringify
(
err
)}
`
);
}
```
## InputMethodSetting<sup>8+</sup>
下列API示例中都需使用
[
getSetting
](
#inputmethodgetsetting9
)
获取到InputMethodSetting实例,再通过此实例调用对应方法。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录