程序包 ohos.miscservices.inputmethodability

接口 KeyboardDelegate

public interface KeyboardDelegate

A delegate interface for soft keyboards, which is defined by the input method framework and needs to be implemented. This interface is used to process callbacks from the client.

You should implement this interface and register the callbacks with the input method framework by calling the InputMethodAbility#onCreateKeyboardInterface() method.

从以下版本开始:

4

SystemCapability

SystemCapability.Miscservices#INPUTMETHOD

方法概要

限定符和类型	方法	说明
void	onCursorContextChanged(float x, float y, float height)	Called when the cursor position changes.
boolean	onKeyDown(KeyEvent event)	Called when a keydown event occurs on the physical keyboard.
boolean	onKeyUp(KeyEvent event)	Called when a keyup event occurs on the physical keyboard.
void	onSelectionChanged(int oldBegin, int oldEnd, int newBegin, int newEnd)	Called when the cursor position or the selected text changes.
void	onTextChanged(int token, EditingText text)	Called when the text in the component on the client changes in full-screen mode.

方法详细资料

onKeyDown

boolean onKeyDown(KeyEvent event)

Called when a keydown event occurs on the physical keyboard.

This callback is used to respond to an input event of the physical keyboard.

参数:

event - Indicates a keydown event of the physical keyboard.

返回:

Returns true if the input method application consumes the event and terminates event transfer; returns false if the input method application passes the event to other applications no matter whether the event is consumed.

从以下版本开始:

4

onKeyUp

boolean onKeyUp(KeyEvent event)

Called when a keyup event occurs on the physical keyboard.

This callback is used to respond to an input event of the physical keyboard.

参数:

event - Indicates a keyup event of the physical keyboard.

返回:

Returns true if the input method application consumes the event and terminates event transfer; returns false if the input method application passes the event to other applications no matter whether the event is consumed.

从以下版本开始:

4

onSelectionChanged

void onSelectionChanged(int oldBegin,
                        int oldEnd,
                        int newBegin,
                        int newEnd)

Called when the cursor position or the selected text changes. The input method application can receive the change information through this callback.

This method is usually used in full-screen mode to receive the cursor information changed on the client.

参数:

oldBegin - Indicates the start index of the cursor before the selected text changes.

oldEnd - Indicates the end index of the cursor before the selected text changes.

newBegin - Indicates the start index of the cursor after the selected text changes.

newEnd - Indicates the end index of the cursor after the selected text changes.

从以下版本开始:

4

onCursorContextChanged

void onCursorContextChanged(float x,
                            float y,
                            float height)

Called when the cursor position changes. The position is updated through this callback.

This callback is used for physical keyboards. If you want to enable your application to move the candidates window with the cursor, use this callback to obtain the cursor coordinates on the screen and the cursor height.

参数:

x - Indicates the horizontal position of the cursor in the screen coordinate system.

y - Indicates the position of the cursor bottom in the screen coordinate system.

height - Indicates the cursor height. When the cursor locates at the bottom of the screen, you can use this parameter and y to calculate the position of cursor top and then draw the candidates window above the cursor.

从以下版本开始:

4

onTextChanged

void onTextChanged(int token,
                   EditingText text)

Called when the text in the component on the client changes in full-screen mode. The changed text is synchronized to the component of the input method through this callback.

This method is usually used in full-screen mode to receive text changes on the client.

参数:

token - Indicates the ID of the session.

text - Indicates the updated text.

从以下版本开始:

4