keyboard.constraint
Class PassOnLogicalCaretPositionAndButton

java.lang.Object
  constraint.ConstraintAdapter
      keyboard.constraint.PassOnLogicalCaretPositionAndButton

All Implemented Interfaces:

Constraint, ConstraintConstants, KeyboardConstants, SettingsConstants, StateConstants

public class PassOnLogicalCaretPositionAndButton

extends ConstraintAdapter

implements KeyboardConstants

Succeeds when the caret is in the correct position. This constraint works with the keyboard training panel. The value can contain the following tokens:

• eol - end of line, any character position that is at the end of its line of text
• bol - beginning of line, any character position that is at the beginning of its line of text
• top - top of text, any character position that is within the first line of text
• bottom - bottom of text, any character position that is within the last line of text

If more than one token is supplied, then the constraint succeeds only if all conditions are met. For example, value="bottom eol" will only succeed when the cursor is in the last character position on the bottom line. To succeed when the cursor is in the last character position, OR on the botton line, use two copies of this constraint, one for each token. Additionally, the value can contain the token Strict in the value. If the value contains Strict and the caret reaches the correct position, this constraint checks the ERROR_DETECTED variable in the task properties. If there was an error detected, the task fails. If no error was detected, or the value does not contain strict, then the task succeeds when the caret reaches the correct position.
The completion string produced by this constraint consists of the following tokens:

1. The constraint class name
2. The value of the constraint in curly braces
3. The list of failed position tokens in curly braces. For example, if the value was {top eol} but the user pressed the button when the caret was at the end of the second line, then the list of failed tokens would be {eol}.
4. the list of errors detected by other constraints

Field Summary

Fields inherited from interface keyboard.KeyboardConstants

BACK, BOTTOM, BUTTON_COLOR, BUTTON_COMMAND, BUTTON_TEXT, BUTTON_TEXT_ATTRIBUTES, BUTTON_TEXT_COLOR, BUTTON_TEXT_FONT_FACE, BUTTON_TEXT_SIZE, DELAY, DOWN, END, END_OF_LINE, ERROR_DETECTED, FINGER, FIRST, FRONT, HOME, INSTRUCTION_POSITION_TO_COORDS, KEYMAP, KEYMAP_COORDS_TO_PANEL_COORDS, LAST, LEFT, NO_BEEP, NO_DELETE, NO_ERROR, NO_WRAP, PAGE_DOWN, PAGE_UP, POSITION, PRESS, RIGHT, SPEED, START_OF_LINE, STRICT, TARGET_BACKGROUND_COLOR, TARGET_HIGHLIGHT, TARGET_HIGHLIGHT_CIRCLE_COLOR, TARGET_HIGHLIGHT_COLOR, TARGET_HIGHLIGHT_TEXT_COLOR, TARGET_POSITION_TO_COORDS, TARGET_TEXT, TARGET_TEXT_ATTRIBUTES, TARGET_TEXT_COLOR, TARGET_TEXT_FONT_FACE, TARGET_TEXT_SIZE, TOP, UP, USER_BACKGROUND_COLOR, USER_CARET, USER_CARET_BLINK_RATE, USER_CARET_COLOR, USER_CARET_HIGHLIGHT_COLOR, USER_CARET_WIDTH, USER_HIGHLIGHT, USER_HIGHLIGHT_CIRCLE_COLOR, USER_HIGHLIGHT_COLOR, USER_HIGHLIGHT_TEXT_COLOR, USER_POSITION_ABOVE, USER_POSITION_BELOW, USER_POSITION_TO_COORDS, USER_TEXT, USER_TEXT_ATTRIBUTES, USER_TEXT_COLOR, USER_TEXT_FONT_FACE, USER_TEXT_SIZE

Fields inherited from interface constraint.ConstraintConstants

