constraint
Interface ConstraintConstants

All Known Implementing Classes:

ConstraintAdapter, InitialQuestionConstraint, IntroPanel, KeyboardTrainingPanel, LayeredConstraint, MediaPanel, MouseModelClickingPanel, MouseModelMovingPanel, MouseTrainingPanel, PassElseFailOnPreviousCompletionPeriod, PassElseFailOnPreviousCompletionReason, PassElseFailOnPreviousCompletionSpace, PauseOnFailure, PauseOnSuccess, PictureReader, ReaderComposer, SetInstruction, SetSound, SoundPanel, SucceedOnSoundFinished, TalInbox, TalPanel, TOCPanel, TOCPanel2, TOCTopPanel, TOCTreePanel, TOCTreeState.TOCTreeConstraint, TrainerConstraint, TrainingPanel, WaitOnSound

public interface ConstraintConstants

Field Summary

static java.lang.String	ACTION_COMMAND_KEY Task properties key that fires an action event.
static java.lang.String	ACTION_TYPE_SOUND_FINISHED action key for signifying that the media has finished playing.
static java.lang.String	COMPONENT_FINGER_POSITION The TaskProperties key for position of finger.
static java.lang.String	COMPONENT_FINGER_PRESS_POSITION The TaskProperties key for position of finger pressing.
static java.lang.String	COMPONENT_HORIZONTAL_ARROW_POSITION The TaskProperties key for position of arrow.
static java.lang.String	COMPONENT_INSTRUCTION_BACKGROUND_COLOR The instruction text background color.
static java.lang.String	COMPONENT_INSTRUCTION_TEXT The instruction text to show.
static java.lang.String	COMPONENT_INSTRUCTION_TEXT_ATTRIBUTES The instruction text attrbitues.
static java.lang.String	COMPONENT_INSTRUCTION_TEXT_COLOR The instruction text foreground color.
static java.lang.String	COMPONENT_INSTRUCTION_TEXT_FONT_FACE The instruction text attrbitues.
static java.lang.String	COMPONENT_INSTRUCTION_TEXT_SIZE The instruction text size.
static java.lang.String	COMPONENT_MOUSE_FINGER_POSITION The TaskProperties key for position of mouse-finger image.
static java.lang.String	COMPONENT_SOUND key for the sound filename.
static java.lang.String	COMPONENT_SOUND_IS_PLAYING key for the checking if media currently playing.
static java.lang.String	COMPONENT_SOUND_QUIT key for the forcing a quit.
static java.lang.String	COMPONENT_TIMER Task properties key that returns the amount of time since the task properties object was created.
static java.lang.String	COMPONENT_VERTICAL_ARROW_POSITION The TaskProperties key for position of arrow.
static java.lang.String	DIALOG The TaskProperties key for displaying the fake tal dialog
static java.lang.String	HIDE_BULLSEYE The TaskProperties key for hiding the bullseye.
static java.lang.String	LESSON_STOP_ACTION Action command that stops the lesson.
static java.lang.String	MOUSE_BULLSEYE The TaskProperties key for showing the bullseye.
static java.lang.String	MOUSE_FINGER_IMAGE The TaskProperties key for position of mouse-finger image.
static java.lang.String	NO_TOKEN Token used in constraint values.
static java.lang.String	PREVIOUS_TASK_COMPLETION_REASON The reason why the previous task failed or succeeded.
static java.lang.String	PROGRESS_PANEL_VISIBLITY key for the checking if the progress bar should be displayed.
static java.lang.String	SHOW_BULLSEYE The TaskProperties key for showing the bullseye.
static java.lang.String	SKIP_TASK_ACTION Action command fired to skip the current task and replace it with an equivalent one.
static java.lang.String	TAL_DIALOG The TaskProperties key for displaying the fake tal dialog
static java.lang.String	TASK_FAIL_COUNT The number of mis-steps made by the user in the currently executing task.
static java.lang.String	TASK_STATUS The status of the currently executing task.
static java.lang.String	TASK_SUCCEED_COUNT The number of correct steps made by the user in the currently executing task.
static java.lang.String	YES_TOKEN Token used in constraint values.

