001    /* JAPI - (Yet another (hopefully) useful) Java API
002     *
003     * Copyright (C) 2004-2006 Christian Hujer
004     *
005     * This program is free software; you can redistribute it and/or
006     * modify it under the terms of the GNU General Public License as
007     * published by the Free Software Foundation; either version 2 of the
008     * License, or (at your option) any later version.
009     *
010     * This program is distributed in the hope that it will be useful, but
011     * WITHOUT ANY WARRANTY; without even the implied warranty of
012     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013     * General Public License for more details.
014     *
015     * You should have received a copy of the GNU General Public License
016     * along with this program; if not, write to the Free Software
017     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
018     * 02111-1307, USA.
019     */
020    
021    package net.sf.japi.swing;
022    
023    import java.awt.Component;
024    
025    /** Interface for classes that are able to display progress.
026     * @author <a href="mailto:chris@riedquat.de">Christian Hujer</a>
027     */
028    public interface Progress {
029    
030        /** Progress has finished. */
031        void finished();
032    
033        /** Get the Component that is responsible for rendering the progress.
034         * This is useful if it is neccessary to open dialogs during the progress.
035         * @return Component responsible for rendering the progress
036         */
037        Component getParentComponent();
038    
039        /** Set progress information text.
040         * @param msg progress information text
041         * @param max maximum progress value
042         */
043        void setLabel(String msg, int max);
044    
045        /** Set progress value.
046         * @param value progress value
047         */
048        void setValue(int value);
049    
050    } // interface Progress