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-2011 Andreas Kirschbaum.
 */

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.GuiUtils;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.gui.TooltipText;
import com.realtime.crossfire.jxclient.util.SwingUtilities2;
import java.awt.Component;
import java.util.Map;
import java.util.WeakHashMap;
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 GUIElement activeGuiElement;

    @NotNull
    private final Object activeGuiElementSync = new Object();

    @NotNull
    private final Map<GUIElement, TooltipText> tooltipTexts = new WeakHashMap<>();

    @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) {
        this.windowWidth = windowWidth;
        this.windowHeight = windowHeight;
    }

    public void setTooltip(@Nullable final AbstractLabel tooltip) {
        this.tooltip = tooltip;
    }

    public void reset() {
        SwingUtilities2.invokeAndWait(resetRunnable);
    }

    @Override
    public void setElement(@NotNull final GUIElement guiElement) {
        final TooltipText tooltipText = tooltipTexts.get(guiElement);
        if (tooltipText != null) {
            guiElement.setTooltipText(tooltipText.getText());
        }
        SwingUtilities2.invokeAndWait(() -> {
            synchronized (activeGuiElementSync) {
                if (activeGuiElement == null) {
                    activeGuiElement = guiElement;
                    addTooltip();
                } else if (activeGuiElement != guiElement) {
                    removeTooltip();
                    activeGuiElement = guiElement;
                    addTooltip();
                }
            }
        });
    }

    @Override
    public void unsetElement(@NotNull final GUIElement guiElement) {
        SwingUtilities2.invokeAndWait(() -> {
            synchronized (activeGuiElementSync) {
                if (activeGuiElement == guiElement) {
                    removeTooltip();
                    activeGuiElement = null;
                }
            }
        });
    }

    @Override
    public void setTooltipText(@NotNull final AbstractGUIElement element, @Nullable final String tooltipText) {
        final Component gui = GuiUtils.getGui(element);
        if (gui != null) {
            setTooltipText(element, tooltipText, gui.getX()+element.getX(), gui.getY()+element.getY(), element.getWidth(), element.getHeight());
        }
    }

    @Override
    public void setTooltipText(@NotNull final GUIElement element, @Nullable final String tooltipText, final int x, final int y, final int w, final int h) {
        final TooltipText oldTooltipText = tooltipTexts.get(element);
        if (oldTooltipText == null) {
            if (tooltipText == null) {
                return;
            }
        } else {
            if (tooltipText != null && tooltipText.equals(oldTooltipText.getText()) && x == oldTooltipText.getX() && y == oldTooltipText.getY() && w == oldTooltipText.getW() && h == oldTooltipText.getH()) {
                return;
            }
        }
        tooltipTexts.put(element, tooltipText == null ? null : new TooltipText(tooltipText, x, y, w, h));

        SwingUtilities2.invokeAndWait(() -> {
            synchronized (activeGuiElementSync) {
                if (activeGuiElement == element) {
                    removeTooltip();
                    addTooltip();
                }
            }
        });
    }

    @Override
    public boolean hasTooltipText(final AbstractGUIElement element) {
        return tooltipTexts.get(element) != null;
    }

    private void addTooltip() {
        final GUIElement tmpActiveGuiElement = activeGuiElement;
        assert tmpActiveGuiElement != null;
        assert Thread.holdsLock(activeGuiElementSync);

        final AbstractLabel tmpTooltip = tooltip;
        if (tmpTooltip == null) {
            return;
        }

        final TooltipText tooltipText = tooltipTexts.get(tmpActiveGuiElement);
        if (tooltipText == null) {
            tmpTooltip.setVisible(false);
            return;
        }

        tmpTooltip.setVisible(true);
        tmpTooltip.setText(tooltipText.getText());

        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() {
        if (tooltip != null) {
            tooltip.setVisible(false);
        }
    }

}