com.lf.commons.dialog

Class TaskDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.dialog.TaskDialog

All Implemented Interfaces:

ConfigurableUnit, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class TaskDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, ConfigurableUnit

Controls a background task like a file search.

GUI applications can use this mechanism to properly block the main window while a task is running. If the task allows it can be cancelled (or the user must wait e.g. while data is copied onto a server). In addition to that the dialog allows the task to be completely run in the background, normally it can then be monitored more compactly by the app status bar.

Optionally this dialog shows a flag at the bottom for example if the dialog should not be created multiple times ("Always run in background").

The new custom area can be used to add own specialized components to show details for the executed tasks like tables with files, status values etc. The simplest custom component would be a text area showing all log messages produced so far.

Since:

1.5

Version:

$Revision: 1.58 $, $Date: 2016/01/01 15:43:02 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_BACKGROUND Represents the OK button.
static int	BUTTON_CANCEL Represents the Cancel button.
static int	BUTTON_CLOSE Represents the Close button.
static java.net.URL	ICON_ERROR Default error icon.
static java.net.URL	ICON_INFO Default info icon.
static java.net.URL	ICON_OK Default info icon.
static java.net.URL	ICON_WARNING Default error icon.

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
TaskDialog() Constructor method for the dialog (modeless).
TaskDialog(java.awt.Dialog owner) Constructor method for the dialog.
TaskDialog(java.awt.Frame owner) Constructor method for the dialog.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
void	allowEscapeOnKeyStroke(int strokeval) Adds a keyboard action to escape (close) the dialog (e.g. on escape).
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
static TaskDialog	createDefaultDialog(java.awt.Component comp, javax.swing.Icon icon, java.lang.String title, java.lang.String subtitle) Convenience method to create a preconfigured dialog instance.
static TaskDialog	createDefaultDialog(java.awt.Window parent, javax.swing.Icon icon, java.lang.String title, java.lang.String subtitle) Convenience method to create a preconfigured dialog instance.
int	execute() Shows the dialog on the screen and returns the code of the pressed button.
javax.swing.JCheckBox	getAutoBackground() Provides the flag to remember the auto-background property.
javax.swing.JCheckBox	getAutoClose() Provides the flag to remember the auto-close property.
javax.swing.JButton	getButton(int code) Getter for the managed buttons.
MessageLabel	getLabelMessage() Provides the component to print messages.
boolean	isTimeout() Has the dialog been closed by automatic timeout?
void	setBorderTitle(java.lang.String title) Sets the title displayed by the titled border.
void	setCustomComponent(TaskDialogCustom comp) Sets the optional component filling the custom area of this dialog.
void	setDefaultButton(int index) Sets the default button getting the focus.
void	setHelpID(java.lang.String helpid) Sets the optional help link to call the help system.
void	setTask(BackgroundTask task) Sets the task.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.
void	update() Updates the GUI of the dialog according to the current task state.
void	updateFinal() Updates the GUI of the dialog after the task terminated.

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

ICON_OK

public static java.net.URL ICON_OK

Default info icon.

ICON_INFO

public static java.net.URL ICON_INFO

Default info icon.

ICON_ERROR

public static java.net.URL ICON_ERROR

Default error icon.

ICON_WARNING

public static java.net.URL ICON_WARNING

Default error icon.

BUTTON_BACKGROUND

public static final int BUTTON_BACKGROUND

Represents the OK button.

See Also:

Constant Field Values

BUTTON_CLOSE

public static final int BUTTON_CLOSE

Represents the Close button.

See Also:

Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL

Represents the Cancel button.

See Also:

Constant Field Values

Constructor Detail

TaskDialog

public TaskDialog()

Constructor method for the dialog (modeless).

Since:

1.5

TaskDialog

public TaskDialog(java.awt.Frame owner)

Constructor method for the dialog.

Parameters:

owner - The owner frame

Since:

1.5

TaskDialog

public TaskDialog(java.awt.Dialog owner)

Constructor method for the dialog.

Parameters:

owner - The owner dialog

Since:

1.5

Method Detail

