GUIScrollBar.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.misc;
 
import com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement;
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.scrollable.GUIScrollable2;
import com.realtime.crossfire.jxclient.gui.scrollable.ScrollableListener;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.event.MouseEvent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class GUIScrollBar extends ActivatableGUIElement implements ScrollableListener {
 
    private static final long serialVersionUID = 1;
 
    private final boolean proportionalSlider;
 
    @NotNull
    private final GUIScrollable2 scrollable;
 
    @NotNull
    private final Color colorBackground;
 
    @NotNull
    private final Color colorForeground;
 
    private int valueMin;
 
    private int valueSize = 1;
 
    private int sliderSize = 1;
 
    private int sliderPos;
 
    private int offset;
 
    private boolean scrolling;
 
    public GUIScrollBar(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean proportionalSlider, @NotNull final GUIScrollable2 scrollable, @NotNull final Color colorBackground, @NotNull final Color colorForeground, @NotNull final GuiFactory guiFactory) {
        super(tooltipManager, elementListener, name, false, guiFactory);
        this.proportionalSlider = proportionalSlider;
        this.scrollable = scrollable;
        this.colorBackground = colorBackground;
        this.colorForeground = colorForeground;
        this.scrollable.addScrollableListener(this);
    }
 
    @Override
    public void dispose() {
        super.dispose();
        scrollable.removeScrollableListener(this);
    }
 
    @Override
    public void setRange(final int valueMin, final int valueMax, final int sliderPos, final int sliderSize) {
        if (valueMax <= valueMin) {
            throw new IllegalArgumentException("valueMax="+valueMax+" <= "+valueMin+"="+valueMin);
        }
        if (sliderSize <= 0) {
            throw new IllegalArgumentException("sliderSize="+sliderSize+" <= 0");
        }
 
        this.valueMin = valueMin;
        valueSize = valueMax-valueMin;
        this.sliderSize = Math.min(sliderSize, valueSize);
        setPosition(sliderPos);
    }
 
    @Override
    protected void activeChanged() {
    }
 
    @Override
    public void mousePressed(@NotNull final MouseEvent e) {
        super.mousePressed(e);
 
        if (!isEnabled()) {
            return;
        }
 
        switch (e.getButton()) {
        case MouseEvent.BUTTON1:
            final int sh = getSliderHeightPixels();
            offset = e.getY()-getSliderPosPixels(sh);
            if (offset < 0) {
                scrollable.scrollTo(sliderPos-sliderSize);
            } else if (offset >= sh) {
                scrollable.scrollTo(sliderPos+sliderSize);
            } else {
                scrolling = true;
            }
            break;
 
        case MouseEvent.BUTTON2:
            break;
 
        case MouseEvent.BUTTON3:
            break;
        }
    }
 
    @Override
    public void mouseReleased(@NotNull final MouseEvent e) {
        super.mouseReleased(e);
 
        if (!isEnabled()) {
            return;
        }
 
        switch (e.getButton()) {
        case MouseEvent.BUTTON1:
            scrolling = false;
            break;
 
        case MouseEvent.BUTTON2:
            break;
 
        case MouseEvent.BUTTON3:
            break;
        }
    }
 
    @Override
    public void mouseDragged(@NotNull final MouseEvent e) {
        super.mouseDragged(e);
        if (isEnabled() && scrolling) {
            scrollable.scrollTo(getSliderPos(e.getY()-offset));
        }
    }
 
    @Override
    public void mouseWheelMoved(final int wheelRotation) {
        super.mouseWheelMoved(wheelRotation);
        scrollable.scroll(wheelRotation);
    }
 
    @Nullable
    @Override
    public TooltipText getTooltip() {
        return null;
    }
 
    @Override
    public void notifyOpen() {
    }
 
    @Override
    public void execute() {
        // ignore
    }
 
    private int getSliderPos(final int yPixels) {
        return (int)Math.round(yPixels*(double)(valueSize-sliderSize)/(getHeight()-getSliderHeightPixels()));
    }
 
    private void setPosition(final int pos) {
        if (pos < valueMin) {
            sliderPos = valueMin;
        } else if (pos+sliderSize > valueMin+valueSize) {
            sliderPos = valueMin+valueSize-sliderSize;
        } else {
            sliderPos = pos;
        }
        setChanged();
    }
 
    private int getSliderHeightPixels() {
        return proportionalSlider ? Math.max((int)Math.round(getHeight()*(double)sliderSize/valueSize), getWidth()) : getWidth();
    }
 
    private int getSliderPosPixels(final int sh) {
        return (int)Math.round(sliderPos*(double)(getHeight()-sh)/(valueSize-sliderSize));
    }
 
    @Override
    public void paintComponent(@NotNull final Graphics g) {
        super.paintComponent(g);
        final int sh = getSliderHeightPixels();
        final int sy = getSliderPosPixels(sh);
        g.setColor(colorBackground);
        g.fillRect(0, 0, getWidth(), sy);
        g.fillRect(0, sy+sh, getWidth(), getHeight()-sy-sh);
        g.setColor(colorForeground);
        g.fillRect(0, sy, getWidth(), sh);
    }
 
    @Nullable
    @Override
    @SuppressWarnings("MethodDoesntCallSuperMethod")
    public Dimension getPreferredSize() {
        return new Dimension(16, 64);
    }
 
    @Nullable
    @Override
    @SuppressWarnings("MethodDoesntCallSuperMethod")
    public Dimension getMinimumSize() {
        return new Dimension(16, 16);
    }
 
}