GUIItemShortcut.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.item;
 
import com.realtime.crossfire.jxclient.faces.FacesManager;
import com.realtime.crossfire.jxclient.faces.FacesManagerListener;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.gui.TooltipText;
import com.realtime.crossfire.jxclient.gui.misc.Modifiers;
import com.realtime.crossfire.jxclient.gui.textinput.CommandExecutor;
import com.realtime.crossfire.jxclient.shortcuts.Shortcut;
import com.realtime.crossfire.jxclient.shortcuts.ShortcutListener;
import com.realtime.crossfire.jxclient.shortcuts.ShortcutSlot;
import com.realtime.crossfire.jxclient.shortcuts.Shortcuts;
import com.realtime.crossfire.jxclient.shortcuts.ShortcutsListener;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import com.realtime.crossfire.jxclient.spells.Spell;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.Image;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class GUIItemShortcut extends GUIItem {
 
    private static final long serialVersionUID = 1;
 
    @NotNull
    private static final Color BACKGROUND_COLOR = new Color(0, 0, 0, 0.0f);
 
    @NotNull
    private static final String DEFAULT_TOOLTIP_TEXT = "(empty)";
 
    @NotNull
    private final Shortcuts shortcuts;
 
    @NotNull
    private final FacesManager facesManager;
 
    @NotNull
    private final CommandExecutor commandExecutor;
 
    @Nullable
    private final Color activateColor;
 
    @Nullable
    private final Image activateImage;
 
    @Nullable
    private final Color immediateColor;
 
    @Nullable
    private final Image immediateImage;
 
    @NotNull
    private final Font font;
 
    @NotNull
    private final ShortcutSlot shortcutSlot;
 
    @NotNull
    private final Object sync = new Object();
 
    @Nullable
    private Shortcut shortcut;
 
    @NotNull
    private final ShortcutsListener shortcutsListener = new ShortcutsListener() {
 
        @Override
        public void shortcutAdded(@NotNull final ShortcutSlot shortcutSlot, @NotNull final Shortcut shortcut) {
            if (shortcutSlot == GUIItemShortcut.this.shortcutSlot) {
                setShortcut(shortcut);
            }
        }
 
        @Override
        public void shortcutRemoved(@NotNull final ShortcutSlot shortcutSlot, @NotNull final Shortcut shortcut) {
            if (shortcutSlot == GUIItemShortcut.this.shortcutSlot) {
                setShortcut(null);
            }
        }
    };
 
    @NotNull
    private final ShortcutListener shortcutListener = () -> {
        setChanged();
        tooltipChanged();
    };
 
    @NotNull
    private final FacesManagerListener facesManagerListener = face -> {
        final Shortcut shortcut = getShortcut();
        if (shortcut != null && shortcut.displaysFace(face)) {
            setChanged();
        }
    };
 
    public GUIItemShortcut(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final Color activateColor, @Nullable final Image activateImage, @Nullable final Color immediateColor, @Nullable final Image immediateImage, @NotNull final ShortcutSlot shortcutSlot, @NotNull final FacesManager facesManager, @NotNull final CommandExecutor commandExecutor, @NotNull final Shortcuts shortcuts, @NotNull final Font font, @NotNull final GuiFactory guiFactory) {
        super(tooltipManager, elementListener, name, guiFactory);
        this.shortcuts = shortcuts;
        this.facesManager = facesManager;
        this.commandExecutor = commandExecutor;
        this.activateColor = activateColor;
        this.activateImage = activateImage;
        this.immediateColor = immediateColor;
        this.immediateImage = immediateImage;
        this.font = font;
        this.shortcutSlot = shortcutSlot;
        this.shortcuts.addShortcutsListener(shortcutsListener);
        this.facesManager.addFacesManagerListener(facesManagerListener);
    }
 
    @Override
    public void dispose() {
        super.dispose();
        facesManager.removeFacesManagerListener(facesManagerListener);
        shortcuts.removeShortcutsListener(shortcutsListener);
        setShortcut(null);
    }
 
    @Nullable
    private Shortcut getShortcut() {
        synchronized (sync) {
            return shortcut;
        }
    }
 
    @Nullable
    @Override
    public TooltipText getTooltip() {
        final Shortcut shortcut = getShortcut();
        return newTooltipText(shortcutSlot+"<br>"+(shortcut == null ? DEFAULT_TOOLTIP_TEXT : shortcut.getTooltipText()));
    }
 
    @Override
    public void notifyOpen() {
    }
 
    private void setShortcut(@Nullable final Shortcut shortcut) {
        synchronized (sync) {
            if (this.shortcut == shortcut) {
                return;
            }
 
            if (this.shortcut != null) {
                this.shortcut.removeShortcutListener(shortcutListener);
            }
            this.shortcut = shortcut;
            if (this.shortcut != null) {
                this.shortcut.addShortcutListener(shortcutListener);
            }
        }
        setChanged();
        tooltipChanged();
    }
 
    @Override
    public void button1Clicked(final int modifiers) {
        final Shortcut shortcut = getShortcut();
        switch (modifiers&Modifiers.MASK) {
        case Modifiers.NONE:
            if (shortcut != null) {
                commandExecutor.executeCommand(shortcut.getCommand());
            }
            break;
 
        case Modifiers.CTRL:
            if (shortcut != null) {
                shortcut.toggleImmediate();
            }
            break;
        }
    }
 
    @Override
    public void button2Clicked(final int modifiers) {
        //noinspection SwitchStatementWithTooFewBranches
        switch (modifiers&Modifiers.MASK) {
        case Modifiers.NONE:
            final Shortcut shortcut = getShortcut();
            if (shortcut != null) {
                shortcut.toggleImmediate();
            }
            break;
        }
    }
 
    @Override
    public void button3Clicked(final int modifiers) {
    }
 
    @Override
    public void paintComponent(@NotNull final Graphics g) {
        super.paintComponent(g);
 
        g.setColor(BACKGROUND_COLOR);
        g.fillRect(0, 0, getWidth(), getHeight());
 
        final Shortcut shortcut = getShortcut();
        if (shortcut != null) {
            final Spell spell = shortcut.getSpell();
            if (spell != null) {
                final Color color = shortcut.isImmediate() ? immediateColor : activateColor;
                if (color != null) {
                    g.setColor(color);
                    g.fillRect(0, 0, getWidth(), getHeight());
                }
                g.drawImage(facesManager.getOriginalImageIcon(spell.getFaceNum(), null).getImage(), 0, 0, null);
                final Image image = shortcut.isImmediate() ? immediateImage : activateImage;
                if (image != null) {
                    g.drawImage(image, 0, 0, null);
                }
            }
        }
 
        g.setFont(font);
        //noinspection VariableNotUsedInsideIf
        g.setColor(shortcut == null ? Color.LIGHT_GRAY : Color.DARK_GRAY); // XXX: define in skin
        g.drawString(shortcutSlot.toString(), 1, 1+font.getSize()); // XXX: define in skin
    }
 
    @NotNull
    @Override
    @SuppressWarnings("MethodDoesntCallSuperMethod")
    public Dimension getPreferredSize() {
        return getMinimumSizeInt();
    }
 
    @NotNull
    @Override
    @SuppressWarnings("MethodDoesntCallSuperMethod")
    public Dimension getMinimumSize() {
        return getMinimumSizeInt();
    }
 
    @NotNull
    private static Dimension getMinimumSizeInt() {
        return new Dimension(32, 32);
    }
 
    @Override
    public boolean canScroll(final int distance) {
        return false;
    }
 
    @Override
    public void scroll(final int distance) {
    }
 
    @Override
    public void resetScroll() {
    }
 
}