001    /* PAVLOV -- Multiple Choice Study System
002     * Copyright (C) 2000 - 2004 T.J. Willis
003     *
004     * This program is free software; you can redistribute it and/or
005     * modify it under the terms of the GNU General Public License
006     * as published by the Free Software Foundation; either version 2
007     * of the License, or (at your option) any later version.
008     *
009     * This program is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012     * GNU General Public License for more details.
013     *
014     * You should have received a copy of the GNU General Public License
015     * along with this program; if not, write to the Free Software
016     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
017     *
018     * $Header: /cvsroot/pavlov/net/sourceforge/pavlov/startup/AbstractStartupWindow.java,v 1.4 2004/05/10 15:33:21 tj_willis Exp $
019     */
020    package net.sourceforge.pavlov.startup;
021    import javax.swing.*;
022    
023    /**
024     * An interface that represents the functionality of a "Startup Window."  A
025     * window that displays an application's logo, copyright information, and
026     * its startup progress.
027     *
028     * @author <a href="mailto:tj_willis@users.sourceforge.net"></a>
029     * @version 1.0
030     */
031    public interface AbstractStartupWindow {
032    
033        /**
034         * Sets progress bar to howMuch percent, and gives it the given message.
035         * @param howMuch an <code>int</code> value
036         * @param msg a <code>String</code> value
037         */
038        void incrementStatus(int howMuch, String msg);
039    
040        /**
041         * Sets the progress percentage to the given number.
042         *
043         * @param n an <code>int</code> value
044         */
045        void setProgress(int n);
046    
047        /**
048         * Sets progress bar to howMuch percent, and gives it the given message.
049         * @param howMuch an <code>int</code> value
050         * @param msg a <code>String</code> value
051         */
052        void setStatus(int howMuch, String msg);
053    
054        /**
055         * Sets the progress text to the given string.
056         *
057         * @param t a <code>String</code> value
058         */
059        void setText(String t);
060    
061    
062        /**
063         * Implement this method to be informed of which JFrame represents
064         * the main application.  This allows the startup window to close itself
065         * when the main application is visible.
066         *
067         * @param frame a <code>JFrame</code> value
068         */
069        public abstract void setMainApp(JFrame frame);
070    
071    }