Package com.j3d.engine.interact.cmd.base.conditions

Class SelectionPreCondition

java.lang.Object

com.j3d.engine.interact.cmd.base.conditions.SelectionPreCondition

All Implemented Interfaces:

PreCommandExecution

public class SelectionPreCondition
extends Object
implements PreCommandExecution

A concrete implementation of PreCommandExecution which forces the user to have made a selection before the command can execute.

This implementation provides:

• KeyEvent.VK_ENTER and KeyEvent.VK_ESCAPE to abort the selection requirement
• a direct implementation of getPassListener(), getFailListener(), getCondition(), getLogText() and getEventEmitterToAttachTo()
• a singleton Runnable which executes the code when this passes
• a singleton commandEndCleanup Runnable to otherwise provide extra cleanup that is required by the command

Author:

Lehlogonolo Poole

See Also:

• PreCommandExecution
• SemiStatefulCommand
• TransformCmd

Field Summary

Fields

Modifier and Type	Field	Description
private final Runnable	cleanup
private final Runnable	commandEndCleanup
private final EventReactor	failListener
private final EventReactor	passListener
private String	text

Constructor Summary

Constructors

Constructor	Description
SelectionPreCondition(Runnable success, Runnable extraCleanup)	Constructs a new SelectionPreCondition.
SelectionPreCondition(Runnable success, Runnable extraCleanup, String text)

Method Summary

Modifier and Type	Method	Description
void	finaliseCleanup()	Finalises the clean-up process by detaching the pass and fail listeners from the event emitter.
Supplier<Boolean>	getCondition()	The actual condition to check against wrapped around a Supplier
EventEmitterInterface	getEventEmitterToAttachTo()	The EventEmitterInterface which the PreCommandExecution.getPassListener() will attach to.
EventReactor	getFailListener()	The event to fire if the condition is false.
SamePair<String>	getLogText()	The text to display to the user via SafeJLabel.setText(String) when the condition is not met on startup.
EventReactor	getPassListener()	The main event reactor to run if the condition is met on startup or is later called by the PreCommandExecution.getEventEmitterToAttachTo().

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j3d.engine.interact.cmd.base.PreCommandExecution

execute

Field Details

passListener

private final EventReactor passListener

failListener

private final EventReactor failListener

cleanup

private final Runnable cleanup

commandEndCleanup

private final Runnable commandEndCleanup

text

private String text

Constructor Details

SelectionPreCondition

public SelectionPreCondition(Runnable success,
 Runnable extraCleanup,
 String text)

SelectionPreCondition

public SelectionPreCondition(Runnable success,
 Runnable extraCleanup)

Constructs a new SelectionPreCondition.

Parameters:

success - A Runnable to be executed when the selection condition is met.

extraCleanup - A Runnable to be executed for additional clean-up when the condition check is finalised.

Method Details

finaliseCleanup

public void finaliseCleanup()

Finalises the clean-up process by detaching the pass and fail listeners from the event emitter. This should be called when the command has either successfully proceeded or been aborted.

getPassListener

public EventReactor getPassListener()

Description copied from interface: PreCommandExecution

The main event reactor to run if the condition is met on startup or is later called by the PreCommandExecution.getEventEmitterToAttachTo().

Specified by:

getPassListener in interface PreCommandExecution

Returns:

The event reactor to run.

getFailListener

public EventReactor getFailListener()

Description copied from interface: PreCommandExecution

The event to fire if the condition is false.

Specified by:

getFailListener in interface PreCommandExecution

Returns:

The event reactor to run.

getEventEmitterToAttachTo

public EventEmitterInterface getEventEmitterToAttachTo()

Description copied from interface: PreCommandExecution

The EventEmitterInterface which the PreCommandExecution.getPassListener() will attach to.

Specified by:

getEventEmitterToAttachTo in interface PreCommandExecution

Returns:

The event emitter to attach to.

getLogText

public SamePair<String> getLogText()

Description copied from interface: PreCommandExecution

The text to display to the user via SafeJLabel.setText(String) when the condition is not met on startup. This is usually a friendly message requesting the user to interact with something before proceeding.

Specified by:

getLogText in interface PreCommandExecution

Returns:

The text to display.

getCondition

public Supplier<Boolean> getCondition()

Description copied from interface: PreCommandExecution

The actual condition to check against wrapped around a Supplier

Specified by:

getCondition in interface PreCommandExecution

Returns:

The condition to check against.