com.ur.urcap.api.domain.userinteraction.keyboard

Interface KeyboardTextInput

public interface KeyboardTextInput

Interface representing the virtual keyboard used for configuring it and requesting it to be displayed in PolyScope.

Method Summary

Modifier and Type	Method and Description
KeyboardTextInput	setErrorValidator(InputValidator<String> validator) Sets an input validator for the virtual keyboard.
KeyboardTextInput	setInitialValue(String initialText) Sets the text which will be displayed when the virtual keyboard is shown.
void	show(JButton component, KeyboardInputCallback<String> callback) This method requests the virtual keypad to be shown
void	show(JLabel component, KeyboardInputCallback<String> callback) This method requests the virtual keypad to be shown
void	show(JTextField component, KeyboardInputCallback<String> callback) This method requests the virtual keyboard to be shown

Method Detail

setErrorValidator

KeyboardTextInput setErrorValidator(InputValidator<String> validator)

Sets an input validator for the virtual keyboard. This validator will be used to validate the input entered by the user. Some standard validators are available in InputValidationFactory. Specifying an input validator is recommended, but optional.

In case InputValidator.isValid(Object) (in this case parameter is String) returns false, the accept button on the virtual keyboard will be disabled and the error message from InputValidator.getMessage(Object) (parameter is String) will be shown.

Parameters:

validator - the validator to be used to validate keyboard user input.

Returns:

this KeyboardTextInput object

Throws:

NullPointerException - in case the validator is null

setInitialValue

KeyboardTextInput setInitialValue(String initialText)

Sets the text which will be displayed when the virtual keyboard is shown.

Parameters:

initialText - the initial text for the virtual keyboard

Returns:

this KeyboardTextInput object

show

void show(JTextField component,
          KeyboardInputCallback<String> callback)

This method requests the virtual keyboard to be shown

Parameters:

component - the JTextField that will be used to define the screen position of the virtual keyboard

callback - the callback to be used when the user exits the keyboard by accepting or canceling the input.

Throws:

NullPointerException - in case any parameter is null

show

void show(JLabel component,
          KeyboardInputCallback<String> callback)

This method requests the virtual keypad to be shown

Parameters:

component - the JLabel that will be used to define the screen position of the virtual keyboard

callback - the callback to be used when the user exits the keyboard by accepting or canceling the input.

Throws:

NullPointerException - in case any parameter is null

show

void show(JButton component,
          KeyboardInputCallback<String> callback)

This method requests the virtual keypad to be shown

Parameters:

component - the JButton that will be used to define the screen position of the virtual keyboard

callback - the callback to be used when the user exits the keyboard by accepting or canceling the input.

Throws:

NullPointerException - in case any parameter is null