com.smartdevicelink.managers.screen.choiceset

Interface KeyboardListener

public interface KeyboardListener

Method Summary

Modifier and Type	Method and Description
void	onKeyboardDidAbortWithReason(KeyboardEvent event) The keyboard session aborted.
void	onKeyboardDidSendEvent(KeyboardEvent event, String currentInputText) Implement this to be notified of all events occurring on the keyboard
void	onKeyboardDidUpdateInputMask(KeyboardEvent event)
void	onUserDidSubmitInput(String inputText, KeyboardEvent event) The keyboard session completed with some input.
void	updateAutocompleteWithInput(String currentInputText, KeyboardAutocompleteCompletionListener keyboardAutocompleteCompletionListener) Implement this in order to provide a custom keyboard configuration to just this keyboard.
void	updateCharacterSetWithInput(String currentInputText, KeyboardCharacterSetCompletionListener keyboardCharacterSetCompletionListener) Implement this if you wish to update the limitedCharacterSet as the user updates their input.

Method Detail

onUserDidSubmitInput

void onUserDidSubmitInput(String inputText,
                          KeyboardEvent event)

The keyboard session completed with some input.

This will be sent upon ENTRY_SUBMITTED or ENTRY_VOICE. If the event is ENTRY_VOICE, the user requested to start a voice session in order to submit input to this keyboard. This MUST be handled by you. Start an Audio Pass Thru session if supported.

Parameters:

inputText - - The submitted input text on the keyboard

event - - ENTRY_SUBMITTED if the user pressed the submit button on the keyboard, ENTRY_VOICE if the user requested that a voice session begin

onKeyboardDidAbortWithReason

void onKeyboardDidAbortWithReason(KeyboardEvent event)

The keyboard session aborted.

This will be sent if the keyboard event ENTRY_CANCELLED or ENTRY_ABORTED is sent

Parameters:

event - - ENTRY_CANCELLED if the user cancelled the keyboard input, or ENTRY_ABORTED if the system aborted the input due to a higher priority event

updateAutocompleteWithInput

void updateAutocompleteWithInput(String currentInputText,
                                 KeyboardAutocompleteCompletionListener keyboardAutocompleteCompletionListener)

Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see SDLScreenManager.keyboardConfiguration

Parameters:

currentInputText - - The user's full current input text

keyboardAutocompleteCompletionListener - - A listener to update the autoCompleteText

updateCharacterSetWithInput

void updateCharacterSetWithInput(String currentInputText,
                                 KeyboardCharacterSetCompletionListener keyboardCharacterSetCompletionListener)

Implement this if you wish to update the limitedCharacterSet as the user updates their input. This is called upon a KEYPRESS event.

Parameters:

currentInputText - - The user's full current input text

keyboardCharacterSetCompletionListener - - A listener to update the limitedCharacterSet

onKeyboardDidSendEvent

void onKeyboardDidSendEvent(KeyboardEvent event,
                            String currentInputText)

Implement this to be notified of all events occurring on the keyboard

Parameters:

event - - The event that occurred

currentInputText - - The user's full current input text

onKeyboardDidUpdateInputMask

void onKeyboardDidUpdateInputMask(KeyboardEvent event)