info.bioinfweb.commons.swing

Class ProgressDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

info.bioinfweb.commons.swing.ProgressDialog

All Implemented Interfaces:

ProgressMonitor, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ProgressDialog
extends javax.swing.JDialog
implements ProgressMonitor

A modal dialog displaying a progress bar that can be updated using the methods of ProgressMonitor.

This dialog is an alternative to ProgressMonitor in Swing, which cannot be displayed modal.

Usage example

 final ProgressDialog progressDialog = new ProgressDialog(getMainFrame(), "Doing something...");
 new SwingWorker<Void, Void>() {
        @Override
       protected Void doInBackground() throws Exception {
         doSomething();  // In here an update method (e.g. setProgressValue(double)) should be called regularly.
         return null;
       }

        @Override
       protected void done() {
         progressDialog.dispose();
       }
     }.execute();  // Start processing in a separate thread.
 progressDialog.setVisible(true);  // Show modal dialog.
 

Since:

2.0.0

Author:

Ben Stöver

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

Modifier and Type	Field and Description
static java.text.DecimalFormat	DEFAULT_PROGRESS_FORMAT

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) Creates a new instance of this class with the default cancel button and an updatable progress text which uses DEFAULT_PROGRESS_FORMAT to display the progrss value.
ProgressDialog(java.awt.Window owner, java.lang.String title, java.text.DecimalFormat progressFormat) Creates a new instance of this class with the default cancel button and an updatable progress text.
ProgressDialog(java.awt.Window owner, java.lang.String title, java.text.DecimalFormat progressFormat, boolean showText) Creates a new instance of this class with the default cancel button.
ProgressDialog(java.awt.Window owner, java.lang.String title, java.text.DecimalFormat progressFormat, boolean showText, java.lang.String buttonText) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addToProgressValue(double addend)
void	addToProgressValue(double addend, java.lang.String text)
protected javax.swing.JButton	getCancelButton()
protected javax.swing.JLabel	getLabel()
protected javax.swing.JProgressBar	getProgressBar()
java.lang.String	getProgressText()
double	getProgressValue()
boolean	isCanceled()
void	setProgressValue(double value)
void	setProgressValue(double value, java.lang.String text)

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

Field Detail

DEFAULT_PROGRESS_FORMAT

public static final java.text.DecimalFormat DEFAULT_PROGRESS_FORMAT

Constructor Detail

ProgressDialog

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

Creates a new instance of this class with the default cancel button and an updatable progress text which uses DEFAULT_PROGRESS_FORMAT to display the progrss value.

Parameters:

owner - the Window from which the dialog is displayed or null if this dialog has no owner

title - the String to display in the dialog's title bar or null if the dialog has no title

ProgressDialog

public ProgressDialog(java.awt.Window owner,
                      java.lang.String title,
                      java.text.DecimalFormat progressFormat)

Creates a new instance of this class with the default cancel button and an updatable progress text.

Parameters:

owner - the Window from which the dialog is displayed or null if this dialog has no owner

title - the String to display in the dialog's title bar or null if the dialog has no title

progressFormat - the decimal format to be used to display the progress value (If null is specified here, DEFAULT_PROGRESS_FORMAT will be used.)

ProgressDialog

public ProgressDialog(java.awt.Window owner,
                      java.lang.String title,
                      java.text.DecimalFormat progressFormat,
                      boolean showText)

Creates a new instance of this class with the default cancel button.

Parameters:

owner - the Window from which the dialog is displayed or null if this dialog has no owner

title - the String to display in the dialog's title bar or null if the dialog has no title

progressFormat - the decimal format to be used to display the progress value (If null is specified here, DEFAULT_PROGRESS_FORMAT will be used.)

showText - Specify true here, if an additional text (describing the current operation status) shall be displayed above the progress bar or false if only the progress bar shall be displayed.)

ProgressDialog

public ProgressDialog(java.awt.Window owner,
                      java.lang.String title,
                      java.text.DecimalFormat progressFormat,
                      boolean showText,
                      java.lang.String buttonText)

Creates a new instance of this class.

Parameters:

owner - the Window from which the dialog is displayed or null if this dialog has no owner

title - the String to display in the dialog's title bar or null if the dialog has no title

progressFormat - the decimal format to be used to display the progress value (If null is specified here, DEFAULT_PROGRESS_FORMAT will be used.)

showText - Specify true here, if an additional text (describing the current operation status) shall be displayed above the progress bar or false if only the progress bar shall be displayed.)

buttonText - the text to be displayed in the cancel button (If null is specified here, no cancel button will be available.)

Method Detail

getProgressBar

protected javax.swing.JProgressBar getProgressBar()

getLabel

protected javax.swing.JLabel getLabel()

getCancelButton

protected javax.swing.JButton getCancelButton()

getProgressValue

public double getProgressValue()

Specified by:

getProgressValue in interface ProgressMonitor

getProgressText

public java.lang.String getProgressText()

Specified by:

getProgressText in interface ProgressMonitor

setProgressValue

public void setProgressValue(double value)

Specified by:

setProgressValue in interface ProgressMonitor

setProgressValue

public void setProgressValue(double value,
                             java.lang.String text)

Specified by:

setProgressValue in interface ProgressMonitor

addToProgressValue

public void addToProgressValue(double addend)

Specified by:

addToProgressValue in interface ProgressMonitor

addToProgressValue

public void addToProgressValue(double addend,
                               java.lang.String text)

Specified by:

addToProgressValue in interface ProgressMonitor

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface ProgressMonitor