Prep for 2019 release

[nikiroo-utils.git] / src / jexer / event / TMouseEvent.java

/*
 * Jexer - Java Text User Interface
 *
 * The MIT License (MIT)
 *
 * Copyright (C) 2019 Kevin Lamonte
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
 * @version 1
 */
package jexer.event;

/**
 * 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 class TMouseEvent extends TInputEvent {

    // ------------------------------------------------------------------------
    // Constants --------------------------------------------------------------
    // ------------------------------------------------------------------------

    /**
     * The type of event generated.
     */
    public enum Type {
        /**
         * Mouse motion.  X and Y will have screen coordinates.
         */
        MOUSE_MOTION,

        /**
         * Mouse button down.  X and Y will have screen coordinates.
         */
        MOUSE_DOWN,

        /**
         * Mouse button up.  X and Y will have screen coordinates.
         */
        MOUSE_UP,

        /**
         * Mouse double-click.  X and Y will have screen coordinates.
         */
        MOUSE_DOUBLE_CLICK
    }

    // ------------------------------------------------------------------------
    // Variables --------------------------------------------------------------
    // ------------------------------------------------------------------------

    /**
     * Type of event, one of MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN.
     */
    private Type type;

    /**
     * Mouse X - relative coordinates.
     */
    private int x;

    /**
     * Mouse Y - relative coordinates.
     */
    private int y;

    /**
     * Mouse X - absolute screen coordinates.
     */
    private int absoluteX;

    /**
     * Mouse Y - absolute screen coordinate.
     */
    private int absoluteY;

    /**
     * Mouse button 1 (left button).
     */
    private boolean mouse1;

    /**
     * Mouse button 2 (right button).
     */
    private boolean mouse2;

    /**
     * Mouse button 3 (middle button).
     */
    private boolean mouse3;

    /**
     * Mouse wheel UP (button 4).
     */
    private boolean mouseWheelUp;

    /**
     * Mouse wheel DOWN (button 5).
     */
    private boolean mouseWheelDown;

    // ------------------------------------------------------------------------
    // Constructors -----------------------------------------------------------
    // ------------------------------------------------------------------------

    /**
     * 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, 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;
    }

    // ------------------------------------------------------------------------
    // TMouseEvent ------------------------------------------------------------
    // ------------------------------------------------------------------------

    /**
     * Get type.
     *
     * @return type
     */
    public Type getType() {
        return type;
    }

    /**
     * Get x.
     *
     * @return x
     */
    public int getX() {
        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;
    }

    /**
     * Get y.
     *
     * @return y
     */
    public int getY() {
        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;
    }

    /**
     * Get absoluteX.
     *
     * @return absoluteX
     */
    public int getAbsoluteX() {
        return absoluteX;
    }

    /**
     * Set absoluteX.
     *
     * @param absoluteX the new value
     */
    public void setAbsoluteX(final int absoluteX) {
        this.absoluteX = absoluteX;
    }

    /**
     * Get absoluteY.
     *
     * @return absoluteY
     */
    public int getAbsoluteY() {
        return absoluteY;
    }

    /**
     * Set absoluteY.
     *
     * @param absoluteY the new value
     */
    public void setAbsoluteY(final int absoluteY) {
        this.absoluteY = absoluteY;
    }

    /**
     * Get mouse1.
     *
     * @return mouse1
     */
    public boolean isMouse1() {
        return mouse1;
    }

    /**
     * Get mouse2.
     *
     * @return mouse2
     */
    public boolean isMouse2() {
        return mouse2;
    }

    /**
     * Get mouse3.
     *
     * @return mouse3
     */
    public boolean isMouse3() {
        return mouse3;
    }

    /**
     * Get mouseWheelUp.
     *
     * @return mouseWheelUp
     */
    public boolean isMouseWheelUp() {
        return mouseWheelUp;
    }

    /**
     * Get mouseWheelDown.
     *
     * @return mouseWheelDown
     */
    public boolean isMouseWheelDown() {
        return mouseWheelDown;
    }

    /**
     * Create a duplicate instance.
     *
     * @return duplicate intance
     */
    public TMouseEvent dup() {
        TMouseEvent mouse = new TMouseEvent(type, x, y, absoluteX, absoluteY,
            mouse1, mouse2, mouse3, mouseWheelUp, mouseWheelDown);
        return mouse;
    }

    /**
     * Make human-readable description of this TMouseEvent.
     *
     * @return displayable String
     */
    @Override
    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,
            absoluteX, absoluteY,
            mouse1,
            mouse2,
            mouse3,
            mouseWheelUp,
            mouseWheelDown);
    }

}