org.arch4j.ui.components
Class ProgressDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--org.arch4j.ui.components.ProgressDialog

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

public class ProgressDialog

extends JDialog

A ProgressFrame is a JDialog which presents a ProgressBar that callers can use to display the status of a given task Callers are expected to construct a new ProgressDialog() and use the appropriate methods to control the UI activity. Note: Callers must create a new thread to perform task activity (and NOT) use the main (AWT event dispatcher) thread or the UI becomes unresponsive. A hint: implementing Runnable is the easiest way to thread-ify a process.

See Also:

Serialized Form

Field Summary

protected JButton	m_cancelButton
protected boolean	m_cancelRequested
protected JLabel	m_detailedMessageText
protected JLabel	m_messageText
protected JProgressBar	m_progress

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(JFrame pOwnerFrame, boolean pCanRequestCancel)
Constructor

Method Summary

void	addActionListener(ActionListener l)
void	hideDialog() Hide the dialog (typically used after processing is complete).
void	increment(int anIncrement) Increment the progress bar for x number of tasks.
void	removeActionListener(ActionListener l)
void	reset() Reset attributes for next use.
void	setDetailedMessageText(String pMessageText) Set second of two message lines on progress dialog.
void	setMessageText(String pMessageText) Set first of two message lines on progress dialog.
void	setNumberOfSteps(int aNumberOfSteps) Set the maximum number of steps in the progress.
void	setPercentComplete(int pPercentComplete) Update the progress bar; set the value of the displayed percentage.
void	showDialog() Once all attributes are set, use this to show the dialog.
boolean	wasCancelRequested() Did the user request a cancellation?

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, dispose, 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, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

m_messageText

protected JLabel m_messageText

m_detailedMessageText

protected JLabel m_detailedMessageText

m_progress

protected JProgressBar m_progress

m_cancelButton

protected JButton m_cancelButton

m_cancelRequested

protected volatile boolean m_cancelRequested

Constructor Detail

ProgressDialog

public ProgressDialog(JFrame pOwnerFrame,
                      boolean pCanRequestCancel)

Constructor

Method Detail

addActionListener

public void addActionListener(ActionListener l)

removeActionListener

public void removeActionListener(ActionListener l)

reset

public void reset()

Reset attributes for next use.

wasCancelRequested

public boolean wasCancelRequested()

Did the user request a cancellation?

showDialog

public void showDialog()

Once all attributes are set, use this to show the dialog.

hideDialog

public void hideDialog()

Hide the dialog (typically used after processing is complete).

setMessageText

public void setMessageText(String pMessageText)

Set first of two message lines on progress dialog.

setDetailedMessageText

public void setDetailedMessageText(String pMessageText)

Set second of two message lines on progress dialog.

setNumberOfSteps

public void setNumberOfSteps(int aNumberOfSteps)

Set the maximum number of steps in the progress.

Parameters:

aNumberOfSteps - The max number of steps.

increment

public void increment(int anIncrement)

Increment the progress bar for x number of tasks.

Parameters:

anIncrement - The amount to increment the task bar for.

setPercentComplete

public void setPercentComplete(int pPercentComplete)

Update the progress bar; set the value of the displayed percentage. This value should be between 0 and 100.