keyboard
Interface KeyboardConstants

All Known Implementing Classes:

AutoBackspace, AutoFingerFirstTargetTextError, AutoFingerFirstUserTextError, AutoFingerInstruction, AutoFingerLastTargetTextError, AutoFingerLastUserTextError, AutoFingerUserHighlight, AutoFingerUserTextCaret, AutoHighlightFirstTargetTextError, AutoHighlightFirstUserTextError, AutoHighlightLastTargetTextError, AutoHighlightLastUserTextError, AutoHighlightTargetTextError, AutoHighlightUserTextError, AutoKeymapFingerFirstError, AutoKeymapFingerLastError, AutoKeymapFingerToPosition, AutoKeymapFirstError, AutoKeymapLastError, AutoKeymapToPosition, AutoMove, AutoSelectFirstUserTextError, AutoSelectLastUserTextError, AutoType, AutoTypeTargetText, BullseyeTimer, BullseyeTimer, ChangeStateOnInboxButton, ChangeStateOnQuitButton, ChangeStateOnReaderTextVisible, ChangeStateOnReplyButton, ChangeStateOnScrollReplyButton, ChangeStateOnScrollSendButton, ChangeStateOnScrollText, ChangeStateOnSendButton, ChangeStateOnText, ChangeStateOnWriteButton, EasyChangeStateOnScrollReplyButton, FailOnAllTyping, FailOnError, FailOnKeyPress, HideButton, HideKeymap, HideTargetText, HideUserText, KeyboardTrainingPanel, PassOnButton, PassOnCaretChangePosition, PassOnCaretPosition, PassOnCaretPositionAndButton, PassOnCaretRange, PassOnErase, PassOnLogicalCaretPosition, PassOnLogicalCaretPositionAndButton, PassOnLooseText, PassOnLooseTextAndButton, PassOnPositionAndTimer, PassOnQuitAndState, PassOnSameText, PassOnSameTextAndButton, PassOnSameTextAndTimer, PassOnSendAndThisText, PassOnSendAndWords, PassOnSomeTextAndTimer, PassOnThisText, SetButtonFont, SetComposerText, SetReaderText, SetTargetCircleColor, SetTargetFont, SetTargetHighlightColor, SetTargetHighlightTextColor, SetTargetText, SetTargetTextHighlight, SetUserCaretBlinkRate, SetUserCaretColor, SetUserCaretWidth, SetUserCircleColor, SetUserFont, SetUserHighlightColor, SetUserHighlightTextColor, SetUserSelectionColor, SetUserText, SetUserTextCaret, SetUserTextHighlight, SetUserTextHighlightBackspace, SetUserTextLogicalCaret, SetUserTextLogicalHighlight, ShowAllMovement, ShowAllTyping, ShowButton, ShowCorrectTyping, ShowCorrectTypingAndBeepForSomeReason, ShowKeymap, ShowKeymapFinger, ShowTargetTextFinger, ShowUserTextFinger, SucceedOnAutowrap, SucceedOnMultiwrap, TalPanel

public interface KeyboardConstants

Field Summary

