@ohos.inputMethodEngine (输入法服务)

本模块面向输入法应用（包括系统输入法应用、三方输入法应用），为输入法应用提供能力，功能包括：创建软键盘窗口、插入/删除字符、选中文本、物理键盘按键事件监听等。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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_UP⁹⁺	number	1	光标上移。
CURSOR_DOWN⁹⁺	number	2	光标下移。
CURSOR_LEFT⁹⁺	number	3	光标左移。
CURSOR_RIGHT⁹⁺	number	4	光标右移。
WINDOW_TYPE_INPUT_METHOD_FLOAT⁹⁺	number	2105	输入法应用窗口风格标识。

inputMethodEngine.getInputMethodAbility⁹⁺

getInputMethodAbility(): InputMethodAbility

获取服务端实例。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodAbility	服务端实例。

示例：

let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate⁹⁺

getKeyboardDelegate(): KeyboardDelegate

获取客户端监听实例。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
KeyboardDelegate	客户端监听实例。

示例：

let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate();

inputMethodEngine.getInputMethodEngine^(deprecated)

getInputMethodEngine(): InputMethodEngine

获取服务端实例。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getInputMethodAbility()替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodEngine	服务端实例。

示例：

let InputMethodEngine = inputMethodEngine.getInputMethodEngine();

inputMethodEngine.createKeyboardDelegate^(deprecated)

createKeyboardDelegate(): KeyboardDelegate

获取客户端监听实例。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getKeyboardDelegate()替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
KeyboardDelegate	客户端监听实例。

示例：

let keyboardDelegate = inputMethodEngine.createKeyboardDelegate();

InputMethodEngine

下列API示例中都需使用getInputMethodEngine回调获取到InputMethodEngine实例，再通过此实例调用对应方法。

on('inputStart')

on(type: 'inputStart', callback: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void

订阅输入法绑定成功事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘inputStart’时表示订阅输入法绑定。
callback	(kbController: KeyboardController, textInputClient: TextInputClient) => void	是	回调函数，返回订阅输入法的KeyboardController和TextInputClient实例。

示例：

inputMethodEngine.getInputMethodEngine().on('inputStart', (kbController, textClient) => {
    let keyboardController = kbController;
    let textInputClient = textClient;
});

1
2
3
4

off('inputStart')

off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void

取消订阅输入法绑定成功事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘inputStart’时表示订阅输入法绑定。
callback	(kbController: KeyboardController, textInputClient: TextInputClient) => void	否	回调函数，返回取消订阅的KeyboardController和TextInputClient实例。

示例：

inputMethodEngine.getInputMethodEngine().off('inputStart', (kbController, textInputClient) => {
    console.log('delete inputStart notification.');
});

1
2
3

on('keyboardShow'|'keyboardHide')

on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void

订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'keyboardShow'，表示订阅输入法显示。 - type为'keyboardHide'，表示订阅输入法隐藏。
callback	() => void	是	回调函数。

示例：

inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
    console.log('inputMethodEngine keyboardShow.');
});
inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
    console.log('inputMethodEngine keyboardHide.');
});

1
2
3
4
5
6

off('keyboardShow'|'keyboardHide')

off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void

取消订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'keyboardShow'，表示订阅输入法显示。 - type为'keyboardHide'，表示订阅输入法隐藏。
callback	() => void	否	回调函数。

示例：

inputMethodEngine.getInputMethodEngine().off('keyboardShow');
inputMethodEngine.getInputMethodEngine().off('keyboardHide');

1
2

InputMethodAbility

下列API示例中都需使用getInputMethodAbility回调获取到InputMethodAbility实例，再通过此实例调用对应方法。

on('inputStart')⁹⁺

on(type: 'inputStart', callback: (kbController: KeyboardController, inputClient: InputClient) => void): void

订阅输入法绑定成功事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘inputStart’时表示订阅输入法绑定。
callback	(kbController: KeyboardController, inputClient: InputClient) => void	是	回调函数，返回输入法操作相关实例。

示例：

inputMethodEngine.getInputMethodAbility().on('inputStart', (kbController, client) => {
    let keyboardController = kbController;
    let inputClient = client;
});

1
2
3
4

off('inputStart')⁹⁺

off(type: 'inputStart', callback?: (kbController: KeyboardController, inputClient: InputClient) => void): void

取消订阅输入法绑定成功事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘inputStart’时表示订阅输入法绑定。
callback	(kbController: KeyboardController, inputClient: InputClient) => void	否	回调函数，返回输入法操作相关实例。

示例：

inputMethodEngine.getInputMethodAbility().off('inputStart');

on('inputStop')⁹⁺

on(type: 'inputStop', callback: () => void): void

订阅停止输入法应用事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘inputStop’时表示订阅停止输入法应用事件。
callback	() => void	是	回调函数。

示例：

inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
    console.log('inputMethodAbility inputStop');
});

1
2
3

off('inputStop')⁹⁺

off(type: 'inputStop', callback: () => void): void

取消订阅停止输入法应用事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘inputStop’时表示订阅停止输入法应用事件。
callback	() => void	是	回调函数。

示例：

inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
    console.log('inputMethodAbility delete inputStop notification.');
});

1
2
3

on('setCallingWindow')⁹⁺

on(type: 'setCallingWindow', callback: (wid: number) => void): void

订阅设置调用窗口事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘setCallingWindow’时表示订阅设置调用窗口事件。
callback	(wid: number) => void	是	回调函数，返回调用方window id。

示例：

inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid) => {
    console.log('inputMethodAbility setCallingWindow');
});

1
2
3

off('setCallingWindow')⁹⁺

off(type: 'setCallingWindow', callback: (wid:number) => void): void

