TooltipManagerImpl.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.label;
 
import com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElement;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.gui.TooltipText;
import com.realtime.crossfire.jxclient.util.SwingUtilities2;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class TooltipManagerImpl implements TooltipManager {
 
    private static final int TOOLTIP_DISTANCE = 8;
 
    private int windowWidth;
 
    private int windowHeight;
 
    @Nullable
    private AbstractLabel tooltip;
 
    @Nullable
    private AbstractGUIElement activeGuiElement;
 
    @NotNull
    private final Object activeGuiElementSync = new Object();
 
    @NotNull
    private final Runnable resetRunnable = new Runnable() {
 
        @Override
        public void run() {
            synchronized (activeGuiElementSync) {
                removeTooltip();
                activeGuiElement = null;
            }
        }
 
    };
 
    public void setScreenSize(final int windowWidth, final int windowHeight) {
        synchronized (activeGuiElementSync) {
            this.windowWidth = windowWidth;
            this.windowHeight = windowHeight;
        }
    }
 
    public void setTooltip(@Nullable final AbstractLabel tooltip) {
        synchronized (activeGuiElementSync) {
            this.tooltip = tooltip;
        }
    }
 
    public void reset() {
        SwingUtilities2.invokeAndWait(resetRunnable);
    }
 
    @Override
    public void setElement(@NotNull final AbstractGUIElement guiElement) {
        SwingUtilities2.invokeAndWait(() -> {
            synchronized (activeGuiElementSync) {
                if (activeGuiElement == null) {
                    activeGuiElement = guiElement;
                    addTooltip();
                } else if (activeGuiElement != guiElement) {
                    removeTooltip();
                    activeGuiElement = guiElement;
                    addTooltip();
                }
            }
        });
    }
 
    @Override
    public void unsetElement(@NotNull final AbstractGUIElement guiElement) {
        SwingUtilities2.invokeAndWait(() -> {
            synchronized (activeGuiElementSync) {
                if (activeGuiElement == guiElement) {
                    removeTooltip();
                    activeGuiElement = null;
                }
            }
        });
    }
 
    @Override
    public void tooltipTextChanged(@NotNull final GUIElement element) {
        synchronized (activeGuiElementSync) {
            if (element != activeGuiElement) {
                return;
            }
        }
 
        SwingUtilities2.invokeLater(this::addTooltip);
    }
 
    private void addTooltip() {
        synchronized (activeGuiElementSync) {
            final AbstractGUIElement tmpActiveGuiElement = activeGuiElement;
            if (tmpActiveGuiElement == null) {
                return;
            }
 
            final AbstractLabel tmpTooltip = tooltip;
            if (tmpTooltip == null) {
                return;
            }
 
            final TooltipText tooltipText = tmpActiveGuiElement.getTooltip();
            if (tooltipText == null) {
                tmpTooltip.setVisible(false);
                return;
            }
            final String text = tooltipText.getText();
            if (text.isEmpty()) {
                tmpTooltip.setVisible(false);
                return;
            }
 
            tmpTooltip.setVisible(true);
            tmpTooltip.setText(text);
 
            final int preferredX = tooltipText.getX()+tooltipText.getW()/2-tmpTooltip.getWidth()/2;
            final int maxX = windowWidth-tmpTooltip.getWidth();
            final int tx = Math.max(0, Math.min(preferredX, maxX));
            final int elementY = tooltipText.getY();
            final int preferredY = elementY+tooltipText.getH()+TOOLTIP_DISTANCE;
            final int ty = preferredY+tmpTooltip.getHeight() <= windowHeight ? preferredY : elementY-tmpTooltip.getHeight()-TOOLTIP_DISTANCE;
            tmpTooltip.setLocation(tx, ty);
        }
    }
 
    private void removeTooltip() {
        final AbstractLabel tooltip;
        synchronized (activeGuiElementSync) {
            tooltip = this.tooltip;
        }
        if (tooltip != null) {
            tooltip.setVisible(false);
        }
    }
 
}