static java.lang.String	BACK Token used in constraint values.
static java.lang.String	BOTTOM Token used in constraint values.
static java.lang.String	BUTTON_COLOR The TaskProperties key for color of the button.
static java.lang.String	BUTTON_COMMAND The action command generated when the button is clicked.
static java.lang.String	BUTTON_TEXT The TaskProperties key for text to appear on the button.
static java.lang.String	BUTTON_TEXT_ATTRIBUTES The TaskProperties key for font style for the button.
static java.lang.String	BUTTON_TEXT_COLOR The TaskProperties key for font color for the button.
static java.lang.String	BUTTON_TEXT_FONT_FACE The TaskProperties key for font name for the button.
static java.lang.String	BUTTON_TEXT_SIZE The TaskProperties key for font size for the button.
static java.lang.String	DELAY Token used in constraint values.
static java.lang.String	DOWN Token used in constraint values.
static java.lang.String	END Token used in constraint values.
static java.lang.String	END_OF_LINE Token used in constraint values.
static java.lang.String	ERROR_DETECTED Task properties key for errors detected while typing or editing is in progress.
static java.lang.String	FINGER Token used in constraint values.
static java.lang.String	FIRST Token used in constraint values.
static java.lang.String	FRONT Token used in constraint values.
static java.lang.String	HOME Token used in constraint values.
static java.lang.String	INSTRUCTION_POSITION_TO_COORDS
static java.lang.String	KEYMAP The TaskProperties key for the current keymap.
static java.lang.String	KEYMAP_COORDS_TO_PANEL_COORDS The TaskProperties key for converting keymap coordinates to keyboard training panel coordinates.
static java.lang.String	LAST Token used in constraint values.
static java.lang.String	LEFT Token used in constraint values.
static java.lang.String	NO_BEEP Token used in constraint values.
static java.lang.String	NO_DELETE Token used in constraint values.
static java.lang.String	NO_ERROR Token used in constraint values.
static java.lang.String	NO_WRAP Token used in constraint values.
static java.lang.String	PAGE_DOWN Token used in constraint values.
static java.lang.String	PAGE_UP Token used in constraint values.
static java.lang.String	POSITION Token used in constraint values.
static java.lang.String	PRESS Token used in constraint values.
static java.lang.String	RIGHT Token used in constraint values.
static java.lang.String	SPEED Token used in constraint values.
static java.lang.String	START_OF_LINE Token used in constraint values.
static java.lang.String	STRICT Value Token used by PassOn constraints.
static java.lang.String	TARGET_BACKGROUND_COLOR The TaskProperties key for background color for the target text field.
static java.lang.String	TARGET_HIGHLIGHT The TaskProperties key for text to highlight in the target text field.
static java.lang.String	TARGET_HIGHLIGHT_CIRCLE_COLOR The TaskProperties key for highlight color for the target text field.
static java.lang.String	TARGET_HIGHLIGHT_COLOR The TaskProperties key for highlight color for the target text field.
static java.lang.String	TARGET_HIGHLIGHT_TEXT_COLOR The TaskProperties key for color of highlighted text in the target text field.
static java.lang.String	TARGET_POSITION_TO_COORDS The TaskProperties key converting a character position in the user text to coordinates in the keyboard training panel.
static java.lang.String	TARGET_TEXT The TaskProperties key for text in the target text field.
static java.lang.String	TARGET_TEXT_ATTRIBUTES The TaskProperties key for font style for the target text field.
static java.lang.String	TARGET_TEXT_COLOR The TaskProperties key for font color for the target text field.
static java.lang.String	TARGET_TEXT_FONT_FACE The TaskProperties key for font name for the target text field.
static java.lang.String	TARGET_TEXT_SIZE The TaskProperties key for font size for the target text field.
static java.lang.String	TOP Token used in constraint values.
static java.lang.String	UP Token used in constraint values.
static java.lang.String	USER_BACKGROUND_COLOR The TaskProperties key for background color for the user text field.
static java.lang.String	USER_CARET The TaskProperties key for cursor location in the user text field.
static java.lang.String	USER_CARET_BLINK_RATE The TaskProperties key for caret color for the user text field.
static java.lang.String	USER_CARET_COLOR The TaskProperties key for caret color for the user text field.
static java.lang.String	USER_CARET_HIGHLIGHT_COLOR The TaskProperties key for caret highlight color for the user text field.
static java.lang.String	USER_CARET_WIDTH The TaskProperties key for caret color for the user text field.
static java.lang.String	USER_HIGHLIGHT The TaskProperties key for text to highlight in the target text field.
static java.lang.String	USER_HIGHLIGHT_CIRCLE_COLOR The TaskProperties key for highlight color for the target text field.
static java.lang.String	USER_HIGHLIGHT_COLOR The TaskProperties key for highlight color for the target text field.
static java.lang.String	USER_HIGHLIGHT_TEXT_COLOR The TaskProperties key for color of highlighted text in the target text field.
static java.lang.String	USER_POSITION_ABOVE Task properites key for converting a position in the user text to the text postion above it.
static java.lang.String	USER_POSITION_BELOW Task properites key for converting a position in the user text to the text postion below it.
static java.lang.String	USER_POSITION_TO_COORDS The TaskProperties key converting a character position in the user text to coordinates in the keyboard training panel.
static java.lang.String	USER_TEXT The TaskProperties key for text in the user text field.
static java.lang.String	USER_TEXT_ATTRIBUTES The TaskProperties key for font style for the user text field.
static java.lang.String	USER_TEXT_COLOR The TaskProperties key for font color for the user text field.
static java.lang.String	USER_TEXT_FONT_FACE The TaskProperties key for font name for the user text field.
static java.lang.String	USER_TEXT_SIZE The TaskProperties key for font size for the user text field.

