GUIMetaElement.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.list;
 
import com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
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.gui.scrollable.GUIScrollable;
import com.realtime.crossfire.jxclient.metaserver.Metaserver;
import com.realtime.crossfire.jxclient.metaserver.MetaserverEntry;
import com.realtime.crossfire.jxclient.metaserver.MetaserverEntryListener;
import com.realtime.crossfire.jxclient.metaserver.MetaserverModel;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.Image;
import java.awt.event.MouseEvent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class GUIMetaElement extends ActivatableGUIElement implements GUIScrollable {
 
    private static final long serialVersionUID = 1;
 
    @NotNull
    private final MetaserverModel metaserverModel;
 
    @Nullable
    private final Image image;
 
    @NotNull
    private final Font font;
 
    @NotNull
    private final String format;
 
    @NotNull
    private final String tooltip;
 
    private final int defaultIndex;
 
    private int index;
 
    private boolean selected;
 
    @NotNull
    private final MetaserverEntryListener metaserverEntryListener = () -> {
        setChanged();
        tooltipChanged();
    };
 
    public GUIMetaElement(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final MetaserverModel metaserverModel, @NotNull final String name, @Nullable final Image image, @NotNull final Font font, final int defaultIndex, @NotNull final String format, @NotNull final String tooltip, @NotNull final GuiFactory guiFactory) {
        super(tooltipManager, elementListener, name, false, guiFactory);
        this.metaserverModel = metaserverModel;
        this.image = image;
        this.font = font;
        this.defaultIndex = defaultIndex;
        index = defaultIndex;
        this.format = format;
        this.tooltip = tooltip;
        this.metaserverModel.addMetaserverEntryListener(index, metaserverEntryListener);
        setChanged();
    }
 
    @Override
    public void dispose() {
        super.dispose();
        metaserverModel.removeMetaserverEntryListener(index, metaserverEntryListener);
    }
 
    @Override
    public void paintComponent(@NotNull final Graphics g) {
        super.paintComponent(g);
        g.setColor(new Color(0, 0, 0, 0.0f));
        g.fillRect(0, 0, getWidth(), getHeight());
        g.setFont(font);
        g.setColor(isActive() || selected ? Color.RED : Color.GRAY);
        if (image != null) {
            g.drawImage(image, 0, 0, null);
        }
        final MetaserverEntry metaEntry = metaserverModel.getEntry(index);
        g.drawString(metaEntry == null ? "" : metaEntry.format(format), image == null ? 0 : image.getWidth(this), font.getSize()+1);
    }
 
    @Nullable
    @Override
    @SuppressWarnings("MethodDoesntCallSuperMethod")
    public Dimension getPreferredSize() {
        return getMinimumSizeInt();
    }
 
    @Nullable
    @Override
    @SuppressWarnings("MethodDoesntCallSuperMethod")
    public Dimension getMinimumSize() {
        return getMinimumSizeInt();
    }
 
    @NotNull
    private Dimension getMinimumSizeInt() {
        final MetaserverEntry metaEntry = metaserverModel.getEntry(index);
        final Dimension result = GuiUtils.getTextDimension(metaEntry == null ? "" : metaEntry.format(format), getFontMetrics(font));
        if (image != null) {
            result.width += image.getWidth(this);
        }
        return result;
    }
 
    @Override
    public void mouseClicked(@NotNull final MouseEvent e) {
        super.mouseClicked(e);
 
        if (!isEnabled()) {
            return;
        }
 
        final int b = e.getButton();
        switch (b) {
        case MouseEvent.BUTTON1:
            setActive(true);
            setChanged();
            break;
 
        case MouseEvent.BUTTON2:
            break;
 
        case MouseEvent.BUTTON3:
            break;
        }
    }
 
    @Nullable
    @Override
    public TooltipText getTooltip() {
        final MetaserverEntry metaEntry = metaserverModel.getEntry(index);
        return metaEntry == null ? null : newTooltipText(metaEntry.format(tooltip));
    }
 
    @Override
    public void notifyOpen() {
    }
 
    @Override
    public void execute() {
        // ignore
    }
 
    @Override
    public boolean canScroll(final int distance) {
        if (distance < 0) {
            return index >= -distance;
        }
        //noinspection SimplifiableIfStatement
        if (distance > 0) {
            return index+distance < metaserverModel.size();
        }
        return false;
    }
 
    @Override
    public void scroll(final int distance) {
        setIndex(index+distance);
    }
 
    @Override
    public void resetScroll() {
        if (index != defaultIndex) {
            scroll(defaultIndex-index);
        }
    }
 
    @Override
    protected void activeChanged() {
        setChanged();
    }
 
    public int getIndex() {
        return index;
    }
 
    public void setIndex(final int index) {
        if (this.index == index) {
            return;
        }
 
        metaserverModel.removeMetaserverEntryListener(index, metaserverEntryListener);
        this.index = index;
        metaserverModel.addMetaserverEntryListener(index, metaserverEntryListener);
        setChanged();
        tooltipChanged();
    }
 
    public void setSelected(final boolean selected) {
        if (this.selected == selected) {
            return;
        }
 
        this.selected = selected;
        setChanged();
    }
 
}