DCProgressBar.java

/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.widgets;

import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;

import javax.swing.JProgressBar;

import org.datacleaner.util.ProgressCounter;
import org.datacleaner.util.WidgetUtils;

/**
 * A progress bar which behaves properly in multithreaded environments.
 */
public class DCProgressBar extends JProgressBar {

    private static final long serialVersionUID = 1L;

    private static final int DEFAULT_HEIGHT = 20;

    private final ProgressCounter _value;

    private Color _progressBarColor = WidgetUtils.BG_COLOR_BLUE_BRIGHT;
    private boolean _showAsFull;

    public DCProgressBar(final int min, final int max) {
        super(min, max);
        setMinimumSize(new Dimension(10, DEFAULT_HEIGHT));

        setOpaque(false);
        _value = new ProgressCounter(0);
    }

    @Override
    public Dimension getPreferredSize() {
        final int width = super.getPreferredSize().width;
        return new Dimension(width, DEFAULT_HEIGHT);
    }

    @Override
    public Dimension getMaximumSize() {
        return new Dimension(1000, DEFAULT_HEIGHT);
    }

    /**
     * Sets the value of the progress bar, if the new value is greater than the
     * previous value.
     *
     * @param newValue
     * @return whether or not the value was greater, and thus updated
     */
    public boolean setValueIfGreater(final int newValue) {
        final boolean greater = _value.setIfSignificantToUser(newValue);
        if (greater) {
            WidgetUtils.invokeSwingAction(() -> DCProgressBar.super.setValue(newValue));
        }
        return greater;
    }

    public boolean isShowAsFull() {
        return _showAsFull;
    }

    public void setShowAsFull(final boolean showAsFull) {
        _showAsFull = showAsFull;
    }

    @Override
    public int getValue() {
        return _value.get();
    }

    /**
     * @deprecated use {@link #setValueIfGreater(int)} instead.
     */
    @Deprecated
    @Override
    public void setValue(final int newValue) {
        setValueIfGreater(newValue);
    }

    protected int getBarWidth(final int value) {
        final int minimum = getMinimum();
        if (minimum > value) {
            return 0;
        }

        final int width = getWidth();
        final int maximum = getMaximum();
        if (value > maximum || _showAsFull) {
            return width;
        }

        final int adjustedMax = maximum - minimum;
        final int adjustedValue = value - minimum;
        final double completenessRatio = 1.0 * adjustedValue / adjustedMax;
        return (int) (width * completenessRatio);
    }

    public Color getProgressBarColor() {
        return _progressBarColor;
    }

    public void setProgressBarColor(final Color progressBarColor) {
        _progressBarColor = progressBarColor;
    }

    @Override
    protected void paintComponent(final Graphics g) {
        final int width = getWidth();
        final int height = getHeight();

        if (isOpaque()) {
            g.setColor(WidgetUtils.BG_COLOR_DARK);
            g.fillRect(0, 0, width, height);
        }

        final int barWidth;
        if (isIndeterminate()) {
            barWidth = 0;
        } else {
            barWidth = getBarWidth(getValue());
        }

        if (barWidth > 0) {
            g.setColor(_progressBarColor);
            g.fillRect(0, 0, barWidth, height / 2);
            g.setColor(WidgetUtils.slightlyDarker(_progressBarColor));
            g.fillRect(0, height / 2, barWidth, height / 2);

            g.setColor(WidgetUtils.slightlyBrighter(_progressBarColor));
            g.drawRect(0, 0, barWidth, height);
        }
    }
}