aboutsummaryrefslogtreecommitdiffstats
path: root/src/jcgp/gui/handlers/InputHandlers.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jcgp/gui/handlers/InputHandlers.java')
-rw-r--r--src/jcgp/gui/handlers/InputHandlers.java18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/jcgp/gui/handlers/InputHandlers.java b/src/jcgp/gui/handlers/InputHandlers.java
index 6be4e7e..1d18ef5 100644
--- a/src/jcgp/gui/handlers/InputHandlers.java
+++ b/src/jcgp/gui/handlers/InputHandlers.java
@@ -6,13 +6,21 @@ import jcgp.gui.population.GUIGene.GUIGeneState;
import jcgp.gui.population.GUIInput;
/**
- *
+ * Holds the handlers that define the behaviour of {@code GUIInput}.
+ * <br><br>
+ * The handlers are instantiated here statically and added to {@code GUIInput}
+ * instances using {@code InputHandlers.addHandlers(...)}. This guarantees that
+ * all inputs behave the same way without instantiating a new set of handlers for
+ * each input instance.
*
* @author Eduardo Pedroni
*
*/
public final class InputHandlers {
+ /**
+ * Inputs don't do much; set state to hover when mouse enters.
+ */
private static EventHandler<MouseEvent> mouseEnteredHandler = new EventHandler<MouseEvent>() {
@Override
public void handle(MouseEvent event) {
@@ -20,6 +28,9 @@ public final class InputHandlers {
}
};
+ /**
+ * Inputs don't do much; set state to neutral when mouse exits.
+ */
private static EventHandler<MouseEvent> mouseExitedHandler = new EventHandler<MouseEvent>() {
@Override
public void handle(MouseEvent event) {
@@ -27,6 +38,11 @@ public final class InputHandlers {
}
};
+ /**
+ * Adds all handlers to the specified input.
+ *
+ * @param input the {@code GUIInput} to which the handlers will be added.
+ */
public static void addHandlers(GUIInput input) {
input.addEventHandler(MouseEvent.MOUSE_ENTERED, mouseEnteredHandler);
input.addEventHandler(MouseEvent.MOUSE_EXITED, mouseExitedHandler);