Field Detail

STRICT

public static final java.lang.String STRICT

Value Token used by PassOn constraints.

See Also:

Constant Field Values

ERROR_DETECTED

public static final java.lang.String ERROR_DETECTED

Task properties key for errors detected while typing or editing is in progress.

See Also:

Constant Field Values

USER_POSITION_ABOVE

public static final java.lang.String USER_POSITION_ABOVE

Task properites key for converting a position in the user text to the text postion above it.

See Also:

Constant Field Values

USER_POSITION_BELOW

public static final java.lang.String USER_POSITION_BELOW

Task properites key for converting a position in the user text to the text postion below it.

See Also:

Constant Field Values

USER_POSITION_TO_COORDS

public static final java.lang.String USER_POSITION_TO_COORDS

The TaskProperties key converting a character position in the user text to coordinates in the keyboard training panel. Use coords = TrainingPanel.parseCoords(taskProperties.get(USER_COORDS_FOR_POSITION + position)) where position is a character position and coords is an int[] variable. If position is greater than the maximum character value or position is less than zero, then (-1,-1) is returned.

See Also:

Constant Field Values

INSTRUCTION_POSITION_TO_COORDS

public static final java.lang.String INSTRUCTION_POSITION_TO_COORDS

See Also:

Constant Field Values

TARGET_POSITION_TO_COORDS

public static final java.lang.String TARGET_POSITION_TO_COORDS

The TaskProperties key converting a character position in the user text to coordinates in the keyboard training panel. Use coords = TrainingPanel.parseCoords(taskProperties.get(USER_COORDS_FOR_POSITION + position)) where position is a character position and coords is an int[] variable. If position is greater than the maximum character value or position is less than zero, then (-1,-1) is returned.

See Also:

Constant Field Values

KEYMAP_COORDS_TO_PANEL_COORDS

public static final java.lang.String KEYMAP_COORDS_TO_PANEL_COORDS

The TaskProperties key for converting keymap coordinates to keyboard training panel coordinates.

See Also:

Constant Field Values

TARGET_BACKGROUND_COLOR

public static final java.lang.String TARGET_BACKGROUND_COLOR

The TaskProperties key for background color for the target text field.

See Also:

Constant Field Values

TARGET_TEXT

public static final java.lang.String TARGET_TEXT

The TaskProperties key for text in the target text field. A null value will cause the target text area to become hidden.

See Also:

Constant Field Values

TARGET_TEXT_ATTRIBUTES

public static final java.lang.String TARGET_TEXT_ATTRIBUTES

The TaskProperties key for font style for the target text field.

See Also:

Constant Field Values

TARGET_TEXT_COLOR

public static final java.lang.String TARGET_TEXT_COLOR

The TaskProperties key for font color for the target text field.

See Also:

Constant Field Values

TARGET_TEXT_FONT_FACE

public static final java.lang.String TARGET_TEXT_FONT_FACE

The TaskProperties key for font name for the target text field.

See Also:

Constant Field Values

TARGET_TEXT_SIZE

public static final java.lang.String TARGET_TEXT_SIZE

The TaskProperties key for font size for the target text field.

See Also:

Constant Field Values

TARGET_HIGHLIGHT_COLOR

public static final java.lang.String TARGET_HIGHLIGHT_COLOR

The TaskProperties key for highlight color for the target text field.

See Also:

