com.xmlmind.guiutil

Class ThreadMonitorDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.xmlmind.guiutil.ThreadMonitorDialog

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

ThreadMonitorDialog2

public class ThreadMonitorDialog
extends JDialog
implements ActionListener

A dialog box allowing to monitor the execution of a thread.

This dialog box generally has a progress bar and always has a Cancel button which allows to interrupt the monitored thread at any time.

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 and Description
protected JButton	cancelButton
protected long	cancelDate
protected boolean	canceled
protected int	cancelMaxDuration
protected static int	DEFAULT_CANCEL_MAX_DURATION
protected Component	dialogAnchor
protected JLabel	iconLabel
protected String	messageLog
protected JTextComponent	messages
protected StoppableThread	monitoredThread
protected Timer	monitorTimer
protected Component	parentComponent
protected JProgressBar	progressBar
protected MultiLineJLabel	subTitleLabel

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
ThreadMonitorDialog(Component parentComponent, String title, String subTitle, int rows, int columns, boolean hasProgressBar) Constructs a ThreadMonitorDialog.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	animateLastLine(String line, boolean firstFrame) To be invoked by the thread being monitored: replace last line displayed in the message area (if any) by specified line.
void	appendMessage(String message) Equivalent to appendMessage(message, Log.Level.INFO).
void	appendMessage(String message, Log.Level level) To be invoked by the thread being monitored: append specified message to the messages displayed in the message area (if any).
boolean	attachThread(StoppableThread thread) Attach to specified, already started, thread.
protected void	cancel()
protected JTextComponent	createMessages(int rows, int columns) Returns a JTextArea having specified number of rows and number of columns.
protected JScrollPane	createMessagesScroller(JTextComponent messages, int rows, int columns) Returns a JScrollPane containing specified text component.
protected void	doAnimateLastLine(String line, boolean firstFrame)
protected void	doAppendMessage(String message, Log.Level level)
protected boolean	doAttachThread(StoppableThread thread, boolean start)
protected void	doClearMessages()
protected void	doSetMessage(String message, Log.Level level)
protected void	doSetProgress(int step, int stepCount)
int	getCancelMaxDuration() Returns the grace time of a canceled thread.
protected static Icon	getDefaultIcon()
Icon	getIcon() Returns the icon of this dialog box.
String	getMessageLog() Returns the the name of the log where progress messages are logged.
protected void	initialize(Component parentComponent, String subTitle, int rows, int columns, boolean hasProgressBar)
protected static void	invokeAndWait(Runnable runnable)
boolean	isCanceled() To be invoked by the thread being monitored: Returns true if the user has canceled the task implemented by the thread being monitored; false otherwise.
boolean	isIndeterminateProgressBar() Returns the indeterminate mode of the progress bar.
protected JTextArea	messageArea()
protected void	monitor()
void	setCancelMaxDuration(int duration) Specifies the grace time of a canceled thread.
void	setIcon(Icon icon) Changes the icon of this dialog box.
void	setIndeterminateProgressBar(boolean indeterminate) Sets the progress bar to specified indeterminate mode.
void	setMessage(String message) Equivalent to setMessage(message, Log.Level.INFO).
void	setMessage(String message, Log.Level level) To be invoked by the thread being monitored: replace the messages displayed in the message area (if any) by specified message.
void	setMessageLog(String logName) Specifies the name of the log where progress messages are to be logged.
void	setProgress(int step, int stepCount) To be invoked by the thread being monitored: update the progress bar (if any).
boolean	startThread(StoppableThread thread) Attach to specified thread and start it.
static Log.Level	toLogLevel(Console.MessageType messageType) Converts specified Console message type to the corresponding log level.

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

parentComponent

protected Component parentComponent

dialogAnchor

protected Component dialogAnchor

iconLabel

protected JLabel iconLabel

subTitleLabel

protected MultiLineJLabel subTitleLabel

messages

protected JTextComponent messages

progressBar

protected JProgressBar progressBar

cancelButton

protected JButton cancelButton

messageLog

protected String messageLog

cancelMaxDuration

protected int cancelMaxDuration

monitoredThread

protected StoppableThread monitoredThread

monitorTimer

protected Timer monitorTimer

canceled

protected boolean canceled

cancelDate

protected long cancelDate

DEFAULT_CANCEL_MAX_DURATION

protected static final int DEFAULT_CANCEL_MAX_DURATION

See Also:

Constant Field Values

Constructor Detail

ThreadMonitorDialog

public ThreadMonitorDialog(Component parentComponent,
                           String title,
                           String subTitle,
                           int rows,
                           int columns,
                           boolean hasProgressBar)

Constructs a ThreadMonitorDialog.

