org.ka2ddo.yaac.gui

Class ProgressDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.ka2ddo.yaac.gui.ProgressDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, StatusListener

public class ProgressDialog
extends javax.swing.JDialog
implements StatusListener, java.lang.Runnable

This class implements a generalized progress dialog with a progress bar.

Author:

Andrew Pavlin, KA2DDO, James Palmer, AG5VQ

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ProgressDialog(java.awt.Window owner, java.lang.String title, boolean modal) Display a GUI progress dialog.

Method Summary

Modifier and Type	Method and Description
boolean	isAborted() Test whether the user has requested that the long-running operation be aborted.
boolean	isOperationComplete() Test whether the operation monitored by this StatusListener is done.
void	run() Do not call.
void	setAbortListener(AbortListener abortListener) Register an asynchronous callback to indicate the user requested cancellation.
void	setOperationComplete() Report that the long-running operation is done.
void	updateMessage(java.lang.String msg) Update the status message for this operation.
void	updateProgress(double percent) Update the progress percentage for this operation.
void	updateStatus(java.lang.String msg, double percent) Update the status message and progress percentage for this operation.
void	updateStatusSynchronously(java.lang.String msg, double percent) Update the status message and progress percentage for this operation, blocking until the GUI is updated.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ka2ddo.yaac.core.StatusListener

show

Constructor Detail

ProgressDialog

public ProgressDialog(java.awt.Window owner,
                      java.lang.String title,
                      boolean modal)

Display a GUI progress dialog.

Parameters:

owner - the parent Window owning the progress dialog

title - the already-localized title string for the progress dialog

modal - boolean true if dialog should be modal for its parent window hierarchy

Method Detail

setAbortListener

public void setAbortListener(AbortListener abortListener)

Register an asynchronous callback to indicate the user requested cancellation.

Specified by:

setAbortListener in interface StatusListener

Parameters:

abortListener - AbortListener to call from UI thread when cancellation is requested, or null to remove cancellation

updateMessage

public void updateMessage(java.lang.String msg)
                   throws UserAbort

Update the status message for this operation.

Specified by:

updateMessage in interface StatusListener

Parameters:

msg - String message to display

Throws:

UserAbort - if user wants to stop long-running operation

updateProgress

public void updateProgress(double percent)
                    throws UserAbort

Update the progress percentage for this operation.

Specified by:

updateProgress in interface StatusListener

Parameters:

percent - percent complete in the range 0 to 100.

Throws:

UserAbort - if user wants to stop long-running operation

updateStatus

public void updateStatus(java.lang.String msg,
                         double percent)
                  throws UserAbort

Update the status message and progress percentage for this operation.

Specified by:

updateStatus in interface StatusListener

Parameters:

msg - String message to display

percent - percent complete in the range 0 to 100.

Throws:

UserAbort - if user wants to stop long-running operation

updateStatusSynchronously

public void updateStatusSynchronously(java.lang.String msg,
                                      double percent)
                               throws UserAbort

Update the status message and progress percentage for this operation, blocking until the GUI is updated.

Specified by:

updateStatusSynchronously in interface StatusListener

Parameters:

msg - String message to display

percent - percent complete in the range 0 to 100.

Throws:

UserAbort - if user wants to stop long-running operation

setOperationComplete

public void setOperationComplete()

Report that the long-running operation is done.

Specified by:

setOperationComplete in interface StatusListener

isOperationComplete

public boolean isOperationComplete()

Test whether the operation monitored by this StatusListener is done. Used to allow one thread to test the result of another thread's execution.

Specified by:

isOperationComplete in interface StatusListener

Returns:

boolean true if operation has been reported complete

isAborted

public boolean isAborted()

Test whether the user has requested that the long-running operation be aborted. This is useful so that threads other than the one that received a UserAbort exception can also clean up.

Specified by:

isAborted in interface StatusListener

Returns:

boolean true if operation has been aborted by user

run

public void run()

Do not call. Callback for updating progress dialog on the GUI thread.

Specified by:

run in interface java.lang.Runnable