Field Detail

COMPONENT_INSTRUCTION_TEXT

public static final java.lang.String COMPONENT_INSTRUCTION_TEXT

The instruction text to show.

See Also:

Constant Field Values

COMPONENT_INSTRUCTION_TEXT_FONT_FACE

public static final java.lang.String COMPONENT_INSTRUCTION_TEXT_FONT_FACE

The instruction text attrbitues. This should be a number between 0 and 3 that represents the font attributes. Assuming tp has type TaskProperties, and f has type Font, you would set the value with
tp.put(COMPONENT_INSTRUCTION_TEXT_FONT_FACE, f.getFontName())
and get the value with
f = new Font(tp.get(COMPONENT_INSTRUCTION_TEXT_FONT_FACE), attr, size)

See Also:

Constant Field Values

COMPONENT_INSTRUCTION_TEXT_ATTRIBUTES

public static final java.lang.String COMPONENT_INSTRUCTION_TEXT_ATTRIBUTES

The instruction text attrbitues. This should be a number between 0 and 3 that represents the font attributes. Assuming tp has type TaskProperties, and f has type Font, you would set the value with
tp.put(COMPONENT_INSTRUCTION_TEXT_ATTRIBUTES, f.getStyle())
and get the value with
f = new Font(face, tp.getInt(COMPONENT_INSTRUCTION_TEXT_ATTRIBUTES), size)

See Also:

Constant Field Values

COMPONENT_INSTRUCTION_TEXT_SIZE

public static final java.lang.String COMPONENT_INSTRUCTION_TEXT_SIZE

The instruction text size. This should be the point size of the font. Assuming tp has type TaskProperties, and f has type Font, you would set the value with
tp.put(COMPONENT_INSTRUCTION_TEXT_SIZE, f.getSize())
and get the value with
f = new Font(face, attr, tp.getInt(COMPONENT_INSTRUCTION_TEXT_SIZE))

See Also:

Constant Field Values

COMPONENT_INSTRUCTION_TEXT_COLOR

public static final java.lang.String COMPONENT_INSTRUCTION_TEXT_COLOR

The instruction text foreground color. Assuming tp has type TaskProperties, and c has type Color, you would set the value with
tp.put(COMPONENT_INSTRUCTION_TEXT_COLOR, c.getRGB())
and get the value with
c = Color.decode(tp.get(COMPONENT_INSTRUCTION_TEXT_COLOR));

See Also:

Constant Field Values

COMPONENT_INSTRUCTION_BACKGROUND_COLOR

public static final java.lang.String COMPONENT_INSTRUCTION_BACKGROUND_COLOR

The instruction text background color. Assuming tp has type TaskProperties, and c has type Color, you would set the value with
tp.put(COMPONENT_INSTRUCTION_BACKGROUND_COLOR , c.getRGB())
and get the value with
c = Color.decode(tp.get(COMPONENT_INSTRUCTION_BACKGROUND_COLOR));

See Also:

Constant Field Values

SKIP_TASK_ACTION

public static final java.lang.String SKIP_TASK_ACTION

Action command fired to skip the current task and replace it with an equivalent one. In general, training components are required to have a control that fires this action.

See Also:

Constant Field Values

ACTION_COMMAND_KEY

public static final java.lang.String ACTION_COMMAND_KEY

Task properties key that fires an action event. When a value is put to a task properties object using this key, an action event is fired with the action command set to the value being put. The task properties get method returns null when it is called with this key.

See Also:

Constant Field Values

COMPONENT_TIMER

public static final java.lang.String COMPONENT_TIMER

Task properties key that returns the amount of time since the task properties object was created.

See Also:

Constant Field Values

ACTION_TYPE_SOUND_FINISHED

public static final java.lang.String ACTION_TYPE_SOUND_FINISHED

