fix javadoc header

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

diff --git a/src/jexer/event/TMouseEvent.java b/src/jexer/event/TMouseEvent.java
index 29e0c1b42c51ccd775a348146679145cdc9dd615..253d8b60cbec29a36339a698fad0d62a5a3c744b 100644 (file)
--- a/src/jexer/event/TMouseEvent.java
+++ b/src/jexer/event/TMouseEvent.java
@@ -1,4 +1,4 @@
-/**
+/*
  * Jexer - Java Text User Interface
  *
  * License: LGPLv3 or later
@@ -31,7 +31,9 @@
 package jexer.event;
 
 /**
- * This class encapsulates several kinds of mouse input events.
+ * This class encapsulates several kinds of mouse input events.  Note that
+ * the relative (x,y) ARE MUTABLE: TWidget's onMouse() handlers perform that
+ * update during event dispatching.
  */
 public final class TMouseEvent extends TInputEvent {
 
@@ -56,8 +58,7 @@ public final class TMouseEvent extends TInputEvent {
     }
 
     /**
-     * Type of event, one of MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN, or
-     * KEYPRESS.
+     * Type of event, one of MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN.
      */
     private Type type;
 
@@ -84,6 +85,18 @@ public final class TMouseEvent extends TInputEvent {
         return x;
     }
 
+    /**
+     * Set x.
+     *
+     * @param x new relative X value
+     * @see jexer.TWidget#onMouseDown(TMouseEvent mouse)
+     * @see jexer.TWidget#onMouseDown(TMouseEvent mouse)
+     * @see jexer.TWidget#onMouseMotion(TMouseEvent mouse)
+     */
+    public void setX(final int x) {
+        this.x = x;
+    }
+
     /**
      * Mouse Y - relative coordinates.
      */
@@ -98,6 +111,18 @@ public final class TMouseEvent extends TInputEvent {
         return y;
     }
 
+    /**
+     * Set y.
+     *
+     * @param y new relative Y value
+     * @see jexer.TWidget#onMouseDown(TMouseEvent mouse)
+     * @see jexer.TWidget#onMouseDown(TMouseEvent mouse)
+     * @see jexer.TWidget#onMouseMotion(TMouseEvent mouse)
+     */
+    public void setY(final int y) {
+        this.y = y;
+    }
+
     /**
      * Mouse X - absolute screen coordinates.
      */
@@ -136,7 +161,7 @@ public final class TMouseEvent extends TInputEvent {
      *
      * @return mouse1
      */
-    public boolean getMouse1() {
+    public boolean isMouse1() {
         return mouse1;
     }
 
@@ -150,7 +175,7 @@ public final class TMouseEvent extends TInputEvent {
      *
      * @return mouse2
      */
-    public boolean getMouse2() {
+    public boolean isMouse2() {
         return mouse2;
     }
 
@@ -164,7 +189,7 @@ public final class TMouseEvent extends TInputEvent {
      *
      * @return mouse3
      */
-    public boolean getMouse3() {
+    public boolean isMouse3() {
         return mouse3;
     }
 
@@ -178,7 +203,7 @@ public final class TMouseEvent extends TInputEvent {
      *
      * @return mouseWheelUp
      */
-    public boolean getMouseWheelUp() {
+    public boolean isMouseWheelUp() {
         return mouseWheelUp;
     }
 
@@ -192,7 +217,7 @@ public final class TMouseEvent extends TInputEvent {
      *
      * @return mouseWheelDown
      */
-    public boolean getMouseWheelDown() {
+    public boolean isMouseWheelDown() {
         return mouseWheelDown;
     }