freecol/src/net/sf/freecol/client/gui/CanvasMouseListener.java

/**
 *  Copyright (C) 2002-2016   The FreeCol Team
 *
 *  This file is part of FreeCol.
 *
 *  FreeCol is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  FreeCol is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.swing.Timer;

import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.control.FreeColClientHolder;
import net.sf.freecol.common.debug.FreeColDebugger;
import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.PathNode;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.Unit;


/**
 * Listens to mouse buttons being pressed at the level of the Canvas.
 */
public final class CanvasMouseListener extends FreeColClientHolder
        implements ActionListener, MouseListener {

    private static final Logger logger = Logger.getLogger(CanvasMouseListener.class.getName());

    private static final int doubleClickDelay = 200; // Milliseconds

    private final Canvas canvas;

    private final Timer doubleClickTimer = new Timer(doubleClickDelay,this);

    private int centerX, centerY;


    /**
     * Create a new canvas mouse listener.
     *
     * @param freeColClient The enclosing {@code FreeColClient}.
     * @param canvas The component this object gets created for.
     */
    public CanvasMouseListener(FreeColClient freeColClient, Canvas canvas) {
        super(freeColClient);

        this.canvas = canvas;
    }


    /**
     * If a goto order is underway, perform it.
     *
     * @return True if a goto was underway.
     */
    private boolean flushGoto() {
        if (canvas.isGotoStarted()) {
            PathNode path = canvas.getGotoPath();
            canvas.stopGoto();
            if (path != null) { // Move the unit
                getFreeColClient().getInGameController()
                        .goToTile(canvas.getActiveUnit(),
                                path.getLastNode().getTile());
            }
            return true;
        }
        return false;
    }

    /**
     * Perform a goto order to the given tile with the active unit, if
     * possible.
     *
     * @param tile The <code>Tile</code> to go to.
     */
    private void immediateGoto(Tile tile) {
        Unit unit;
        PathNode path;
        if (tile != null
                && (unit = canvas.getActiveUnit()) != null
                && unit.getTile() != tile
                && (path = unit.findPath(tile)) != null) {
            canvas.startGoto();
            canvas.setGotoPath(path);
            flushGoto();
        }
    }

    private void immediatePopup(Tile tile, int x, int y) {
        if (canvas.isGotoStarted()) canvas.stopGoto();
        canvas.showTilePopup(tile, x, y);
    }

    private void immediateSettlement(Tile tile) {
        if (tile.hasSettlement()) {
            getFreeColClient().getGUI().showSettlement(tile.getSettlement());
        }
    }

    /**
     * Invoked when a mouse button was clicked.
     *
     * @param e The MouseEvent that holds all the information.
     */
    @Override
    public void mouseClicked(MouseEvent e) {
        Tile tile;
        if (e.getClickCount() > 1
                && (tile = canvas.convertToMapTile(e.getX(), e.getY())) != null) {
            immediateSettlement(tile);
        } else {
            canvas.requestFocus();
        }
    }

    /**
     * Invoked when the mouse enters the component.
     *
     * @param e The MouseEvent that holds all the information.
     */
    @Override
    public void mouseEntered(MouseEvent e) {
        // Ignore for now.
    }

    /**
     * Invoked when the mouse exits the component.
     *
     * @param e The MouseEvent that holds all the information.
     */
    @Override
    public void mouseExited(MouseEvent e) {
        // Ignore for now.
    }

    /**
     * Invoked when a mouse button was pressed.
     *
     * @param e The MouseEvent that holds all the information.
     */
    @Override
    public void mousePressed(MouseEvent e) {
        if (!e.getComponent().isEnabled()) return;

        int me = e.getButton();
        if (e.isPopupTrigger()) me = MouseEvent.BUTTON3;
        Tile tile = canvas.convertToMapTile(e.getX(), e.getY());

        switch (me) {
            case MouseEvent.BUTTON1:
                // Record initial click point for purposes of dragging,
                // @see CanvasMouseMotionListener#mouseDragged.
                canvas.setDragPoint(e.getX(), e.getY());

                // New click sequence? Remember position to use when timer expires
                if (!doubleClickTimer.isRunning()) {
                    centerX = e.getX();
                    centerY = e.getY();
                }
                doubleClickTimer.start();
                canvas.requestFocus();
                break;
            case MouseEvent.BUTTON2:
                immediateGoto(tile);
                break;
            case MouseEvent.BUTTON3:
                immediatePopup(tile, e.getX(), e.getY());
                break;
            default:
                break;
        }
    }

    /**
     * Invoked when a mouse button was released.
     *
     * @param e The MouseEvent that holds all the information.
     */
    @Override
    public void mouseReleased(MouseEvent e) {
        flushGoto();
    }


    // Interface ActionListener

    /**
     * {@inheritDoc}
     */
    @Override
    public void actionPerformed(ActionEvent ae) {
        doubleClickTimer.stop();
        Tile tile = canvas.convertToMapTile(centerX, centerY);
        if (tile == null) return;

        switch (canvas.getViewMode()) {
            case GUI.MOVE_UNITS_MODE:
                // Clear goto order when active unit is on the tile, else
                // try to display a settlement.
                Unit unit = canvas.getActiveUnit();
                if (unit != null && unit.getTile() == tile) {
                    igc().clearGotoOrders(unit);
                    canvas.updateCurrentPathForActiveUnit();
                } else {
                    immediateSettlement(tile);
                }
                break;
            case GUI.VIEW_TERRAIN_MODE: default:
                break;
        }
        getGUI().setSelectedTile(tile);
    }
}