action key for signifying that the media has finished playing.

See Also:

Constant Field Values

COMPONENT_SOUND

public static final java.lang.String COMPONENT_SOUND

key for the sound filename.

See Also:

Constant Field Values

COMPONENT_SOUND_QUIT

public static final java.lang.String COMPONENT_SOUND_QUIT

key for the forcing a quit.

See Also:

Constant Field Values

COMPONENT_SOUND_IS_PLAYING

public static final java.lang.String COMPONENT_SOUND_IS_PLAYING

key for the checking if media currently playing.

See Also:

Constant Field Values

PROGRESS_PANEL_VISIBLITY

public static final java.lang.String PROGRESS_PANEL_VISIBLITY

key for the checking if the progress bar should be displayed.

See Also:

Constant Field Values

COMPONENT_FINGER_POSITION

public static final java.lang.String COMPONENT_FINGER_POSITION

The TaskProperties key for position of finger.

See Also:

Constant Field Values

COMPONENT_MOUSE_FINGER_POSITION

public static final java.lang.String COMPONENT_MOUSE_FINGER_POSITION

The TaskProperties key for position of mouse-finger image.

See Also:

Constant Field Values

SHOW_BULLSEYE

public static final java.lang.String SHOW_BULLSEYE

The TaskProperties key for showing the bullseye.

See Also:

Constant Field Values

MOUSE_BULLSEYE

public static final java.lang.String MOUSE_BULLSEYE

The TaskProperties key for showing the bullseye.

See Also:

Constant Field Values

HIDE_BULLSEYE

public static final java.lang.String HIDE_BULLSEYE

The TaskProperties key for hiding the bullseye.

See Also:

Constant Field Values

MOUSE_FINGER_IMAGE

public static final java.lang.String MOUSE_FINGER_IMAGE

The TaskProperties key for position of mouse-finger image.

See Also:

Constant Field Values

TAL_DIALOG

public static final java.lang.String TAL_DIALOG

The TaskProperties key for displaying the fake tal dialog

See Also:

Constant Field Values

DIALOG

public static final java.lang.String DIALOG

The TaskProperties key for displaying the fake tal dialog

See Also:

Constant Field Values

COMPONENT_FINGER_PRESS_POSITION

public static final java.lang.String COMPONENT_FINGER_PRESS_POSITION

The TaskProperties key for position of finger pressing.

See Also:

Constant Field Values

COMPONENT_HORIZONTAL_ARROW_POSITION

public static final java.lang.String COMPONENT_HORIZONTAL_ARROW_POSITION

The TaskProperties key for position of arrow.

See Also:

Constant Field Values

COMPONENT_VERTICAL_ARROW_POSITION

public static final java.lang.String COMPONENT_VERTICAL_ARROW_POSITION

The TaskProperties key for position of arrow.

See Also:

Constant Field Values

LESSON_STOP_ACTION

public static final java.lang.String LESSON_STOP_ACTION

Action command that stops the lesson.

See Also:

Constant Field Values

TASK_STATUS

public static final java.lang.String TASK_STATUS

The status of the currently executing task.

See Also:

Constant Field Values

TASK_FAIL_COUNT

public static final java.lang.String TASK_FAIL_COUNT

The number of mis-steps made by the user in the currently executing task.

See Also:

Constant Field Values

TASK_SUCCEED_COUNT

public static final java.lang.String TASK_SUCCEED_COUNT

The number of correct steps made by the user in the currently executing task.

See Also:

Constant Field Values

YES_TOKEN

public static final java.lang.String YES_TOKEN

Token used in constraint values.

See Also:

Constant Field Values

NO_TOKEN

public static final java.lang.String NO_TOKEN

Token used in constraint values.

See Also:

Constant Field Values

PREVIOUS_TASK_COMPLETION_REASON

public static final java.lang.String PREVIOUS_TASK_COMPLETION_REASON

The reason why the previous task failed or succeeded.

See Also:

Constant Field Values