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

Interface KeyboardInputFactory

public interface KeyboardInputFactory

Factory for creating keyboard inputs which are used to configure the virtual keyboard/keypad and to request it to be displayed for a Swing GUI component. The typical Swing component most commonly used is a JTextField.

NOTE: This functionality is only relevant for URCap nodes with a Swing-based user interface (see SwingProgramNodeService, SwingInstallationNodeService and SwingToolbarService).

Method Summary

Modifier and Type	Method and Description
KeyboardNumberInput<Double>	createDoubleKeypadInput() Creates a virtual numeric keypad input accepting doubles
KeyboardNumberInput<Integer>	createIntegerKeypadInput() Creates a virtual numeric keypad input accepting integers.
KeyboardTextInput	createIPAddressKeyboardInput() Creates a virtual keyboard input accepting IPv4 addresses.
KeyboardTextInput	createPasswordKeyboardInput() Creates a standard virtual keyboard input accepting password string/text input.
KeyboardNumberInput<Double>	createPositiveDoubleKeypadInput() Creates a virtual numeric keypad input accepting positive doubles.
KeyboardNumberInput<Integer>	createPositiveIntegerKeypadInput() Creates a virtual numeric keypad input accepting positive integers.
KeyboardTextInput	createStringKeyboardInput() Creates a standard virtual keyboard input accepting string/text input

Method Detail

createStringKeyboardInput

KeyboardTextInput createStringKeyboardInput()

Creates a standard virtual keyboard input accepting string/text input

If no input validator is specified, all strings are accepted.

Returns:

new instance of KeyboardTextInput.

createPasswordKeyboardInput

KeyboardTextInput createPasswordKeyboardInput()

Creates a standard virtual keyboard input accepting password string/text input. When the end user types, asterisks are shown instead of the original characters.

If no input validator is specified, all strings are accepted.

Returns:

new instance of KeyboardTextInput.

createIPAddressKeyboardInput

KeyboardTextInput createIPAddressKeyboardInput()

Creates a virtual keyboard input accepting IPv4 addresses. The keyboards accepts any IPv4 address (ensuring the correct format) and returns it as a string.

Returns:

new instance of KeyboardTextInput.

createDoubleKeypadInput

KeyboardNumberInput<Double> createDoubleKeypadInput()

Creates a virtual numeric keypad input accepting doubles

If no input validator is specified, all double values are accepted.

Returns:

new instance of KeyboardNumberInput<Double>.

createPositiveDoubleKeypadInput

KeyboardNumberInput<Double> createPositiveDoubleKeypadInput()

Creates a virtual numeric keypad input accepting positive doubles. The minus ('-') button on the keypad will be disabled.

If no input validator is specified, all positive double values are accepted.

Returns:

new instance of KeyboardNumberInput<Double>

createIntegerKeypadInput

KeyboardNumberInput<Integer> createIntegerKeypadInput()

Creates a virtual numeric keypad input accepting integers. The dot ('.') button on the keypad will be disabled.

If no input validator is specified, all integer values are accepted.

Returns:

new instance of KeyboardNumberInput<Integer>.

createPositiveIntegerKeypadInput

KeyboardNumberInput<Integer> createPositiveIntegerKeypadInput()

Creates a virtual numeric keypad input accepting positive integers. The minus ('-') and the dot ('.') buttons on the keypad will be disabled.

If no input validator is specified, all positive integer values are accepted.

Returns:

new instance of KeyboardNumberInput<Integer>.