取消订阅设置调用窗口事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为‘setCallingWindow’时表示订阅设置调用窗口事件。
callback	(wid:number) => void	是	回调函数，返回调用方window id。

示例：

inputMethodEngine.getInputMethodAbility().off('setCallingWindow', () => {
    console.log('inputMethodAbility delete setCallingWindow notification.');
});

1
2
3

on('keyboardShow'|'keyboardHide')⁹⁺

on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void

订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'keyboardShow'，表示订阅显示键盘事件。 - type为'keyboardHide'，表示订阅隐藏键盘事件。
callback	() => void	是	回调函数。

示例：

inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
    console.log('InputMethodAbility keyboardShow.');
});
inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
    console.log('InputMethodAbility keyboardHide.');
});

1
2
3
4
5
6

off('keyboardShow'|'keyboardHide')⁹⁺

off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void

取消订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'keyboardShow'，表示取消订阅显示键盘事件。 - type为'keyboardHide'，表示取消订阅隐藏键盘事件。
callback	() => void	否	回调函数。

示例：

inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
    console.log('InputMethodAbility delete keyboardShow notification.');
});
inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
    console.log('InputMethodAbility delete keyboardHide notification.');
});

1
2
3
4
5
6

on('setSubtype')⁹⁺

on(type: 'setSubtype', callback: (inputMethodSubtype: InputMethodSubtype) => void): void

订阅设置输入法子类型事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'setSubtype'，表示订阅输入法子类型的设置事件。
callback	(inputMethodSubtype: InputMethodSubtype) => void	是	回调函数，返回设置的输入法子类型。

示例：

inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype) => {
    console.log('InputMethodAbility setSubtype.');
});

1
2
3

off('setSubtype')⁹⁺

off(type: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => void): void

取消订阅输入法子类型事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'setSubtype'，表示取消订阅输入法子类型的设置事件。
callback	(inputMethodSubtype: InputMethodSubtype) => void	否	回调函数，返回设置的输入法子类型。

示例：

inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
    console.log('InputMethodAbility delete setSubtype notification.');
});

1
2
3

createPanel¹⁰⁺

createPanel(ctx: BaseContext, info: PanelInfo, callback: AsyncCallback<Panel>): void

创建输入法应用面板。仅支持输入法应用或者具有system_core权限的系统应用调用。单个输入法应用仅仅允许创建一个SOFT_KEYBOARD及一个STATUS_BAR类型的面板。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
ctx	BaseContext	是	当前输入法应用上下文信息。
info	PanelInfo	是	输入法面板信息。
callback	AsyncCallback<Panel>	是	回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。

错误码：

错误码ID	错误信息
12800004	not an input method extension

示例：

let panelInfo: inputMethodEngine.PanelInfo = {
  panelType: SOFT_KEYBOARD,
  panelFlag: FLG_FIXED
}
try {
  inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo, (err, panel) => {
    if (err !== undefined) {
      console.log('Failed to create panel, err: ' + JSON.stringify(err));
      return;
    }
    console.log('Succeed in creating panel.');
  })
} catch(err) {
  console.log('Failed to create panel, err: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

createPanel¹⁰⁺

createPanel(ctx: BaseContext, info: PanelInfo): Promise<Panel>

创建输入法应用面板。仅支持输入法应用或者具有system_core权限的系统应用调用。单个输入法应用仅仅允许创建一个SOFT_KEYBOARD及一个STATUS_BAR类型的面板。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
ctx	BaseContext	是	当前输入法应用上下文信息。
info	PanelInfo	是	输入法面板信息。

返回值：

类型	说明
Promise<Panel>	回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。

错误码：

错误码ID	错误信息
12800004	not an input method extension

示例：

let panelInfo: inputMethodEngine.PanelInfo = {
  panelType: SOFT_KEYBOARD,
  panelFlag: FLG_FIXED
}
inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo).then((panel) => {
  console.log('Succeed in creating panel.');
}).catch((err) => {
  console.log('Failed to create panel, err: ' + JSON.stringify(err));
})

1
2
3
4
5
6
7
8
9

destroyPanel¹⁰⁺

destroyPanel(panel: Panel, callback: AsyncCallback<void>): void;

销毁输入法应用面板。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
panel	Panel	是	要销毁的panel对象。
callback	AsyncCallback<void>	是	回调函数。当输入法面板销毁成功，err为undefined，否则为错误对象。

示例：

let panelInfo: inputMethodEngine.PanelInfo = {
  panelType: SOFT_KEYBOARD,
  panelFlag: FLG_FIXED
}
try {
  inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo, (err, panel) => {
    if (err !== undefined) {
      console.log('Failed to create panel, err: ' + JSON.stringify(err));
      return;
    }
	globalThis.inputMethodPanel = panel;
    console.log('Succeed in creating panel.');
  })
} catch(err) {
  console.log('Failed to create panel, err: ' + JSON.stringify(err));
}

