org.xnap.commons.gui
Class ProgressDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.xnap.commons.gui.DefaultDialog
                          org.xnap.commons.gui.ProgressDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, ProgressMonitor

public class ProgressDialog
extends DefaultDialog
implements ProgressMonitor

A simple progress dialog that displays text in a JLabel and a JProgressBar. The dialog can be used to monitor long running operations.

Author:

Steffen Pingel

See Also:

ProgressMonitor, Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static int

MAX_VALUE

Fields inherited from class org.xnap.commons.gui.DefaultDialog

BUTTON_APPLY, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTEXT_HELP, BUTTON_DEFAULTS, BUTTON_HELP, BUTTON_NONE, BUTTON_OKAY, isOkay

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

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

ProgressDialog()

ProgressDialog(int buttons)

ProgressDialog(int buttons, String title)

ProgressDialog(JDialog owner)

ProgressDialog(JDialog owner, int buttons, String title)

ProgressDialog(JDialog owner, String title)

ProgressDialog(JFrame owner)

ProgressDialog(JFrame owner, int buttons, String title)

ProgressDialog(JFrame owner, String title)

ProgressDialog(String title)

Method Summary

void	close() Sets the cancelled status to true.
void	done() Disposes the dialog.
Component	getComponent() Returns the component that displays the progress.
JPanel	getPanel()
long	getValue()
boolean	isCancelled() Returns true, if the operation has been cancelled by the user.
void	setCancelEnabled(boolean enabled) Enables the cancel button.
void	setText(String text) Sets the message text.
void	setTotalSteps(long max) Sets the maximum value.
void	setValue(long value) Sets the current value.
void	showDialog()
void	work(long amount) Increase the value by amount.

Methods inherited from class org.xnap.commons.gui.DefaultDialog

apply, cancelled, contextHelp, defaults, getApplyAction, getButtonPanel, getCancelAction, getCloseAction, getContextHelpAction, getDefaultsAction, getHelpAction, getMainPanel, getOkayAction, getTopPanel, help, isOkay, setApplyOnEnter, setButtonSeparatorVisible, setMainComponent, show

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MAX_VALUE

public static final int MAX_VALUE

See Also:

Constant Field Values

Constructor Detail

ProgressDialog

public ProgressDialog(JDialog owner,
                      int buttons,
                      String title)

ProgressDialog

public ProgressDialog(JFrame owner,
                      int buttons,
                      String title)

ProgressDialog

public ProgressDialog(int buttons,
                      String title)

ProgressDialog

public ProgressDialog(JDialog owner,
                      String title)

ProgressDialog

public ProgressDialog(JFrame owner,
                      String title)

ProgressDialog

public ProgressDialog(String title)

ProgressDialog

public ProgressDialog(int buttons)

ProgressDialog

public ProgressDialog(JDialog owner)

ProgressDialog

public ProgressDialog(JFrame owner)

ProgressDialog

public ProgressDialog()

Method Detail

close

public void close()

Sets the cancelled status to true.

Overrides:

close in class DefaultDialog

See Also:

DefaultDialog.isOkay()

done

public void done()

Disposes the dialog.

getPanel

public JPanel getPanel()

isCancelled

public boolean isCancelled()

Description copied from interface: ProgressMonitor

Returns true, if the operation has been cancelled by the user.

Specified by:

isCancelled in interface ProgressMonitor

getValue

public long getValue()

setCancelEnabled

public void setCancelEnabled(boolean enabled)

Description copied from interface: ProgressMonitor

Enables the cancel button.

Per default we assume cancelling is enabled.

Specified by:

setCancelEnabled in interface ProgressMonitor

setTotalSteps

public void setTotalSteps(long max)

Description copied from interface: ProgressMonitor

Sets the maximum value.

Specified by:

setTotalSteps in interface ProgressMonitor

setValue

public void setValue(long value)

Description copied from interface: ProgressMonitor

Sets the current value.

Specified by:

setValue in interface ProgressMonitor

Parameters:

value - min <= value <= max

work

public void work(long amount)

Description copied from interface: ProgressMonitor

Increase the value by amount.

Specified by:

work in interface ProgressMonitor

setText

public void setText(String text)

Description copied from interface: ProgressMonitor

Sets the message text.

Specified by:

setText in interface ProgressMonitor

showDialog

public void showDialog()

getComponent

public Component getComponent()

Description copied from interface: ProgressMonitor

Returns the component that displays the progress. This could be a dialog, a progress bar or null.

Specified by:

getComponent in interface ProgressMonitor

Returns:

null, if this monitor is not displayed by a component; the component, otherwise