kiwi.ui.dialog
Class ProgressDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--kiwi.ui.dialog.KDialog
                                      |
                                      +--kiwi.ui.dialog.ProgressDialog

public class ProgressDialog
extends KDialog
implements ProgressObserver

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 Task, which periodically notifies the dialog of the percentage of the task completed.


An example ProgressDialog.

Version:
1.1 (10/98)
Author:
Mark Lindner, PING Software Group
See Also:
Task, Serialized Form

Inner classes inherited from class javax.swing.JDialog
JDialog.AccessibleJDialog
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
ProgressDialog(Frame parent, String title, boolean modal)
          Construct a new ProgressDialog.
 
Method Summary
 void setIcon(Icon icon)
          Set the dialog's icon.
 void setMessage(String message)
          Set the message for the dialog.
 void setProgress(int progress)
          Implementation of the ProgressObserver interface.
 void track(Task task)
          Track the progress of a task.
 
Methods inherited from class kiwi.ui.dialog.KDialog
addDialogDismissListener, dispose, fireDialogDismissed, fireDialogDismissed, getMainContainer, removeDialogDismissListener, setTexture
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processWindowEvent, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, isModal, isResizable, setModal, setResizable, setTitle, show
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProgressDialog

public ProgressDialog(Frame parent,
                      String title,
                      boolean modal)
Construct a new ProgressDialog.
Parameters:
parent - The parent window.
title - The title for the dialog window.
Method Detail

setProgress

public void setProgress(int progress)
Implementation of the ProgressObserver interface.
Specified by:
setProgress in interface ProgressObserver

setIcon

public void setIcon(Icon icon)
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 ProgressDialogs.
Parameters:
icon - The new icon to use.

setMessage

public void setMessage(String message)
Set the message for the dialog.
Parameters:
message - The message to display in the dialog.
runnable - A runnable object to run in a thread once the dialog is displayed.

track

public void track(Task task)
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.
Parameters:
task - The Task to track; it should not be currently running, as the dialog will start the task itself.