GUIGauge.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.gauge;

import com.realtime.crossfire.jxclient.gui.commandlist.CommandList;
import com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import java.awt.AlphaComposite;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Transparency;
import java.awt.event.MouseEvent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class GUIGauge extends AbstractGUIElement implements GUIGaugeListener {

    private static final long serialVersionUID = 1;

    @Nullable
    private final String tooltipFormat;

    @Nullable
    private final CommandList commandList;

    @NotNull
    private String tooltipText = "";

    @Nullable
    private final Image emptyImage;

    @NotNull
    private final Orientation orientation;

    @NotNull
    private final GaugeState gaugeState;

    private final float alpha;

    private boolean hidden;

    public GUIGauge(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final Image fullImage, @Nullable final Image negativeImage, @Nullable final Image emptyImage, @NotNull final Orientation orientation, @Nullable final String tooltipFormat, final float alpha, @Nullable final CommandList commandList) {
        super(tooltipManager, elementListener, name, alpha < 1.0F ? Transparency.TRANSLUCENT : Transparency.OPAQUE);
        this.emptyImage = emptyImage;
        this.orientation = orientation;
        this.tooltipFormat = tooltipFormat;
        this.commandList = commandList;
        gaugeState = new GaugeState(fullImage, negativeImage, 0, 0);
        this.alpha = alpha;
        tooltipText = "-";      // make sure the following setValues() does not short-cut
        orientation.setExtends(getWidth(), getHeight());
        orientation.setHasNegativeImage(negativeImage != null);
        orientation.setValues(0, 0, 0);
        gaugeState.setValues(orientation);
        updateTooltipText();
    }

    @Override
    public void setBounds(final int x, final int y, final int width, final int height) {
        super.setBounds(x, y, width, height);
        if (orientation.setExtends(width, height)) {
            if (gaugeState.setValues(orientation)) {
                setChanged();
            }
        }
    }

    @Override
    public void paintComponent(@NotNull final Graphics g) {
        if (hidden) {
            return;
        }

        final Graphics paint;
        if (alpha < 1.0F) {
            final Graphics2D g2d = (Graphics2D)g.create();
            g2d.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER, alpha));
            paint = g2d;
        } else {
            paint = g;
        }

        super.paintComponent(paint);
        if (emptyImage != null) {
            paint.drawImage(emptyImage, 0, 0, null);
        }
        gaugeState.draw(paint);
        if (paint != g) {
            paint.dispose();
        }
    }

    @Override
    public void setValues(final int curValue, final int minValue, final int maxValue, @NotNull final String labelText, @NotNull final String tooltipText) {
        if (!orientation.setValues(curValue, minValue, maxValue) && this.tooltipText.equals(tooltipText)) {
            return;
        }

        this.tooltipText = tooltipText;

        if (gaugeState.setValues(orientation)) {
            setChanged();
        }

        updateTooltipText();
    }

    private void updateTooltipText() {
        setTooltipText(formatTooltip());
    }

    @Nullable
    @Override
    public Dimension getPreferredSize() {
        return gaugeState.getPreferredSize();
    }

    @Nullable
    @Override
    public Dimension getMinimumSize() {
        return gaugeState.getPreferredSize();
    }

    @Nullable
    @Override
    public Dimension getMaximumSize() {
        return gaugeState.getPreferredSize();
    }

    @Override
    public void setHidden(final boolean hidden) {
        this.hidden = hidden;
    }

    @Override
    public void mouseClicked(@NotNull final MouseEvent e) {
        super.mouseClicked(e);
        switch (e.getButton()) {
        case MouseEvent.BUTTON1:
            break;

        case MouseEvent.BUTTON2:
            if (commandList != null) {
                commandList.execute();
            }
            break;

        case MouseEvent.BUTTON3:
            break;
        }
    }

    @Nullable
    private String formatTooltip() {
        if (tooltipFormat == null) {
            return null;
        }
        final StringBuilder sb = new StringBuilder();
        final char[] formatChars = tooltipFormat.toCharArray();
        int i = 0;
        while (i < formatChars.length) {
            final char ch = formatChars[i++];
            if (ch != '%' || i >= formatChars.length) {
                sb.append(ch);
            } else {
                switch (formatChars[i++]) {
                case '%':
                    sb.append('%');
                    break;

                case 'T':
                    sb.append(tooltipText);
                    break;

                default:
                    sb.append('%');
                    sb.append(formatChars[i-1]);
                    break;
                }
            }
        }
        return sb.toString();
    }

}