Constant Field Values

TARGET_HIGHLIGHT_TEXT_COLOR

public static final java.lang.String TARGET_HIGHLIGHT_TEXT_COLOR

The TaskProperties key for color of highlighted text in the target text field.

See Also:

Constant Field Values

TARGET_HIGHLIGHT_CIRCLE_COLOR

public static final java.lang.String TARGET_HIGHLIGHT_CIRCLE_COLOR

The TaskProperties key for highlight color for the target text field.

See Also:

Constant Field Values

TARGET_HIGHLIGHT

public static final java.lang.String TARGET_HIGHLIGHT

The TaskProperties key for text to highlight in the target text field. To highlight a single character, give the location of that character. To highlight a group of characters, give the location of the first character, a space and the location of the second character.

See Also:

Constant Field Values

USER_BACKGROUND_COLOR

public static final java.lang.String USER_BACKGROUND_COLOR

The TaskProperties key for background color for the user text field.

See Also:

Constant Field Values

USER_TEXT

public static final java.lang.String USER_TEXT

The TaskProperties key for text in the user text field. A null value will cause the user text area to become hidden.

See Also:

Constant Field Values

USER_TEXT_ATTRIBUTES

public static final java.lang.String USER_TEXT_ATTRIBUTES

The TaskProperties key for font style for the user text field.

See Also:

Constant Field Values

USER_TEXT_COLOR

public static final java.lang.String USER_TEXT_COLOR

The TaskProperties key for font color for the user text field.

See Also:

Constant Field Values

USER_TEXT_FONT_FACE

public static final java.lang.String USER_TEXT_FONT_FACE

The TaskProperties key for font name for the user text field.

See Also:

Constant Field Values

USER_TEXT_SIZE

public static final java.lang.String USER_TEXT_SIZE

The TaskProperties key for font size for the user text field.

See Also:

Constant Field Values

USER_CARET_COLOR

public static final java.lang.String USER_CARET_COLOR

The TaskProperties key for caret color for the user text field.

See Also:

Constant Field Values

USER_CARET_HIGHLIGHT_COLOR

public static final java.lang.String USER_CARET_HIGHLIGHT_COLOR

The TaskProperties key for caret highlight color for the user text field.

See Also:

Constant Field Values

USER_CARET_WIDTH

public static final java.lang.String USER_CARET_WIDTH

The TaskProperties key for caret color for the user text field.

See Also:

Constant Field Values

USER_CARET_BLINK_RATE

public static final java.lang.String USER_CARET_BLINK_RATE

The TaskProperties key for caret color for the user text field.

See Also:

Constant Field Values

USER_HIGHLIGHT_COLOR

public static final java.lang.String USER_HIGHLIGHT_COLOR

The TaskProperties key for highlight color for the target text field.

See Also:

Constant Field Values

USER_HIGHLIGHT_TEXT_COLOR

public static final java.lang.String USER_HIGHLIGHT_TEXT_COLOR

The TaskProperties key for color of highlighted text in the target text field.

See Also:

Constant Field Values

USER_HIGHLIGHT_CIRCLE_COLOR

public static final java.lang.String USER_HIGHLIGHT_CIRCLE_COLOR

The TaskProperties key for highlight color for the target text field.

See Also:

Constant Field Values

USER_HIGHLIGHT

public static final java.lang.String USER_HIGHLIGHT

The TaskProperties key for text to highlight in the target text field. To highlight a single character, give the location of that character. To highlight a group of characters, give the location of the first character, a space and the location of the second character.

See Also:

Constant Field Values

USER_CARET

public static final java.lang.String USER_CARET

The TaskProperties key for cursor location in the user text field. To place the cursor without creating a selection, give the location of the cursor. To highlight a group of characters, give the location of the first character, a space and the location of the second character. The cursor will be placed at the last index listed.

See Also:

Constant Field Values

BUTTON_COLOR

public static final java.lang.String BUTTON_COLOR

The TaskProperties key for color of the button.

See Also:

Constant Field Values

BUTTON_TEXT

public static final java.lang.String BUTTON_TEXT