try {
  inputMethodEngine.getInputMethodAbility().destroyPanel((err) => {
    if(err !== undefined) {
      console.log('Failed to destroy panel, err: ' + JSON.stringify(err));
      return;
    }
    console.log('Succeed in destroying panel.');
  })
} catch(err) {
  console.log('Failed to destroy panel, err: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

destroyPanel¹⁰⁺

destroyPanel(panel: Panel): Promise<void>;

销毁输入法应用面板。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
panel	Panel	是	要销毁的panel对象。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

let panelInfo: inputMethodEngine.PanelInfo = {
  panelType: SOFT_KEYBOARD,
  panelFlag: FLG_FIXED
}
try {
  inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo, (err, panel) => {
    if (err !== undefined) {
      console.log('Failed to create panel, err: ' + JSON.stringify(err));
      return;
    }
	globalThis.inputMethodPanel = panel;
    console.log('Succeed in creating panel.');
  })
} catch(err) {
  console.log('Failed to create panel, err: ' + JSON.stringify(err));
}

try {
  inputMethodEngine.getInputMethodAbility().destroyPanel().then(() => {
    console.log('Succeed in destroying panel.');
  }).catch((err) => {
    console.log('Failed to destroy panel, err: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('Failed to destroy panel, err: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

KeyboardDelegate

下列API示例中都需使用getKeyboardDelegate回调获取到KeyboardDelegate实例，再通过此实例调用对应方法。

on('keyDown'|'keyUp')

on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void

订阅硬键盘（即物理键盘）事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'keyDown'，表示订阅硬键盘按下事件。 - type为'keyUp'，表示订阅硬键盘抬起事件。
callback	(event: KeyEvent) => boolean	是	回调函数，返回按键信息。

示例：

inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
    return true;
});
inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
    return true;
});

1
2
3
4
5
6
7
8
9
10

off('keyDown'|'keyUp')

off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void

取消订阅硬键盘（即物理键盘）事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - type为'keyDown'，表示取消订阅硬键盘按下事件。 - type为'keyUp'，表示取消订阅硬键盘抬起事件。
callback	(event: KeyEvent) => boolean	否	回调函数，返回按键信息。

示例：

inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent) => {
    console.log('delete keyUp notification.');
    return true;
});
inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
    console.log('delete keyDown notification.');
    return true;
});

1
2
3
4
5
6
7
8

on('cursorContextChange')

on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) => void): void

订阅光标变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	光标变化事件。 - type为’cursorContextChange‘时，表示订阅光标变化事件。
callback	(x: number, y: number, height: number) => void	是	回调函数，返回光标信息。 - x为光标上端的的x坐标值。 - y为光标上端的y坐标值。 - 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);
});

1
2
3
4
5

off('cursorContextChange')

off(type: 'cursorContextChange', callback?: (x: number, y: number, height: number) => void): void

取消订阅光标变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	光标变化事件。 - type为’cursorContextChange‘时，表示光标变化。
callback	(x: number, y:number, height:number) => void	否	回调函数，返回光标信息。 - x为光标上端的的x坐标值。 - y为光标上端的y坐标值。 - height为光标的高度值。

示例：

inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x, y, height) => {
    console.log('delete cursorContextChange notification.');
});

1
2
3

on('selectionChange')

on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void

订阅文本选择变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本选择变化事件。 - type为’selectionChange‘时，表示选择文本变化。
callback	(oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void	是	回调函数，返回文本选择信息。 - oldBegin为变化之前被选中文本的起始下标。 - oldEnd为变化之前被选中文本的终止下标。 - newBegin为变化之后被选中文本的起始下标。 - 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);
});

1
2
3
4
5
6

off('selectionChange')

off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void

取消订阅文本选择变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本选择变化事件。 - type为’selectionChange‘时，表示选择文本变化。
callback	(oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void	否	回调函数，返回文本选择信息。 - oldBegin为变化之前被选中文本的起始下标。 - oldEnd为变化之前被选中文本的终止下标。 - newBegin为变化之后被选中文本的起始下标。 - newEnd为变化之后被选中文本的终止下标。

示例：

inputMethodEngine.getKeyboardDelegate().off('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
  console.log('delete selectionChange notification.');
});

1
2
3

on('textChange')

on(type: 'textChange', callback: (text: string) => void): void

订阅文本变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本变化事件。 - type为’textChange‘时，表示订阅文本变化事件。
callback	(text: string) => void	是	回调函数，返回订阅的文本内容。

示例：

inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => {
    console.log('inputMethodEngine textChange. text:' + text);
});

1
2
3

off('textChange')

off(type: 'textChange', callback?: (text: string) => void): void

取消订阅文本变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本变化事件。 - type为’textChange‘时，表示取消订阅文本变化事件。
callback	(text: string) => void	否	回调函数，返回取消订阅的文本内容。

示例：

inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {
    console.log('delete textChange notification. text:' + text);
});

1
2
3

Panel¹⁰⁺

下列API示例中都需使用createPanel回调获取到Panel实例，再通过此实例调用对应方法。

setUiContent¹⁰⁺

setUiContent(path: string, callback: AsyncCallback<void>): void

为当前面板加载具体页面内容，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	设置加载页面的路径。
callback	AsyncCallback<void>	是	回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。

示例：