allowEscapeOnKeyStroke

public void allowEscapeOnKeyStroke(int strokeval)

Adds a keyboard action to escape (close) the dialog (e.g. on escape).

The dialog is not disposed here since it may be recycled by an application. If the dialog can be closed by an escape character it also can be closed with the "X" window button. Normally this functionality is disabled.

Parameters:

strokeval - The desired escape key stroke like KeyEvent.VK_ESCAPE

Since:

1.6

setBorderTitle

public void setBorderTitle(java.lang.String title)

Sets the title displayed by the titled border.

Parameters:

title - Title displayed by the titled border, may be null

Since:

1.5

getAutoBackground

public javax.swing.JCheckBox getAutoBackground()

Provides the flag to remember the auto-background property.

Returns:

The flag check box

Since:

1.6

getAutoClose

public javax.swing.JCheckBox getAutoClose()

Provides the flag to remember the auto-close property.

Returns:

The flag check box

Since:

1.6

execute

public int execute()

Shows the dialog on the screen and returns the code of the pressed button.

Returns:

Code of the pressed button

createDefaultDialog

public static TaskDialog createDefaultDialog(java.awt.Component comp,
                             javax.swing.Icon icon,
                             java.lang.String title,
                             java.lang.String subtitle)

Convenience method to create a preconfigured dialog instance.

If the parent window cannot be determined the dialog is created modeless instead. All texts and buttons have to be added manually.

Parameters:

comp - The component to search the parental window

icon - The icon to be displayed

title - The text displayed by the dialog window

subtitle - The text displayed by the titled border

Returns:

The dialog

Since:

1.5

createDefaultDialog

public static TaskDialog createDefaultDialog(java.awt.Window parent,
                             javax.swing.Icon icon,
                             java.lang.String title,
                             java.lang.String subtitle)

Convenience method to create a preconfigured dialog instance.

If the parent window cannot be determined the dialog is created modeless instead. All texts and buttons have to be added manually.

Parameters:

parent - The parental window

icon - The icon to be displayed

title - The text displayed by the dialog window

subtitle - The text displayed by the titled border

Returns:

The dialog

Since:

1.5

setDefaultButton

public void setDefaultButton(int index)

Sets the default button getting the focus.

Parameters:

index - The button index to get the focus

Since:

1.5

getButton

public javax.swing.JButton getButton(int code)

Getter for the managed buttons.

Parameters:

code - The desired button (BUTTON_BACKGROUND | ...)

Returns:

The desired button, null if not available

Since:

1.5

isTimeout

public boolean isTimeout()

Has the dialog been closed by automatic timeout?

Returns:

The timeout flag

Since:

1.6

setTask

public void setTask(BackgroundTask task)

Sets the task.

Parameters:

task - The task to be executed

Since:

1.5

update

public void update()

Updates the GUI of the dialog according to the current task state.

The duration and ETA is updated here as well as the progress if available. This method should be called from time to time to keep the dialog consistent with the task status.

This method must be executed by EDT thread since buttons are clicked!

Since:

1.5

updateFinal

public void updateFinal()

Updates the GUI of the dialog after the task terminated.

The dialog stays on the screen if the message text is set. If the status is ERROR or WARNING then an icon is displayed. The dialog is automatically closed by clicking "Cancel" if the final message is not set (null or empty).

This method must be executed by EDT thread since buttons are clicked!

Since:

1.5

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setHelpID

public void setHelpID(java.lang.String helpid)

Sets the optional help link to call the help system.

Parameters:

helpid - The help system link

Since:

1.6

setCustomComponent

public void setCustomComponent(TaskDialogCustom comp)

Sets the optional component filling the custom area of this dialog.

The new custom area can be used to add own specialized components to show details for the executed tasks like tables with files, status values etc. The simplest custom component would be a text area showing all log messages produced so far.

Parameters:

comp - The component

Throws:

java.lang.NullPointerException - If a aparameter is null

Since:

1.6

getLabelMessage

public MessageLabel getLabelMessage()

Provides the component to print messages.

Returns:

The label

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.5