public class ProgressWindow
extends javax.swing.JFrame
implements java.awt.event.ActionListener
By default it consists of two main feedback components.
Progress bar: a JProgressBar is used for
progress indication.
Text area: a JTextArea is used for more
elaborate feedback.
The progress bar is in indeterminate mode until the first call to
setValue.
Optionally, additional buttons can be added to the window. See the various constructors for the available options.
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSORBOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT| Constructor and Description |
|---|
ProgressWindow(boolean withTextArea)
Constructs a
ProgressWindow with a
progress bar ranging from 0 to 100. |
ProgressWindow(int theMinimum,
int theMaximum,
boolean withTextArea)
Constructs a
ProgressWindow with a
progress bar ranging from theMinimum
to theMaximum. |
ProgressWindow(int theMinimum,
int theMaximum,
boolean withTextArea,
boolean withStartPauseButton,
boolean withCancelButton,
boolean exitOnClose)
Constructs a
ProgressWindow with a
progress bar ranging from theMinimum
to theMaximum. |
| Modifier and Type | Method and Description |
|---|---|
void |
actionPerformed(java.awt.event.ActionEvent theEvent) |
boolean |
getIsCancelled()
Returns whether the
Cancel button has been pressed. |
boolean |
getIsClosed()
Returns whether the user attempted to close the window using the
window default
Close button (Look & Feel specific). |
void |
setValue(double theFraction,
java.lang.String theText)
Sets the value for the
JProgressBar used by the
window. |
void |
setValue(int thePercentage,
java.lang.String theText)
Sets the value for the
JProgressBar used by the
window. |
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, updateaddNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecoratedaddPropertyChangeListener, 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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFrontadd, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validateaction, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCyclepublic ProgressWindow(boolean withTextArea)
ProgressWindow with a
progress bar ranging from 0 to 100.
The progress bar is in indeterminate mode until the first call to
setValue.withTextArea - Controls whether the window will contain a
text area for reporting messages
received through setValue.public ProgressWindow(int theMinimum,
int theMaximum,
boolean withTextArea)
ProgressWindow with a
progress bar ranging from theMinimum
to theMaximum.
The progress bar is in indeterminate mode until the first call to
setValue.theMinimum - Sets the minimum value for the progress bar.theMaximum - Sets the maximum value for the progress bar.withTextArea - Controls whether the window will contain a
text area for reporting messages
received through setValue.public ProgressWindow(int theMinimum,
int theMaximum,
boolean withTextArea,
boolean withStartPauseButton,
boolean withCancelButton,
boolean exitOnClose)
ProgressWindow with a
progress bar ranging from theMinimum
to theMaximum.
The progress bar is in indeterminate mode until the first call to
setValue.
The withTextArea parameter controls whether the window will
contain a text area for reporting
messages received through setValue.
The withStartPauseButton parameter controls whether the window will
contain a button for starting and pausing
the current task.
The withCancelButton parameter controls whether the window will
contain a button for cancelling
the current task.
The exitOnClose parameter controls whether the window will close when
the close button is pressed. Setting it to false gives
the caller more control of what to do in such a case.
Use getIsClosed to see if the user made an
attempt to close the window.
theMinimum - Sets the minimum value for the progress bar.theMaximum - Sets the maximum value for the progress bar.withTextArea - If true, add a JTextArea.withStartPauseButton - If true, add a start button.withCancelButton - If true, add a cancel button.exitOnClose - If true, the window closes when the
(Look & Feel specific) close button is pressed.public void setValue(int thePercentage,
java.lang.String theText)
JProgressBar used by the
window.
If the window was created with the withTextArea
boolean set to true, the text supplied as
the second parameter will be placed on the text area of the window.
thePercentage - The percentage of finished work, must lie within
range [0, 100].theText - The text to place in the text area.public void setValue(double theFraction,
java.lang.String theText)
JProgressBar used by the
window.
If the window was created with the withTextArea
boolean set to true, the text supplied as
the second parameter will be placed on the text area of the window.
theFraction - The fraction of finished work, must lie within
range [0, 1].theText - The text to place in the text area.public boolean getIsCancelled()
Cancel button has been pressed.
Calling code should decide what to do in such a situation.
true iff the Cancel button
has been pressed, false otherwise.public boolean getIsClosed()
Close button (Look & Feel specific).
Calling code should decide what to do in such a situation.
true iff the close button
has been pressed, false otherwise.public void actionPerformed(java.awt.event.ActionEvent theEvent)
actionPerformed in interface java.awt.event.ActionListener