/*
 * JSplash.java
 *
 * Copyright (c) 2004-2011 Gregory Kotsaftis
 * gregkotsaftis@yahoo.com
 * http://zeus-jscl.sourceforge.net/
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package gr.zeus.ui;

import gr.zeus.util.GUIUtils;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Font;
import java.net.URL;
import javax.swing.BorderFactory;
import javax.swing.JPanel;
import javax.swing.JProgressBar;
import javax.swing.JWindow;

/**
 * A simple, yet nice splash screen implementation for java applications.
 * Follows Sun recommendations for splash screen and logos: see
 * <a href="http://java.sun.com/products/jlf/ed2/book/HIG.Graphics7.html">
 * <i>"Designing Graphics for Corporate and Product Identity"</i></a>.
 * Draws a black border of one pixel wide around the splash image.
 * Also uses a simple progress bar that the user must "progress" manually in his
 * code in order for it to work. Also, it has options for percent display,
 * custom loading messages display and application version string display at the
 * bottom-right corner of the image.
 * <p>
 * @author Gregory Kotsaftis
 * @since 1.0
 */
public final class JSplash extends JWindow {

    /**
     * Progress bar to use in the splash screen.
     */
    private final JProgressBar m_progress = new JProgressBar();

    /**
     * Check for whether to use the progress bar or not.
     */
    private boolean m_progressBar = false;

    /**
     * Check for whether to use progress bar messages or not.
     */
    private boolean m_progressBarMessages = false;

    /**
     * Check for whether to use precentage values or not.
     */
    private boolean m_progressBarPercent = false;


    /**
     * Constructor for the splash window.
     * <p>
     * @param url                   Image for ImageIcon.
     * @param progress              Do we want a progress bar at all?
     * @param messages              If we want a progress bar, do we want to
     *                              display messages inside the progress bar?
     * @param percent               If we want a progress bar, do we want to
     *                              display the percent?
     * @param versionString         If null no string is displayed on the
     *                              bottom-right of the splash window.
     * @param versionStringFont     Font for version string, if null default.
     * @param versionStringColor    Color for version string, if null default.
     * <p>
     * <b>NOTE:</b> Use only one flag for: messages / percent
     * (one or the other, NOT both).
     */
    public JSplash(URL url,
        boolean progress, boolean messages, boolean percent,
        String versionString, Font versionStringFont, Color versionStringColor)
    {
        super();

        m_progressBar = progress;
        m_progressBarMessages = messages;
        m_progressBarPercent = percent;

        // build a panel with a black line for border,
        // and set it as the content pane
        //
        JPanel panel = new JPanel();
        panel.setLayout( new BorderLayout() );
        panel.setBorder( BorderFactory.createLineBorder( Color.BLACK ) );
        setContentPane( panel );

        // build a label and set it's icon
        //
        JSplashLabel label = new JSplashLabel(url,
                versionString, versionStringFont, versionStringColor);

        // build a progress bar
        //
        if( m_progressBar )
        {
            if( m_progressBarMessages || m_progressBarPercent )
            {
                m_progress.setStringPainted( true );
            }
            else
            {
                m_progress.setStringPainted( false );
            }

            if( m_progressBarMessages && !m_progressBarPercent )
            {
                m_progress.setString( "" );
            }

            m_progress.setMaximum( 100 );
            m_progress.setMinimum( 0 );
            m_progress.setValue( 0 );
        }

        // add the components to the panel
        //
        getContentPane().add(label, BorderLayout.CENTER);

        if( m_progressBar )
        {
            getContentPane().add(m_progress, BorderLayout.SOUTH);
        }

        // validate, and display the components
        pack();

        // center on screen
        GUIUtils.centerOnScreen( this );

        // hide the panel for now...
        setVisible( false );
    }


    /**
     * Displays the splash screen
     */
    public void splashOn()
    {
        setVisible( true );
    }


    /**
     * Hides and disposes the splash screen
     */
    public void splashOff()
    {
        setVisible( false );
        dispose();
    }


    /**
     * Sets the progress indicator (values: 0 - 100).
     * <p>
     * @param value     The progress indicator value.
     */
    public void setProgress(int value)
    {
        if( m_progressBar && value>=0 && value<=100 )
        {
            m_progress.setValue( value );
        }
    }


    /**
     * Sets the progress indicator (values: 0 - 100) and a label to print
     * inside the progress bar.
     * <p>
     * @param value     The progress indicator value.
     * @param msg       The message to print.
     */
    public void setProgress(int value, String msg)
    {
        setProgress( value );

        if( m_progressBarMessages && !m_progressBarPercent && msg!=null )
        {
            m_progress.setString( msg );
        }
    }


    /**
     * Get the progress bar for custom usage.
     * <p>
     * @return          The progress bar.
     */
    public final JProgressBar getProgressBar()
    {
        return( m_progress );
    }

}