The TaskProperties key for text to appear on the button. A null value will cause the button to become hidden.

See Also:

Constant Field Values

BUTTON_TEXT_ATTRIBUTES

public static final java.lang.String BUTTON_TEXT_ATTRIBUTES

The TaskProperties key for font style for the button.

See Also:

Constant Field Values

BUTTON_TEXT_COLOR

public static final java.lang.String BUTTON_TEXT_COLOR

The TaskProperties key for font color for the button.

See Also:

Constant Field Values

BUTTON_TEXT_FONT_FACE

public static final java.lang.String BUTTON_TEXT_FONT_FACE

The TaskProperties key for font name for the button.

See Also:

Constant Field Values

BUTTON_TEXT_SIZE

public static final java.lang.String BUTTON_TEXT_SIZE

The TaskProperties key for font size for the button.

See Also:

Constant Field Values

BUTTON_COMMAND

public static final java.lang.String BUTTON_COMMAND

The action command generated when the button is clicked.

See Also:

Constant Field Values

KEYMAP

public static final java.lang.String KEYMAP

The TaskProperties key for the current keymap. This should either be set to an integer value from KeymapPanel, a single character, the empty string, or null. The empty string will cause the the keymap to be displayed without indicating a specific key. The null string will cause the keymap to become hidden.

See Also:

Constant Field Values

NO_BEEP

public static final java.lang.String NO_BEEP

Token used in constraint values.

See Also:

Constant Field Values

NO_WRAP

public static final java.lang.String NO_WRAP

Token used in constraint values.

See Also:

Constant Field Values

NO_ERROR

public static final java.lang.String NO_ERROR

Token used in constraint values.

See Also:

Constant Field Values

NO_DELETE

public static final java.lang.String NO_DELETE

Token used in constraint values.

See Also:

Constant Field Values

UP

public static final java.lang.String UP

Token used in constraint values.

See Also:

Constant Field Values

DOWN

public static final java.lang.String DOWN

Token used in constraint values.

See Also:

Constant Field Values

RIGHT

public static final java.lang.String RIGHT

Token used in constraint values.

See Also:

Constant Field Values

LEFT

public static final java.lang.String LEFT

Token used in constraint values.

See Also:

Constant Field Values

PAGE_UP

public static final java.lang.String PAGE_UP

Token used in constraint values.

See Also:

Constant Field Values

PAGE_DOWN

public static final java.lang.String PAGE_DOWN

Token used in constraint values.

See Also:

Constant Field Values

HOME

public static final java.lang.String HOME

Token used in constraint values.

See Also:

Constant Field Values

END

public static final java.lang.String END

Token used in constraint values.

See Also:

Constant Field Values

END_OF_LINE

public static final java.lang.String END_OF_LINE

Token used in constraint values.

See Also:

Constant Field Values

START_OF_LINE

public static final java.lang.String START_OF_LINE

Token used in constraint values.

See Also:

Constant Field Values

TOP

public static final java.lang.String TOP

Token used in constraint values.

See Also:

Constant Field Values

BOTTOM

public static final java.lang.String BOTTOM

Token used in constraint values.

See Also:

Constant Field Values

FIRST

public static final java.lang.String FIRST

Token used in constraint values.

See Also:

Constant Field Values

LAST

public static final java.lang.String LAST

Token used in constraint values.

See Also:

Constant Field Values

FRONT

public static final java.lang.String FRONT

Token used in constraint values.

See Also:

Constant Field Values

BACK

public static final java.lang.String BACK

Token used in constraint values.

See Also:

Constant Field Values

DELAY

public static final java.lang.String DELAY

Token used in constraint values.

See Also:

Constant Field Values

SPEED

public static final java.lang.String SPEED

Token used in constraint values.

See Also:

Constant Field Values

POSITION

public static final java.lang.String POSITION

Token used in constraint values.

See Also:

Constant Field Values

FINGER

public static final java.lang.String FINGER

Token used in constraint values.

See Also:

Constant Field Values

PRESS

public static final java.lang.String PRESS

Token used in constraint values.

See Also:

Constant Field Values