immutable TMouseEvent

[fanfix.git] / src / jexer / event / TMouseEvent.java

diff --git a/src/jexer/event/TMouseEvent.java b/src/jexer/event/TMouseEvent.java
index 09ace1da0d97a20ff925857ad0b288c5b1be34e4..29e0c1b42c51ccd775a348146679145cdc9dd615 100644 (file)
--- a/src/jexer/event/TMouseEvent.java
+++ b/src/jexer/event/TMouseEvent.java
@@ -33,7 +33,7 @@ package jexer.event;
 /**
  * This class encapsulates several kinds of mouse input events.
  */
-public class TMouseEvent extends TInputEvent {
+public final class TMouseEvent extends TInputEvent {
 
     /**
      * The type of event generated.
@@ -59,60 +59,172 @@ public class TMouseEvent extends TInputEvent {
      * Type of event, one of MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN, or
      * KEYPRESS.
      */
-    public Type type;
+    private Type type;
+
+    /**
+     * Get type.
+     *
+     * @return type
+     */
+    public Type getType() {
+        return type;
+    }
 
     /**
      * Mouse X - relative coordinates.
      */
-    public int x;
+    private int x;
+
+    /**
+     * Get x.
+     *
+     * @return x
+     */
+    public int getX() {
+        return x;
+    }
 
     /**
      * Mouse Y - relative coordinates.
      */
-    public int y;
+    private int y;
+
+    /**
+     * Get y.
+     *
+     * @return y
+     */
+    public int getY() {
+        return y;
+    }
 
     /**
      * Mouse X - absolute screen coordinates.
      */
-    public int absoluteX;
+    private int absoluteX;
+
+    /**
+     * Get absoluteX.
+     *
+     * @return absoluteX
+     */
+    public int getAbsoluteX() {
+        return absoluteX;
+    }
 
     /**
      * Mouse Y - absolute screen coordinate.
      */
-    public int absoluteY;
+    private int absoluteY;
+
+    /**
+     * Get absoluteY.
+     *
+     * @return absoluteY
+     */
+    public int getAbsoluteY() {
+        return absoluteY;
+    }
 
     /**
      * Mouse button 1 (left button).
      */
-    public boolean mouse1;
+    private boolean mouse1;
+
+    /**
+     * Get mouse1.
+     *
+     * @return mouse1
+     */
+    public boolean getMouse1() {
+        return mouse1;
+    }
 
     /**
      * Mouse button 2 (right button).
      */
-    public boolean mouse2;
+    private boolean mouse2;
+
+    /**
+     * Get mouse2.
+     *
+     * @return mouse2
+     */
+    public boolean getMouse2() {
+        return mouse2;
+    }
 
     /**
      * Mouse button 3 (middle button).
      */
-    public boolean mouse3;
+    private boolean mouse3;
+
+    /**
+     * Get mouse3.
+     *
+     * @return mouse3
+     */
+    public boolean getMouse3() {
+        return mouse3;
+    }
 
     /**
      * Mouse wheel UP (button 4).
      */
-    public boolean mouseWheelUp;
+    private boolean mouseWheelUp;
+
+    /**
+     * Get mouseWheelUp.
+     *
+     * @return mouseWheelUp
+     */
+    public boolean getMouseWheelUp() {
+        return mouseWheelUp;
+    }
 
     /**
      * Mouse wheel DOWN (button 5).
      */
-    public boolean mouseWheelDown;
+    private boolean mouseWheelDown;
+
+    /**
+     * Get mouseWheelDown.
+     *
+     * @return mouseWheelDown
+     */
+    public boolean getMouseWheelDown() {
+        return mouseWheelDown;
+    }
 
     /**
      * Public contructor.
      *
      * @param type the type of event, MOUSE_MOTION, MOUSE_DOWN, or MOUSE_UP
+     * @param x relative column
+     * @param y relative row
+     * @param absoluteX absolute column
+     * @param absoluteY absolute row
+     * @param mouse1 if true, left button is down
+     * @param mouse2 if true, right button is down
+     * @param mouse3 if true, middle button is down
+     * @param mouseWheelUp if true, mouse wheel (button 4) is down
+     * @param mouseWheelDown if true, mouse wheel (button 5) is down
      */
-    public TMouseEvent(final Type type) {
-        this.type = type;
+    public TMouseEvent(final Type type, final int x, final int y,
+        final int absoluteX, final int absoluteY,
+        final boolean mouse1, final boolean mouse2, final boolean mouse3,
+        final boolean mouseWheelUp, final boolean mouseWheelDown) {
+
+        this.type               = type;
+        this.x                  = x;
+        this.y                  = y;
+        this.absoluteX          = absoluteX;
+        this.absoluteY          = absoluteY;
+        this.mouse1             = mouse1;
+        this.mouse2             = mouse2;
+        this.mouse3             = mouse3;
+        this.mouseWheelUp       = mouseWheelUp;
+        this.mouseWheelDown     = mouseWheelDown;
     }
 
     /**
@@ -121,7 +233,7 @@ public class TMouseEvent extends TInputEvent {
      * @return displayable String
      */
     @Override
-    public final String toString() {
+    public String toString() {
         return String.format("Mouse: %s x %d y %d absoluteX %d absoluteY %d 1 %s 2 %s 3 %s DOWN %s UP %s",
             type,
             x, y,