try {
  panel.setUiContent('pages/page2/page2', (err) => {
    if (err) {
      console.error('Failed to set the content. err:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the content.');
  });
} catch (exception) {
  console.error('Failed to set the content. err:' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10
11

setUiContent¹⁰⁺

setUiContent(path: string): Promise<void>

为当前面板加载具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	设置加载页面的路径。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

try {
  let promise = panel.setUiContent('pages/page2/page2');
  promise.then(() => {
    console.info('Succeeded in setting the content.');
  }).catch((err) =>{
    console.error('Failed to set the content. err: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the content. err: ' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10

setUiContent¹⁰⁺

setUiContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void

为当前面板加载与LocalStorage相关联的具体页面内容，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	设置加载页面的路径。
storage	LocalStorage	是	存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。
callback	AsyncCallback<void>	是	回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。

示例：

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp',121);
try {
  panel.setUiContent('pages/page2/page2', storage, (err) => {
    if (err) {
      console.error('Failed to set the content. err:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the content.');
  });
} catch (exception) {
  console.error('Failed to set the content. err:' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10
11
12
13

setUiContent¹⁰⁺

setUiContent(path: string, storage: LocalStorage): Promise<void>

为当前面板加载与LocalStorage相关联的具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	设置加载页面的路径。
storage	LocalStorage	是	存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp',121);
try {
  let promise = panel.setUiContent('pages/page2/page2');
  promise.then(() => {
    console.info('Succeeded in setting the content.');
  }).catch((err) =>{
    console.error('Failed to set the content. err: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the content. err: ' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10
11
12

resize¹⁰⁺

resize(width: number, height: number, callback: AsyncCallback<void>): void

改变当前面板大小，使用callback异步回调。面板存在大小限制，面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的二分之一。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
width	number	是	目标面板的宽度，单位为px。
height	number	是	目标面板的高度，单位为px。
callback	AsyncCallback<void>	是	回调函数。当面板大小改变成功，err为undefined，否则err为错误对象。

示例：

try {
  panel.resize(500, 1000, (err) => {
    if (err) {
      console.error('Failed to change the panel size. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in changing the panel size.');
  });
} catch (exception) {
  console.error('Failed to change the panel size. Cause:' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10
11

resize¹⁰⁺

resize(width: number, height: number): Promise<void>;

改变当前面板大小，使用Promise异步回调。面板存在大小限制，面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的二分之一。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
width	number	是	目标面板的宽度，单位为px。
height	number	是	目标面板的高度，单位为px。

返回值：

类型	说明
Promise	无返回结果的Promise对象。

示例：

try {
  let promise = panel.resize(500, 1000);
  promise.then(() => {
    console.info('Succeeded in changing the panel size.');
  }).catch((err) =>{
    console.error('Failed to change the panel size. err: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to change the panel size. err: ' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10

moveTo¹⁰⁺

moveTo(x: number, y: number, callback: AsyncCallback<void>): void

移动面板位置，使用callback异步回调。对FLG_FIXED状态的panel不产生实际移动效果。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
x	number	是	面板在x轴方向移动的值，值为正表示右移，单位为px。
y	number	是	面板在y轴方向移动的值，值为正表示下移，单位为px。
callback	AsyncCallback<void>	是	回调函数。当面板位置移动成功，err为undefined，否则err为错误对象。

示例：

try {
  panel.moveTo(300, 300, (err) =>{
    if (err) {
      console.error('Failed to move the panel. err:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in moving the panel.');
  });
} catch (exception) {
    console.error('Failed to move the panel. err:' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10
11

moveTo¹⁰⁺

moveTo(x: number, y: number): Promise<void>

移动面板位置，使用callback异步回调。对FLG_FIXED状态的panel不产生实际移动效果。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
x	number	是	面板在x轴方向移动的值，值为正表示右移，单位为px。
y	number	是	面板在y轴方向移动的值，值为正表示下移，单位为px。

返回值：

类型	说明
Promise	无返回结果的Promise对象。

示例：

try {
  let promise = windowClass.moveTo(300, 300);
  promise.then(() => {
    console.info('Succeeded in moving the panel.');
  }).catch((err) =>{
    console.error('Failed to move the panel. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to move the panel. Cause:' + JSON.stringify(exception));
}

1
2
3
4
5
6
7
8
9
10

show¹⁰⁺

show(callback: AsyncCallback<void>): void

显示当前面板，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当面板显示成功，err为undefined，否则err为错误对象。

示例：

panel.show((err) => {
  if (err) {
    console.error('Failed to show the panel. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the panel.');
});

1
2
3
4
5
6
7

show¹⁰⁺

show(): Promise<void>

显示当前面板，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

let promise = panel.show();
promise.then(() => {
  console.info('Succeeded in showing the panel.');
}).catch((err) =>{
  console.error('Failed to show the panel. err: ' + JSON.stringify(err));
});

1
2
3
4
5
6

hide¹⁰⁺

hide(callback: AsyncCallback<void>): void

隐藏当前面板，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当面板隐藏成功，err为undefined，否则err为错误对象。

示例：

panel.hide((err) => {
  if (err) {
    console.error('Failed to hide the panel. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in hiding the panel.');
});

1
2
3
4
5
6
7

hide¹⁰⁺

hide(): Promise<void>

隐藏当前面板，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

let promise = panel.hide();
promise.then(() => {
  console.info('Succeeded in hiding the panel.');
}).catch((err) =>{
  console.error('Failed to hide the panel. err: ' + JSON.stringify(err));
});

1
2
3
4
5
6

on¹⁰⁺

on(type: 'show' | 'hide', callback: () => void): void

监听当前面板状态，可监听面板类型为show或者hide，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	'show'\|'hide'	是	监听当前面板的状态类型，show表示显示状态，hide表示隐藏状态
callback	() => void	是	回调函数。

示例：

panel.on('show', () => {
  console.info('Panel is showing.');
});

1
2
3

off¹⁰⁺

off(type: 'show' | 'hide', callback?: () => void): void

取消监听当前面板状态，可取消监听的面板类型为show或者hide，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	'show'/'hide'	是	要取消监听的当前面板状态类型，show表示显示状态，hide表示隐藏状态
callback	() => void	否	回调函数。

示例：

panel.off('show');

changeFlag¹⁰⁺

changeFlag(flag: PanelFlag): void

改变面板状态为固定态或者悬浮态。仅对SOFT_KEYBOARD类型生效。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
flag	PanelFlag	是	要切换到的面板状态类型。

示例：

let panelFlag = inputMethodEngine.getInputMethodAbility().PanelFlag.FLG_FIXED;
panel.changeFlag(panelFlag);

1
2

KeyboardController

下列API示例中都需使用on('inputStart')回调获取到KeyboardController实例，再通过此实例调用对应方法。

hide⁹⁺

hide(callback: AsyncCallback<void>): void

隐藏输入法。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当输入法隐藏成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

keyboardController.hide((err) => {
    if (err !== undefined) {
        console.error('Failed to hide keyboard: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in hiding keyboard.');
});

1
2
3
4
5
6
7

hide⁹⁺

hide(): Promise<void>

隐藏输入法。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

keyboardController.hide().then(() => {
    console.info('Succeeded in hiding keyboard.');
}).catch((err) => {
    console.info('Failed to hide keyboard: ' + JSON.stringify(err));
});

1
2
3
4
5

hideKeyboard^(deprecated)

hideKeyboard(callback: AsyncCallback<void>): void

隐藏输入法。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用hide替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当输入法隐藏成功，err为undefined，否则为错误对象。

示例：

keyboardController.hideKeyboard((err) => {
    if (err !== undefined) {
        console.error('Failed to hide Keyboard: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in hiding keyboard.');
});

1
2
3
4
5
6
7

hideKeyboard^(deprecated)

hideKeyboard(): Promise<void>

隐藏输入法。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用hide替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

keyboardController.hideKeyboard().then(() => {
    console.info('Succeeded in hiding keyboard.');
}).catch((err) => {
    console.info('Failed to hide Keyboard: ' + JSON.stringify(err));
});

1
2
3
4
5

InputClient⁹⁺

下列API示例中都需使用on('inputStart')回调获取到InputClient实例，再通过此实例调用对应方法。

sendKeyFunction⁹⁺

sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void

发送功能键。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	number	是	功能键键值。当值为0时，表示无效按键；当值为1时，表示确认键（即回车键）。
callback	AsyncCallback<boolean>	是	回调函数。当功能键发送成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

let action = 1;
try {
    inputClient.sendKeyFunction(action, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in sending key function. ');
        } else {
            console.error('Failed to sendKeyFunction. ');
        }
    });
} catch (err) {
    console.error('sendKeyFunction err: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

sendKeyFunction⁹⁺

sendKeyFunction(action: number): Promise<boolean>

发送功能键。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	number	是	功能键键值。当值为0时，表示无效按键；当值为1时，表示确认键（即回车键）。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示功能键发送成功；返回false表示功能键发送失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

let action = 1;
try {
    inputClient.sendKeyFunction(action).then((result) => {
        if (result) {
            console.info('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));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

getForward⁹⁺

getForward(length:number, callback: AsyncCallback<string>): void

获取光标前固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<string>	是	回调函数。当光标前固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.
12800006	Input method controller error.

示例：

let length = 1;
try {
    inputClient.getForward(length, (err, text) => {
        if (err !== undefined) {
            console.error('Failed to getForward: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting forward, text: ' + text);
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12

getForward⁹⁺

getForward(length:number): Promise<string>

获取光标前固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<string>	Promise对象，返回光标前固定长度的文本。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.
12800006	Input method controller error.

示例：

let length = 1;
try {
    inputClient.getForward(length).then((text) => {
        console.info('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));
}

1
2
3
4
5
6
7
8
9
10

getBackward⁹⁺

getBackward(length:number, callback: AsyncCallback<string>): void

获取光标后固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<string>	是	回调函数。当光标后固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.
12800006	Input method controller error.

示例：

let length = 1;
try {
    inputClient.getBackward(length, (err, text) => {
        if (err !== undefined) {
            console.error('Failed to getForward: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting backward, text: ' + text);
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12

getBackward⁹⁺

getBackward(length:number): Promise<string>

获取光标后固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<string>	Promise对象，返回光标后固定长度的文本。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.
12800006	Input method controller error.

示例：

let length = 1;
try {
    inputClient.getBackward(length).then((text) => {
        console.info('Succeeded in getting backward, text: ' + text);
    }).catch((err) => {
        console.error('Failed to getForward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10

deleteForward⁹⁺

deleteForward(length:number, callback: AsyncCallback<boolean>): void

删除光标前固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<boolean>	是	回调函数。当光标前固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800002	Input method engine error.
12800003	input method client error.

示例：

let length = 1;
try {
    inputClient.deleteForward(length, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to delete forward: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in deleting forward. ');
        } else {
            console.error('Failed to delete forward: ' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error('Failed to delete forward: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

deleteForward⁹⁺

deleteForward(length:number): Promise<boolean>

删除光标前固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标前固定长度的文本成功；返回false表示删除光标前固定长度的文本失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800002	Input method engine error.
12800003	input method client error.

示例：

let length = 1;
try {
    inputClient.deleteForward(length).then((result) => {
        if (result) {
            console.info('Succeeded in deleting forward. ');
        } else {
            console.error('Failed to delete Forward. ');
        }
    }).catch((err) => {
        console.error('Failed to delete Forward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to delete Forward: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

deleteBackward⁹⁺

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

删除光标后固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<boolean>	是	回调函数。当光标后固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800002	Input method engine error.
12800003	input method client error.

示例：

let length = 1;
try {
    inputClient.deleteBackward(length, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to delete Backward: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in deleting backward. ');
        } else {
            console.error('Failed to delete Backward: ' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error('deleteBackward err: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

deleteBackward⁹⁺

deleteBackward(length:number): Promise<boolean>

删除光标后固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标后固定长度的文本成功；返回false表示删除光标后固定长度的文本失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800002	Input method engine error.
12800003	input method client error.

示例：

let length = 1;
inputClient.deleteBackward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
}).catch((err) => {
    console.error('Failed to deleteBackward: ' + JSON.stringify(err));
});

1
2
3
4
5
6
7
8
9
10

insertText⁹⁺

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本。
callback	AsyncCallback<boolean>	是	回调函数。当文本插入成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800002	Input method engine error.
12800003	input method client error.

示例：

inputClient.insertText('test', (err, result) => {
    if (err !== undefined) {
        console.error('Failed to insertText: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
});

1
2
3
4
5
6
7
8
9
10
11

insertText⁹⁺

insertText(text:string): Promise<boolean>

插入文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示插入文本成功；返回false表示插入文本失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800002	Input method engine error.
12800003	input method client error.

示例：

try {
    inputClient.insertText('test').then((result) => {
        if (result) {
            console.info('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));
}

1
2
3
4
5
6
7
8
9
10
11
12
13

getEditorAttribute⁹⁺

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

获取编辑框属性值。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<EditorAttribute>	是	回调函数。当编辑框属性值获取成功，err为undefined，data为编辑框属性值；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

inputClient.getEditorAttribute((err, editorAttribute) => {
    if (err !== undefined) {
        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));
});

1
2
3
4
5
6
7
8

getEditorAttribute⁹⁺

getEditorAttribute(): Promise<EditorAttribute>

获取编辑框属性值。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<EditorAttribute>	Promise对象，返回编辑框属性值。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

inputClient.getEditorAttribute().then((editorAttribute) => {
    console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err) => {
    console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
});

1
2
3
4
5
6

moveCursor⁹⁺

moveCursor(direction: number, callback: AsyncCallback<void>): void

移动光标。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
direction	number	是	光标移动方向。
callback	AsyncCallback<void>	是	回调函数。当光标移动成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

try {
    inputClient.moveCursor(inputMethodEngine.CURSOR_UP, (err) => {
        if (err !== undefined) {
            console.error('Failed to moveCursor: ' + JSON.stringify(err));
            return;
        }
        console.info('Succeeded in moving cursor.');
    });
} catch (err) {
    console.error('Failed to moveCursor: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9
10
11

moveCursor⁹⁺

moveCursor(direction: number): Promise<void>

移动光标。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
direction	number	是	光标移动方向。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.

示例：

try {
    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.log('Failed to moveCursor: ' + JSON.stringify(err));
}

1
2
3
4
5
6
7
8
9

selectByRange¹⁰⁺

selectByRange(range: Range, callback: AsyncCallback<void>): void

根据索引范围选中文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
range	Range	是	选中文本的范围。
callback	AsyncCallback<void>	是	回调函数。当成功发送选中事件后，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
401	parameter error.
12800003	input method client error.

示例：

try {
    inputClient.selectByRange({start: 0, end: 1}, (err) => {
        if (err !== undefined) {
            console.error('Failed to selectByRange: ${err.message}');
            return;
        }
        console.info('Succeeded in selecting by range.');
    });
} catch (err) {
    console.error('Failed to selectByRange: ${err.message}');
}

1
2
3
4
5
6
7
8
9
10
11

selectByRange¹⁰⁺

selectByRange(range: Range): Promise<void>

根据索引范围选中文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
range	Range	是	选中文本的范围。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
401	parameter error.
12800003	input method client error.

示例：

try {
    inputClient.selectByRange({start: 0, end:1}).then(() => {
        console.log('Succeeded in selecting by range.');
    }).catch((err) => {
        console.error('Failed to selectByRange: ${err.message}');
    });
} catch (err) {
    console.log('Failed to selectByRange: ${err.message}');
}

1
2
3
4
5
6
7
8
9

selectByMovement¹⁰⁺

selectByMovement(movement: Movement, callback: AsyncCallback<void>): void

根据光标移动方向选中文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
movement	Movement	是	选中时光标移动的方向。
callback	AsyncCallback<void>	是	回调函数。当成功发送选中事件后，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
401	parameter error.
12800003	input method client error.

示例：

try {
    inputClient.selectByMovement({direction: 1}, (err) => {
        if (err !== undefined) {
            console.error('Failed to selectByMovement: ${err.message}');
            return;
        }
        console.info('Succeeded in selecting by movement.');
    });
} catch (err) {
    console.error('Failed to selectByMovement: ${err.message}');
}

1
2
3
4
5
6
7
8
9
10
11

selectByMovement¹⁰⁺

selectByMovement(movement: Movement): Promise<void>

根据索引范围选中文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
movement	Movement	是	选中时光标移动的方向。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
401	parameter error.
12800003	input method client error.

示例：

try {
    inputClient.selectByMovement({direction: 1}).then(() => {
        console.log('Succeeded in selecting by movement.');
    }).catch((err) => {
        console.error('Failed to selectByMovement: ${err.message}');
    });
} catch (err) {
    console.log('Failed to selectByMovement: ${err.message}');
}

1
2
3
4
5
6
7
8
9

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor(callback: AsyncCallback<number>): void

获取光标所在处的文本索引。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数。当文本索引获取成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
401	parameter error.
12800003	input method client error.
12800006	Input method controller error.

示例：

inputClient.getTextIndexAtCursor((err, index) => {
    if (err !== undefined) {
        console.error('Failed to getTextIndexAtCursor: ${err.message}');
        return;
    }
    console.info('Succeeded in getTextIndexAtCursor: ' + index);
});

1
2
3
4
5
6
7

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor(): Promise<number>

获取光标所在处的文本索引。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<number>	Promise对象，返回光标所在处的文本索引。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID	错误信息
12800003	input method client error.
12800006	Input method controller error.

示例：

inputClient.getTextIndexAtCursor().then((index) => {
    console.info('Succeeded in getTextIndexAtCursor: ' + index);
}).catch((err) => {
    console.error('Failed to getTextIndexAtCursor: ${err.message}');
});

1
2
3
4
5

EditorAttribute

编辑框属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
enterKeyType	number	是	否	编辑框的功能属性。
inputPattern	number	是	否	编辑框的文本属性。

KeyEvent

按键属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
keyCode	number	是	否	按键的键值。
keyAction	number	是	否	按键的状态。

PanelFlag¹⁰⁺

输入法面板状态类型枚举。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
FLG_FIXED	0	固定态面板类型。
FLG_FLOATING	1	悬浮态面板类型。

PanelType¹⁰⁺

输入法面板类型枚举。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
SOFT_KEYBOARD	0	软键盘类型。
STATUS_BAR	1	状态栏类型。

PanelInfo¹⁰⁺

系统能力： SystemCapability.MiscServices.InputMethodFramework

输入法面板属性。

名称	类型	可读	可写	说明
type	number	是	是	面板的类型。
flag	number	是	是	面板的状态类型。

TextInputClient^(deprecated)

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用InputClient替代。

下列API示例中都需使用on('inputStart')回调获取到TextInputClient实例，再通过此实例调用对应方法。

getForward^(deprecated)

getForward(length:number, callback: AsyncCallback<string>): void

获取光标前固定长度的文本。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getForward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<string>	是	回调函数。当光标前固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

示例：

let length = 1;
textInputClient.getForward(length, (err, text) => {
    if (err !== undefined) {
        console.error('Failed to getForward: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in getting forward, text: ' + text);
});

1
2
3
4
5
6
7
8

getForward^(deprecated)

getForward(length:number): Promise<string>

获取光标前固定长度的文本。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getForward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<string>	Promise对象，返回光标前固定长度的文本。

示例：

let length = 1;
textInputClient.getForward(length).then((text) => {
    console.info('Succeeded in getting forward, text: ' + text);
}).catch((err) => {
    console.error('Failed to getForward: ' + JSON.stringify(err));
});

1
2
3
4
5
6

getBackward^(deprecated)

getBackward(length:number, callback: AsyncCallback<string>): void

获取光标后固定长度的文本。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getBackward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<string>	是	回调函数。当光标后固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

示例：

let length = 1;
textInputClient.getBackward(length, (err, text) => {
    if (err !== undefined) {
        console.error('Failed to getBackward: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in getting borward, text: ' + text);
});

1
2
3
4
5
6
7
8

getBackward^(deprecated)

getBackward(length:number): Promise<string>

获取光标后固定长度的文本。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getBackward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<string>	Promise对象，返回光标后固定长度的文本。

示例：

let length = 1;
textInputClient.getBackward(length).then((text) => {
    console.info('Succeeded in getting backward: ' + JSON.stringify(text));
}).catch((err) => {
    console.error('Failed to getBackward: ' + JSON.stringify(err));
});

1
2
3
4
5
6

deleteForward^(deprecated)

deleteForward(length:number, callback: AsyncCallback<boolean>): void

删除光标前固定长度的文本。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用deleteForward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<boolean>	是	回调函数。当光标前固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

示例：

let length = 1;
textInputClient.deleteForward(length, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to deleteForward: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in deleting forward. ');
    } else {
        console.error('Failed to deleteForward. ');
    }
});

1
2
3
4
5
6
7
8
9
10
11
12

deleteForward^(deprecated)

deleteForward(length:number): Promise<boolean>

删除光标前固定长度的文本。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用deleteForward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标前固定长度的文本成功；返回false表示删除光标前固定长度的文本失败。

示例：

let length = 1;
textInputClient.deleteForward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting forward. ');
    } else {
        console.error('Failed to delete forward. ');
    }
}).catch((err) => {
    console.error('Failed to delete forward: ' + JSON.stringify(err));
});

1
2
3
4
5
6
7
8
9
10

deleteBackward^(deprecated)

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

删除光标后固定长度的文本。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用deleteBackward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。
callback	AsyncCallback<boolean>	是	回调函数。当光标后固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

示例：

let length = 1;
textInputClient.deleteBackward(length, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to delete backward: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
});

1
2
3
4
5
6
7
8
9
10
11
12

deleteBackward^(deprecated)

deleteBackward(length:number): Promise<boolean>

删除光标后固定长度的文本。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用deleteBackward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标后固定长度的文本成功；返回false表示删除光标后固定长度的文本失败。

示例：

let length = 1;
textInputClient.deleteBackward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
}).catch((err) => {
    console.error('Failed to deleteBackward: ' + JSON.stringify(err));
});

1
2
3
4
5
6
7
8
9
10

sendKeyFunction^(deprecated)

sendKeyFunction(action: number, callback: AsyncCallback<boolean>): void

发送功能键。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用sendKeyFunction替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	number	是	功能键键值。当值为0时，表示无效按键；当值为1时，表示确认键（即回车键）。
callback	AsyncCallback<boolean>	是	回调函数。当功能键发送成功，err为undefined，data为true；否则为错误对象。

示例：

let action = 1;
textInputClient.sendKeyFunction(action, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in sending key function. ');
    } else {
        console.error('Failed to sendKeyFunction. ');
    }
});

1
2
3
4
5
6
7
8
9
10
11
12

sendKeyFunction^(deprecated)

sendKeyFunction(action: number): Promise<boolean>

发送功能键。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用sendKeyFunction替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	number	是	功能键键值。当值为0时，表示无效按键；当值为1时，表示确认键（即回车键）。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示发送功能键成功；返回false表示发送功能键失败。

示例：

let action = 1;
textInputClient.sendKeyFunction(action).then((result) => {
    if (result) {
        console.info('Succeeded in sending key function. ');
    } else {
        console.error('Failed to sendKeyFunction. ');
    }
}).catch((err) => {
    console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
});

1
2
3
4
5
6
7
8
9
10

insertText^(deprecated)

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用insertText替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本。
callback	AsyncCallback<boolean>	是	回调函数。当文本插入成功，err为undefined，data为true；否则为错误对象。

示例：

textInputClient.insertText('test', (err, result) => {
    if (err !== undefined) {
        console.error('Failed to insertText: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
});

1
2
3
4
5
6
7
8
9
10
11

insertText^(deprecated)

insertText(text:string): Promise<boolean>

插入文本。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用insertText替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示插入文本成功；返回false表示插入文本失败。

示例：

textInputClient.insertText('test').then((result) => {
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
}).catch((err) => {
    console.error('Failed to insertText: ' + JSON.stringify(err));
});

1
2
3
4
5
6
7
8
9

getEditorAttribute^(deprecated)

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

获取编辑框属性值。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getEditorAttribute替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<EditorAttribute>	是	回调函数。当编辑框的属性值获取成功，err为undefined，data为编辑框属性值；否则为错误对象。

示例：

textInputClient.getEditorAttribute((err, editorAttribute) => {
    if (err !== undefined) {
        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));
});

1
2
3
4
5
6
7
8

getEditorAttribute^(deprecated)

getEditorAttribute(): Promise<EditorAttribute>

获取编辑框属性值。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getEditorAttribute替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<EditorAttribute>	Promise对象，返回编辑框属性值。

示例：

textInputClient.getEditorAttribute().then((editorAttribute) => {
    console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err) => {
    console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
});

1
2
3
4
5
6

@ohos.inputMethodEngine (输入法服务)

@ohos.inputMethodEngine (输入法服务)

导入模块

常量

inputMethodEngine.getInputMethodAbility9+

inputMethodEngine.getKeyboardDelegate9+

inputMethodEngine.getInputMethodEngine(deprecated)

inputMethodEngine.createKeyboardDelegate(deprecated)

InputMethodEngine

on('inputStart')

off('inputStart')

on('keyboardShow'|'keyboardHide')

off('keyboardShow'|'keyboardHide')

InputMethodAbility

on('inputStart')9+

off('inputStart')9+

on('inputStop')9+

off('inputStop')9+

on('setCallingWindow')9+

off('setCallingWindow')9+

on('keyboardShow'|'keyboardHide')9+

off('keyboardShow'|'keyboardHide')9+

on('setSubtype')9+

off('setSubtype')9+

createPanel10+

createPanel10+

destroyPanel10+

destroyPanel10+

KeyboardDelegate

on('keyDown'|'keyUp')

off('keyDown'|'keyUp')

on('cursorContextChange')

off('cursorContextChange')

on('selectionChange')

off('selectionChange')

on('textChange')

off('textChange')

Panel10+

setUiContent10+

setUiContent10+

setUiContent10+

setUiContent10+

resize10+

resize10+

moveTo10+

moveTo10+

show10+

show10+

hide10+

hide10+

on10+

off10+

changeFlag10+

KeyboardController

hide9+

hide9+

hideKeyboard(deprecated)

hideKeyboard(deprecated)

InputClient9+

sendKeyFunction9+

sendKeyFunction9+

getForward9+

getForward9+

getBackward9+

getBackward9+

deleteForward9+

deleteForward9+

deleteBackward9+

deleteBackward9+

insertText9+

insertText9+

getEditorAttribute9+

getEditorAttribute9+

moveCursor9+

moveCursor9+

selectByRange10+

selectByRange10+

selectByMovement10+

selectByMovement10+

getTextIndexAtCursor10+

inputMethodEngine.getInputMethodAbility⁹⁺

inputMethodEngine.getKeyboardDelegate⁹⁺

inputMethodEngine.getInputMethodEngine^(deprecated)

inputMethodEngine.createKeyboardDelegate^(deprecated)

on('inputStart')⁹⁺

off('inputStart')⁹⁺

on('inputStop')⁹⁺

off('inputStop')⁹⁺

on('setCallingWindow')⁹⁺

off('setCallingWindow')⁹⁺

on('keyboardShow'|'keyboardHide')⁹⁺

off('keyboardShow'|'keyboardHide')⁹⁺

on('setSubtype')⁹⁺

off('setSubtype')⁹⁺

createPanel¹⁰⁺

createPanel¹⁰⁺

destroyPanel¹⁰⁺

destroyPanel¹⁰⁺

Panel¹⁰⁺

setUiContent¹⁰⁺

setUiContent¹⁰⁺

setUiContent¹⁰⁺

setUiContent¹⁰⁺

resize¹⁰⁺

resize¹⁰⁺

moveTo¹⁰⁺

moveTo¹⁰⁺

show¹⁰⁺

show¹⁰⁺

hide¹⁰⁺

hide¹⁰⁺

on¹⁰⁺

off¹⁰⁺

changeFlag¹⁰⁺

hide⁹⁺

hide⁹⁺

hideKeyboard^(deprecated)

hideKeyboard^(deprecated)

InputClient⁹⁺

sendKeyFunction⁹⁺

sendKeyFunction⁹⁺

getForward⁹⁺

getForward⁹⁺

getBackward⁹⁺

getBackward⁹⁺

deleteForward⁹⁺

deleteForward⁹⁺

deleteBackward⁹⁺

deleteBackward⁹⁺

insertText⁹⁺

insertText⁹⁺

getEditorAttribute⁹⁺

getEditorAttribute⁹⁺

moveCursor⁹⁺

moveCursor⁹⁺

selectByRange¹⁰⁺

selectByRange¹⁰⁺

selectByMovement¹⁰⁺

selectByMovement¹⁰⁺

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor¹⁰⁺

PanelFlag¹⁰⁺

PanelType¹⁰⁺

PanelInfo¹⁰⁺

TextInputClient^(deprecated)

getForward^(deprecated)

getForward^(deprecated)

getBackward^(deprecated)

getBackward^(deprecated)

deleteForward^(deprecated)

deleteForward^(deprecated)

deleteBackward^(deprecated)

deleteBackward^(deprecated)

sendKeyFunction^(deprecated)

sendKeyFunction^(deprecated)

insertText^(deprecated)

insertText^(deprecated)

getEditorAttribute^(deprecated)

getEditorAttribute^(deprecated)