ACTION_COMMAND_KEY, ACTION_TYPE_SOUND_FINISHED, COMPONENT_FINGER_POSITION, COMPONENT_FINGER_PRESS_POSITION, COMPONENT_HORIZONTAL_ARROW_POSITION, COMPONENT_INSTRUCTION_BACKGROUND_COLOR, COMPONENT_INSTRUCTION_TEXT, COMPONENT_INSTRUCTION_TEXT_ATTRIBUTES, COMPONENT_INSTRUCTION_TEXT_COLOR, COMPONENT_INSTRUCTION_TEXT_FONT_FACE, COMPONENT_INSTRUCTION_TEXT_SIZE, COMPONENT_MOUSE_FINGER_POSITION, COMPONENT_SOUND, COMPONENT_SOUND_IS_PLAYING, COMPONENT_SOUND_QUIT, COMPONENT_TIMER, COMPONENT_VERTICAL_ARROW_POSITION, DIALOG, HIDE_BULLSEYE, LESSON_STOP_ACTION, MOUSE_BULLSEYE, MOUSE_FINGER_IMAGE, NO_TOKEN, PREVIOUS_TASK_COMPLETION_REASON, PROGRESS_PANEL_VISIBLITY, SHOW_BULLSEYE, SKIP_TASK_ACTION, TAL_DIALOG, TASK_FAIL_COUNT, TASK_STATUS, TASK_SUCCEED_COUNT, YES_TOKEN

Fields inherited from interface controller.StateConstants

ACTION, ACTION_TYPE_CONTINUE, ACTION_TYPE_GOTO, ACTION_TYPE_IGNORE, ACTION_TYPE_PANIC, ACTION_TYPE_QUIT, ACTION_TYPE_RESTART, ACTION_TYPE_REVIEW, ACTION_TYPE_SKIP_DRILL, ACTION_TYPE_SKIP_SKILL, ACTION_TYPE_SKIP_TASK, ACTION_TYPE_TASK_STARTED, ACTION_TYPE_TRAIN, CALLBACK_COMMAND, FIRST_CALLBACK, FOURTH_CALLBACK, SECOND_CALLBACK, THIRD_CALLBACK

Fields inherited from interface util.SettingsConstants

ALTERNATIVE_BACKGROUND_COLOR, ALTERNATIVE_BACKGROUND_COLOR_ALIAS, ALTERNATIVE_FONT_ATTRIBUTES, ALTERNATIVE_FONT_ATTRIBUTES_ALIAS, ALTERNATIVE_FONT_COLOR, ALTERNATIVE_FONT_COLOR_ALIAS, CARET_BLINK_RATE, CARET_COLOR, CARET_WIDTH, DECORATED, DEFAULT_UI_STATE_CLASS, FONT_FACE, FONT_FACE_ALIAS, FONT_SIZE, FONT_SIZE_ALIAS, INNER_BACKGROUND_COLOR, INSTRUCTION_BACKGROUND_COLOR, INSTRUCTION_BACKGROUND_COLOR_ALIAS, INSTRUCTION_FONT_ATTRIBUTES, INSTRUCTION_FONT_ATTRIBUTES_ALIAS, INSTRUCTION_FONT_COLOR, INSTRUCTION_FONT_COLOR_ALIAS, LARGE_FONT_SIZE, LARGE_FONT_SIZE_ALIAS, LESSON_UI_STATE_CLASS, LOGGER_CLASS, LOGGER_DIRECTORY, LOGGER_PARAMS, SAVE_FILENAME, SCREEN_PERCENT, SKILL_LATTICE_FILENAME, SMALL_FONT_SIZE, SMALL_FONT_SIZE_ALIAS, STATS_FILENAME, TAL_SETTINGS_FILENAME, TITLE, TITLE_ALIAS, TITLE_ICON, TITLE_ICON_ALIAS, TRAINER_UI_STATE_CLASS, USER_ID

Constructor Summary

PassOnLogicalCaretPositionAndButton()

Method Summary

protected java.lang.String	correctCaretPosition(TaskProperties tp)
void	processActionEvent(java.awt.event.ActionEvent ev, TaskProperties tp)

Methods inherited from class constraint.ConstraintAdapter

fireAutoAction, getIntValue, getType, getValue, process, processInit, processKeyEvent, processMouseEvent, setValue, splitPairs, startAutoAction, stopAutoAction, stringToRGB, toString, valueContains

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PassOnLogicalCaretPositionAndButton

public PassOnLogicalCaretPositionAndButton()

Method Detail

correctCaretPosition

protected java.lang.String correctCaretPosition(TaskProperties tp)

processActionEvent

public void processActionEvent(java.awt.event.ActionEvent ev,
                               TaskProperties tp)

Overrides:

processActionEvent in class ConstraintAdapter