StepMonitor.java

//----------------------------------------------------------------------------//
//                                                                            //
//                           S t e p M o n i t o r                            //
//                                                                            //
//----------------------------------------------------------------------------//
// <editor-fold defaultstate="collapsed" desc="hdr">                          //
//  Copyright © Hervé Bitteur and others 2000-2013. All rights reserved.      //
//  This software is released under the GNU General Public License.           //
//  Goto http://kenai.com/projects/audiveris to report bugs or suggestions.   //
//----------------------------------------------------------------------------//
// </editor-fold>
package omr.step;

import omr.constant.Constant;
import omr.constant.Constant.Ratio;
import omr.constant.ConstantSet;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.awt.Graphics;

import javax.swing.JProgressBar;
import javax.swing.SwingUtilities;

/**
 * Class {@code StepMonitor} is the user interface entity that allows
 * to monitor step progression, and to require manually that a step be
 * performed.
 *
 * @author Hervé Bitteur
 * @author Brenton Partridge
 */
public class StepMonitor
{
    //~ Static fields/initializers ---------------------------------------------

    /** Usual logger utility */
    private static final Logger logger = LoggerFactory.getLogger(
            StepMonitor.class);

    /** Specific application parameters */
    private static final Constants constants = new Constants();

    //~ Instance fields --------------------------------------------------------
    //
    /** Progress bar for actions performed on sheet */
    private final JProgressBar bar = new MyJProgressBar();

    /** Total active demands */
    private int actives = 0;

    //~ Constructors -----------------------------------------------------------
    //
    //-------------//
    // StepMonitor //
    //-------------//
    /**
     * Create a user monitor on step processing.
     * This also starts a background working task to take care of all lengthy
     * processing.
     * There is exactly one instance of this class (and no instance when
     * running in batch mode)
     */
    public StepMonitor ()
    {
        bar.setToolTipText("On going Step activity");
        bar.setStringPainted(true);
        displayAnimation(false);
        bar.setString("");
    }

    //~ Methods ----------------------------------------------------------------
    //
    //--------------//
    // getComponent //
    //--------------//
    /**
     * Report the monitoring bar
     *
     * @return the step progress bar
     */
    public JProgressBar getComponent ()
    {
        return bar;
    }

    //-----------//
    // notifyMsg //
    //-----------//
    /**
     * Display a simple message in the progress window.
     *
     * @param msg the message to display
     */
    public void notifyMsg (final String msg)
    {
        SwingUtilities.invokeLater(
                new Runnable()
        {
            @Override
            public void run ()
            {
                bar.setString(msg);
            }
        });
    }

    //---------//
    // animate //
    //---------//
    /**
     * Sets the progress bar to show a percentage a certain amount above
     * the previous percentage value (or above 0 if the bar had been
     * indeterminate).
     * This method is called on every message logged (see LogStepMonitorHandler)
     */
    void animate ()
    {
        SwingUtilities.invokeLater(
                new Runnable()
        {
            @Override
            public void run ()
            {
                int old = bar.getValue();

                if (old > bar.getMinimum()) {
                    int diff = bar.getMaximum() - old;
                    int increment = (int) Math.round(
                            diff * constants.ratio.getValue());
                    bar.setIndeterminate(false);
                    bar.setValue(old + increment);
                }
            }
        });
    }

    //------------------//
    // displayAnimation //
    //------------------//
    /**
     * Switch on or off the display of the progress bar
     *
     * @param animating If false, deactivates all animation of the progress
     *                  bar. If true, activates an indeterminate or
     *                  pseudo-indeterminate animation.
     */
    final synchronized void displayAnimation (final boolean animating)
    {
        if (animating) {
            actives++;
            setBar(constants.ratio.getValue());
        } else {
            if (actives > 0) {
                actives--;
            }

            if (actives <= 0) {
                setBar(0);
            }
        }
    }

    //--------//
    // setBar //
    //--------//
    /**
     * Sets the progress bar to show a percentage.
     *
     * @param amount percentage, in decimal form, from 0.0 to 1.0
     */
    private void setBar (final double amount)
    {
        SwingUtilities.invokeLater(
                new Runnable()
        {
            @Override
            public void run ()
            {
                bar.setIndeterminate(false);

                int divisions = constants.divisions.getValue();
                bar.setMinimum(0);
                bar.setMaximum(divisions);
                bar.setValue((int) Math.round(divisions * amount));
            }
        });
    }

    //~ Inner Classes ----------------------------------------------------------
    //-----------//
    // Constants //
    //-----------//
    private static final class Constants
            extends ConstantSet
    {
        //~ Instance fields ----------------------------------------------------

        Constant.Integer divisions = new Constant.Integer(
                "divisions",
                1000,
                "Number of divisions (amount of precision) of step monitor, minimum 10");

        Ratio ratio = new Ratio(
                0.1,
                "Amount by which to increase step monitor percentage per animation, between 0 and 1");

    }

    //----------------//
    // MyJProgressBar //
    //----------------//
    private static class MyJProgressBar
            extends JProgressBar
    {
        //~ Methods ------------------------------------------------------------

        @Override
        public void paintComponent (Graphics g)
        {
            try {
                super.paintComponent(g);
            } catch (Exception ex) {
                // Nearly ignored
                logger.warn("StepMonitor. Ignored: {}", ex);
                repaint(); // To trigger another painting
            }
        }
    }
}