MouseTracker.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.gui.misc;
 
import com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GuiUtils;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Point;
import java.awt.event.MouseEvent;
import java.awt.event.MouseWheelEvent;
import java.io.IOException;
import java.io.Writer;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Locale;
import java.util.regex.Pattern;
import javax.swing.JRootPane;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MouseTracker {
 
    private static final int CLICK_DISTANCE = 20;
 
    @NotNull
    private static final Pattern PATTERN_PACKAGE_NAME = Pattern.compile(".*\\.");
 
    private final boolean debugGui;
 
    @Nullable
    private final Writer debugMouse;
 
    @NotNull
    private final GuiFactory guiFactory;
 
    @NotNull
    private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss,SSS ", Locale.ENGLISH);
 
    @Nullable
    private GUIElement mouseElement;
 
    @Nullable
    private AbstractGUIElement activeComponent;
 
    private boolean isDragging;
 
    private boolean isClicked;
 
    @NotNull
    private final Point clickPosition = new Point();
 
    public MouseTracker(final boolean debugGui, @Nullable final Writer debugMouse, @NotNull final GuiFactory guiFactory) {
        this.debugGui = debugGui;
        this.debugMouse = debugMouse;
        this.guiFactory = guiFactory;
    }
 
    public void mouseClicked(@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e) {
        debugMouseWrite("mouseClicked: "+e+" ["+element+"]");
    }
 
    @SuppressWarnings("UnusedParameters")
    public void mouseDragged(@Nullable final GUIElement element, @NotNull final MouseEvent e) {
        debugMouseWrite("mouseDragged: "+e+" ["+element+"]");
        if (isClicked) {
            final double distance = clickPosition.distanceSq(e.getLocationOnScreen());
            if (distance > CLICK_DISTANCE) {
                debugMouseWrite("mouseDragged: distance "+distance+" is too far for a click event; click point="+clickPosition+", current point="+e.getLocationOnScreen());
                setClicked(false);
            }
        }
        if (mouseElement != null) {
            debugMouseWrite(mouseElement+".mouseMoved");
            mouseElement.mouseMoved(e);
        }
        if (isDragging && mouseElement != null) {
            debugMouseWrite(mouseElement+".mouseDragged");
            mouseElement.mouseDragged(e);
        }
    }
 
    public void mouseMoved(@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e) {
        debugMouseWrite("mouseMoved: "+e+" ["+element+"]");
        enterElement(element, e);
        if (mouseElement != null) {
            debugMouseWrite(mouseElement+".mouseMoved");
            mouseElement.mouseMoved(e);
        }
    }
 
    public void mousePressed(@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e) {
        debugMouseWrite("mousePressed: "+e+" ["+element+"]");
        enterElement(element, e);
        if (mouseElement != null) {
            debugMouseWrite(mouseElement+".mousePressed");
            mouseElement.mousePressed(e);
        }
        setDragging(true);
        clickPosition.setLocation(e.getLocationOnScreen());
        setClicked(true);
    }
 
    public void mouseReleased(@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e) {
        debugMouseWrite("mouseReleased: "+e+" ["+element+"]");
        final boolean tmpIsClicked = isClicked;
        setDragging(false);
        enterElement(element, e);
        if (tmpIsClicked && element != null) {
            // cannot use mouseElement here: it might be invalid if the
            // previous call to mouseReleased() did close the owner dialog
            debugMouseWrite(element+".mouseClicked");
            element.mouseClicked(e);
        }
        if (mouseElement != null) {
            debugMouseWrite(mouseElement+".mouseReleased");
            mouseElement.mouseReleased(e);
        }
    }
 
    public void mouseEntered(@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e) {
        debugMouseWrite("mouseEntered: "+e+" ["+element+"]");
        setClicked(false);
        if (!isDragging) {
            enterElement(element, e);
        }
    }
 
    public void mouseExited(@NotNull final MouseEvent e) {
        debugMouseWrite("mouseExited: "+e);
        setClicked(false);
        if (!isDragging) {
            enterElement(null, e);
        }
    }
 
    private void enterElement(@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e) {
        if (mouseElement == element) {
            return;
        }
 
        final GUIElement tmp = mouseElement;
        if (tmp != null) {
            tmp.mouseExited(e);
            setActiveComponent(null);
        }
 
        mouseElement = element;
        debugMouseWrite("mouseElement="+mouseElement);
 
        if (element != null) {
            element.mouseEntered(e);
            if (debugGui) {
                setActiveComponent(element);
            }
        }
    }
 
    public void mouseWheelMoved(@Nullable final GUIElement element, @NotNull final MouseWheelEvent e) {
        if (element == null) {
            return;
        }
 
        final int wheelRotation = e.getWheelRotation();
        debugMouseWrite(element+".mouseWheelMoved "+wheelRotation);
        element.mouseWheelMoved(wheelRotation);
    }
 
    public void paintActiveComponent(@NotNull final Graphics g) {
        final AbstractGUIElement component = activeComponent;
        if (component != null) {
            final int x1 = guiFactory.getElementX(component);
            final int y1 = guiFactory.getElementY(component);
            final String text1 = formatName(component)+" "+component.getWidth()+"x"+component.getHeight()+"+"+x1+"+"+y1;
 
            final Container parent = component.getParent();
            final int x2 = parent instanceof AbstractGUIElement ? guiFactory.getElementX((AbstractGUIElement)parent) : parent == null ? 0 : parent.getX();
            final int y2 = parent instanceof AbstractGUIElement ? guiFactory.getElementY((AbstractGUIElement)parent) : parent == null ? 0 : parent.getY();
            final String text2 = parent == null ? "" : formatName(parent)+" "+parent.getWidth()+"x"+parent.getHeight()+"+"+x2+"+"+y2;
 
            final Dimension dimension1 = GuiUtils.getTextDimension(text1, g.getFontMetrics());
            final Dimension dimension2 = GuiUtils.getTextDimension(text2, g.getFontMetrics());
 
            g.setColor(Color.BLACK);
            g.fillRect(0, 2, Math.max(dimension1.width, dimension2.width)+4, dimension1.height+dimension2.height+16);
 
            g.setColor(Color.RED);
            g.drawString(text1, 2, dimension1.height+8-6);
            g.drawRect(x1, y1, component.getWidth()-1, component.getHeight()-1);
 
            if (parent != null) {
                g.setColor(Color.ORANGE);
                g.drawString(text2, 2, dimension1.height+dimension2.height+16-6);
                g.drawRect(x2, y2, parent.getWidth()-1, parent.getHeight()-1);
            }
        }
    }
 
    @NotNull
    private static String formatName(@NotNull final Component component) {
        return PATTERN_PACKAGE_NAME.matcher(component.getClass().getName()).replaceAll("")+"/"+component.getName();
    }
 
    private void debugMouseWrite(@NotNull final CharSequence message) {
        if (debugMouse == null) {
            return;
        }
 
        try {
            debugMouse.append(FORMATTER.format(LocalDateTime.now()));
            debugMouse.append(message);
            debugMouse.append("\n");
            debugMouse.flush();
        } catch (final IOException ex) {
            System.err.println("Cannot write mouse debug: "+ex.getMessage());
            System.exit(1);
            throw new AssertionError(ex);
        }
    }
 
    private void setActiveComponent(@Nullable final AbstractGUIElement activeComponent) {
        if (this.activeComponent == activeComponent) {
            return;
        }
 
        if (this.activeComponent != null) {
            this.activeComponent.setChanged();
            if (debugGui) {
                final AbstractGUIElement tmp = this.activeComponent;
                if (tmp != null) {
                    final JRootPane rootPane = tmp.getRootPane();
                    if (rootPane != null) {
                        rootPane.repaint();
                    }
                }
            }
        }
        this.activeComponent = activeComponent;
        if (this.activeComponent != null) {
            this.activeComponent.setChanged();
            if (debugGui) {
                final AbstractGUIElement tmp = this.activeComponent;
                final JRootPane rootPane = tmp.getRootPane();
                if (rootPane != null) {
                    rootPane.repaint();
                }
            }
        }
        debugMouseWrite("activeComponent="+activeComponent);
    }
 
    private void setDragging(final boolean isDragging) {
        if (this.isDragging == isDragging) {
            return;
        }
 
        this.isDragging = isDragging;
        debugMouseWrite("isDragging="+isDragging);
    }
 
    private void setClicked(final boolean isClicked) {
        if (this.isClicked == isClicked) {
            return;
        }
 
        this.isClicked = isClicked;
        debugMouseWrite("isClicked="+isClicked);
    }
 
}