Parameters:

parentComponent - the parent of the dialog box

title - the title of the dialog box

subTitle - a message displayed at the top of the dialog box

rows - the number of rows of the text area displaying the progress messages. Specify a negative or null number to suppress this text area.

columns - the number of rows of the text area displaying the progress messages. Specify a negative or null number to suppress this text area.

hasProgressBar - if true, the dialog box will have a progress bar

Method Detail

initialize

protected void initialize(Component parentComponent,
                          String subTitle,
                          int rows,
                          int columns,
                          boolean hasProgressBar)

createMessages

protected JTextComponent createMessages(int rows,
                                        int columns)

Returns a JTextArea having specified number of rows and number of columns.

createMessagesScroller

protected JScrollPane createMessagesScroller(JTextComponent messages,
                                             int rows,
                                             int columns)

Returns a JScrollPane containing specified text component.

setIcon

public void setIcon(Icon icon)

Changes the icon of this dialog box. By default, it's a 32x32 hourglass icon.

Parameters:

icon - the new icon. Specify null to use the default icon.

getDefaultIcon

protected static Icon getDefaultIcon()

getIcon

public Icon getIcon()

Returns the icon of this dialog box.

setIndeterminateProgressBar

public void setIndeterminateProgressBar(boolean indeterminate)

Sets the progress bar to specified indeterminate mode. Initially the progress bar is not in indeterminate mode. No effect if this dialog box has no progress bar.

isIndeterminateProgressBar

public boolean isIndeterminateProgressBar()

Returns the indeterminate mode of the progress bar. Returns false if this dialog box has no progress bar.

setMessageLog

public void setMessageLog(String logName)

Specifies the name of the log where progress messages are to be logged. May be null. Default value: null (progress messages are not logged).

getMessageLog

public String getMessageLog()

Returns the the name of the log where progress messages are logged.

See Also:

setMessageLog(java.lang.String)

setCancelMaxDuration

public void setCancelMaxDuration(int duration)

Specifies the grace time of a canceled thread. The monitored thread when canceled is supposed to stop in less than specified number of milliseconds. If after duration milliseconds, the monitored thread is still alive, it is forcibly terminated. Default value: 10000.

getCancelMaxDuration

public int getCancelMaxDuration()

Returns the grace time of a canceled thread.

See Also:

setCancelMaxDuration(int)

startThread

public boolean startThread(StoppableThread thread)

Attach to specified thread and start it.

See Also:

attachThread(com.xmlmind.util.StoppableThread)

attachThread

public boolean attachThread(StoppableThread thread)

Attach to specified, already started, thread.

See Also:

startThread(com.xmlmind.util.StoppableThread)

doAttachThread

protected boolean doAttachThread(StoppableThread thread,
                                 boolean start)

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

monitor

protected void monitor()

cancel

protected void cancel()

isCanceled

public boolean isCanceled()

To be invoked by the thread being monitored: Returns true if the user has canceled the task implemented by the thread being monitored; false otherwise.

setProgress

public void setProgress(int step,
                        int stepCount)

To be invoked by the thread being monitored: update the progress bar (if any).

setMessage

public void setMessage(String message)

Equivalent to setMessage(message, Log.Level.INFO).

setMessage

public void setMessage(String message,
                       Log.Level level)

To be invoked by the thread being monitored: replace the messages displayed in the message area (if any) by specified message. A newline is automatically added to specified message.

toLogLevel

public static Log.Level toLogLevel(Console.MessageType messageType)

Converts specified Console message type to the corresponding log level.

appendMessage

public void appendMessage(String message)

Equivalent to appendMessage(message, Log.Level.INFO).

appendMessage

public void appendMessage(String message,
                          Log.Level level)

To be invoked by the thread being monitored: append specified message to the messages displayed in the message area (if any). A newline is automatically added to specified message.

animateLastLine

public void animateLastLine(String line,
                            boolean firstFrame)

To be invoked by the thread being monitored: replace last line displayed in the message area (if any) by specified line. Doing this quickly produces an animation effect.

Parameters:

line - initial text line or replacement text line. Must not include newline characters.

firstFrame - if true, line is the initial text line. if false, line is a replacement text line.

invokeAndWait

protected static final void invokeAndWait(Runnable runnable)

doSetProgress

protected void doSetProgress(int step,
                             int stepCount)

doClearMessages

protected void doClearMessages()

doSetMessage

protected void doSetMessage(String message,
                            Log.Level level)

doAppendMessage

protected void doAppendMessage(String message,
                               Log.Level level)

doAnimateLastLine

protected void doAnimateLastLine(String line,
                                 boolean firstFrame)

messageArea

protected JTextArea messageArea()