Class ProgressDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

VASSAL.tools.swing.ProgressDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class ProgressDialog
extends JDialog

A cancellable progress dialog.

Since:

3.1.0

Author:

Joel Uckelman

See Also:

• 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, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected final JButton	cancel
protected final JLabel	label
protected final EventListenerList	listeners
protected final JProgressBar	progbar

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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
ProgressDialog(Frame parent, String title, String text)	Creates a progress dialog.
ProgressDialog(Frame parent, String title, String text, boolean cancellable)	Creates a progress dialog.

Method Summary

Modifier and Type	Method	Description
void	addActionListener(ActionListener l)	Adds a cancellation listener.
static ProgressDialog	createOnEDT(Frame parent, String title, String text)	Creates a progress dialog on the EDT.
protected void	fireCancelledEvent(ActionEvent e)
ActionListener[]	getActionListeners()	Gets the list of cancellation listeners.
String	getLabel()	Gets the text label shown beneath the progress bar.
int	getProgress()	Gets the percentage displayed by the progress bar.
boolean	isIndeterminate()	Gets whether the progress bar is indeterminate.
boolean	isStringPainted()	Gets whether the progress bar contains a progress string.
void	removeActionListener(ActionListener l)	Removes cancellation listener.
void	setIndeterminate(boolean indet)	Sets whether the progress bar should be indeterminate.
void	setLabel(String text)	Sets the text label shown beneath the progress bar.
void	setProgress(int percent)	Sets the percentage for the progress bar.
void	setStringPainted(boolean painted)	Sets whether the progress bar should contain a progress string.

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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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 Details

label

protected final JLabel label

progbar

protected final JProgressBar progbar

cancel

protected final JButton cancel

listeners

protected final EventListenerList listeners

Constructor Details

ProgressDialog

public ProgressDialog(Frame parent,
 String title,
 String text,
 boolean cancellable)

Creates a progress dialog.

Parameters:

parent - the parent frame

title - the dialog title

text - the text beneath the progress bar

cancellable - show a cancel button if true

ProgressDialog

public ProgressDialog(Frame parent,
 String title,
 String text)

Creates a progress dialog.

Parameters:

parent - the parent frame

title - the dialog title

text - the text beneath the progress bar

Method Details

fireCancelledEvent

protected void fireCancelledEvent(ActionEvent e)

getLabel

public String getLabel()

Gets the text label shown beneath the progress bar.

Returns:

the text label

setLabel

public void setLabel(String text)

Sets the text label shown beneath the progress bar.

Parameters:

text - the text label

isIndeterminate

public boolean isIndeterminate()

Gets whether the progress bar is indeterminate.

Returns:

whether the progress bar is indeterminate

setIndeterminate

public void setIndeterminate(boolean indet)

Sets whether the progress bar should be indeterminate.

Parameters:

indet - whether the progress bar should beindeterminate

getProgress

public int getProgress()

Gets the percentage displayed by the progress bar.

Returns:

the percentage completed

setProgress

public void setProgress(int percent)

Sets the percentage for the progress bar.

Parameters:

percent - the percentage completed

isStringPainted

public boolean isStringPainted()

Gets whether the progress bar contains a progress string.

Returns:

whether the progress bar contains a progress string

setStringPainted

public void setStringPainted(boolean painted)

Sets whether the progress bar should contain a progress string.

Parameters:

painted - whether the progress bar should contain a progress string

addActionListener

public void addActionListener(ActionListener l)

Adds a cancellation listener.

Parameters:

l - the action listener

removeActionListener

public void removeActionListener(ActionListener l)

Removes cancellation listener.

Parameters:

l - the action listener

getActionListeners

public ActionListener[] getActionListeners()

Gets the list of cancellation listeners.

Returns:

the action listeners

createOnEDT

public static ProgressDialog createOnEDT(Frame parent,
 String title,
 String text)

Creates a progress dialog on the EDT. This is a convenience method to be used when a non-EDT thread needs to create a progress dialog in order to attach listeners to it.

Parameters:

parent - the parent frame

title - the dialog title

text - the text beneath the progress bar