/* ----------------------------------------------------------------------------
   The Kiwi Toolkit - A Java Class Library
   Copyright (C) 1998-2004 Mark A. Lindner

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 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
   General Public License for more details.

   You should have received a copy of the GNU 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.
 
   The author may be contacted at: mark_a_lindner@yahoo.com
   ----------------------------------------------------------------------------
   $Log: ProgressDialog.java,v $
   Revision 1.10  2004/05/05 23:20:24  markl
   comment block updates

   Revision 1.9  2004/03/16 06:43:39  markl
   LocaleManager method change

   Revision 1.8  2004/01/23 00:06:28  markl
   javadoc corrections

   Revision 1.7  2003/01/19 09:39:38  markl
   Added new constructors that take a parent dialog.

   Revision 1.6  2001/03/20 00:54:56  markl
   Fixed deprecated calls.

   Revision 1.5  2001/03/12 09:56:56  markl
   KLabel/KLabelArea changes.

   Revision 1.4  2001/03/12 05:19:59  markl
   Source code cleanup.

   Revision 1.3  1999/04/19 06:06:32  markl
   I18N changes, new constructor.

   Revision 1.2  1999/01/10 03:22:17  markl
   added GPL header & RCS tag
   ----------------------------------------------------------------------------
*/

package kiwi.ui.dialog;

import java.awt.*;
import java.awt.event.*;
import javax.swing.border.EmptyBorder;
import javax.swing.*;

import kiwi.ui.*;
import kiwi.util.*;

/** A simple dialog with a message and progress meter, for use when a
  * non-interruptible, lengthy task is being performed. The dialog tracks the
  * progress of a <code>Task</code>, which periodically notifies the dialog
  * of the percentage of the task completed. 
  *
  * <p><center>
  * <img src="snapshot/ProgressDialog.gif"><br>
  * <i>An example ProgressDialog.</i>
  * </center>
  *
  * @see kiwi.util.Task
  *
  * @author Mark Lindner
  */

public class ProgressDialog extends KDialog implements ProgressObserver
  {
  private JProgressBar bar;
  private KLabel label, iconLabel;

  /** Construct a new <code>ProgressDialog</code> with a default title.
    *
    * @param parent The parent window for this dialog.
    * @param modal A flag specifying whether the dialog should be modal.
    */
  
  public ProgressDialog(Frame parent, boolean modal)
    {
    this(parent, "", modal);
    }

  /** Construct a new <code>ProgressDialog</code> with a default title.
    *
    * @param parent The parent window for this dialog.
    * @param modal A flag specifying whether the dialog should be modal.
    *
    * @since Kiwi 1.4
    */
  
  public ProgressDialog(Dialog parent, boolean modal)
    {
    this(parent, "", modal);
    }
  
  /** Construct a new <code>ProgressDialog</code>.
    *
    * @param parent The parent window for this dialog.
    * @param title The title for the dialog window.
    * @param modal A flag specifying whether the dialog should be modal.
    */

  public ProgressDialog(Frame parent, String title, boolean modal)
    {
    super(parent, title, modal);

    _init();
    }

  /**
   */

  /** Construct a new <code>ProgressDialog</code>.
    *
    * @param parent The parent window for this dialog.
    * @param title The title for the dialog window.
    * @param modal A flag specifying whether the dialog should be modal.
    *
    * @since Kiwi 1.4
    */

  public ProgressDialog(Dialog parent, String title, boolean modal)
    {
    super(parent, title, modal);

    _init();
    }  

  /*
   */
  
  private void _init()
    {
    LocaleData loc = LocaleManager.getDefault().getLocaleData("KiwiDialogs");
    
    setResizable(false);
    setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);

    KPanel main = getMainContainer();

    main.setLayout(new BorderLayout(5, 5));
    main.setBorder(KiwiUtils.defaultBorder);

    main.add("North", label
             = new KLabel(loc.getMessage("kiwi.dialog.prompt.wait")));

    KPanel p = new KPanel();
    p.setLayout(new FlowLayout(FlowLayout.LEFT, 5, 5));

    iconLabel = new KLabel(KiwiUtils.getResourceManager()
                           .getIcon("ani-gear.gif"));
    p.add(iconLabel);

    bar = new JProgressBar();
    bar.setMinimum(0);
    bar.setMaximum(100);
    bar.setValue(0);
    bar.setOpaque(false);
    p.add(bar);

    main.add("Center", p);

    if(getTitle().length() == 0)
      setTitle(loc.getMessage("kiwi.dialog.title.progress"));

    pack();
    }

  /** Implementation of the <code>ProgressObserver</code> interface. */

  public void setProgress(int progress)
    {
    if(progress < 0) progress = 0;
    else if(progress > 100) progress = 100;

    bar.setValue(progress);
    if(progress == 100)
      {
      KiwiUtils.paintImmediately(bar);
      KiwiUtils.sleep(1);
      setVisible(false);
      }
    }

  /** Set the dialog's icon. The dialog's icon can be changed via a call to
    * this method. Animated GIF images add a professional touch when used with
    * <code>ProgressDialog</code>s.
    *
    * @param icon The new icon to use.
    */

  public void setIcon(Icon icon)
    {
    iconLabel.setIcon(icon);
    }

  /** Set the message for the dialog.
    *
    * @param message The message to display in the dialog.
    */

  public void setMessage(String message)
    {
    label.setText(message);
    pack();
    }

  /** Track the progress of a task. Displays the dialog and tracks the progress
    * of the task, updating the progress meter accordingly. When the task
    * is completed, the dialog automatically disappears.
    *
    * @param task The <code>Task</code> to track; it should not be currently
    * running, as the dialog will start the task itself.
    */
  
  public void track(Task task)
    {
    bar.setValue(0);
    task.addProgressObserver(this);
    Thread t = new Thread(task);
    t.start();
    setVisible(true);
    task.removeProgressObserver(this);
    }

  }

/* end of source file */