de.esprit.appsuite.workflow.monitor

Class WorkflowMonitorDialog<C extends ApplicationContext>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

de.esprit.common.gui.ZDialog

de.esprit.appsuite.gui.ToolDialog<C>

de.esprit.appsuite.workflow.monitor.WorkflowMonitorDialog<C>

All Implemented Interfaces:

ApplicationToolWindow<C>, ApplicationObject<C>, Applieable, BorderLayoutConstants, Cancellable, Closeable, ToolWindow, SimpleLogSupport, Clearable, Dumpable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class WorkflowMonitorDialog<C extends ApplicationContext>
extends ToolDialog<C>

This dialog monitors the running WorkflowTasks within a AbstractWorkflow. It provides a checklist of task items which are automatically flagged when done.

Author:

Rainer Buesch

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 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 de.esprit.common.gui.comp.BorderLayoutConstants

CENTER, EAST, NORTH, SOUTH, WEST

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
WorkflowMonitorDialog(C ctx, AbstractWorkflow workflow)
WorkflowMonitorDialog(C ctx, AbstractWorkflow<C> workflow, java.awt.Window parent, java.awt.Component caller)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsoleMessage(java.lang.String message)
void	addTask(WorkflowTask task)
void	closeByIcon() Overridden to cancel the dialog
protected boolean	doOnCancel() May be overridden if a special action should be done on cancellation.
protected boolean	doOnClose() This method is called before this dialog is made invisible.
void	flagTaskAsSucceeded(int taskIndex)
protected boolean	hasCloseButton() Defines whether a Close button should be displayed (default false).
void	insertTask(int index, WorkflowTask task)
boolean	isDone()
void	popup(boolean isAutoClose)
void	setAutoCloseWhenFinished(boolean isAutoClose)
void	setDone(boolean isFailed)
void	setProgress(int taskIndex, TaskEvent e) Sets the progress for the TaskCheckLabel at the given taskIndex.
void	setTaskSkipped(int taskIndex)
void	setTextForTask(int taskIndex, java.lang.String taskName)

Methods inherited from class de.esprit.appsuite.gui.ToolDialog

addApplyListener, apply, cancel, clear, close, createButtonPanel, createWindowAdapter, doOnApply, doOnApplyError, doOnPopup, getApplicationContext, getApplier, getApplyAndCloseButton, getApplyButton, getButtonPanel, getCaller, getCancelButton, getClearButton, getCloseButton, getLogChannel, getPreferredWindowAlignment, getWindowAdapter, hasApplyAndCloseButton, hasApplyButton, hasButtonPanel, hasCancelButton, hasClearButton, isClosedOnApply, isLogDebug, isLogVerbose, locate, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, pack, popup, removeApplyListener, setDefaultButton, setLogChannel, setRelocateOnPopup, wasCancelled

Methods inherited from class de.esprit.common.gui.ZDialog

dispose, getMinimumHeight, getMinimumWidth, isDisposeOnClose, isErrorAttachable, isLocated, isPacked, registerSubDialog, repack, setLocation, setLocationRelativeTo, setLocationRelativeTo, setLocationToCenter, setTitle, setVisible, shiftLocation, toDumpString, toDumpString, toString, toString

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, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, 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, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocationByPlatform, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.esprit.appsuite.gui.ApplicationToolWindow

getRootPane

Methods inherited from interface de.esprit.common.gui.ToolWindow

getLocation, getMinimumHeight, getMinimumWidth, getSize, getTitle, getToolkit, isPacked, setLocation, setLocationRelativeTo, setMinimumSize, setPreferredSize, shiftLocation

Methods inherited from interface de.esprit.common.type.Dumpable

toDumpString, toDumpString, toString, toString

Constructor Detail

WorkflowMonitorDialog

public WorkflowMonitorDialog(C ctx,
                     AbstractWorkflow workflow)

WorkflowMonitorDialog

public WorkflowMonitorDialog(C ctx,
                     AbstractWorkflow<C> workflow,
                     java.awt.Window parent,
                     java.awt.Component caller)

Method Detail

closeByIcon

public void closeByIcon()

Description copied from class: ToolDialog

Overridden to cancel the dialog

Overrides:

closeByIcon in class ToolDialog<C extends ApplicationContext>

setAutoCloseWhenFinished

public void setAutoCloseWhenFinished(boolean isAutoClose)

setTaskSkipped

public void setTaskSkipped(int taskIndex)

setTextForTask

public void setTextForTask(int taskIndex,
                  java.lang.String taskName)

addTask

public void addTask(WorkflowTask task)

insertTask

public void insertTask(int index,
              WorkflowTask task)

hasCloseButton

protected final boolean hasCloseButton()

Description copied from class: ToolDialog

Defines whether a Close button should be displayed (default false). Note that the Close button just calls the close() method.

Overrides:

hasCloseButton in class ToolDialog<C extends ApplicationContext>

addConsoleMessage

public void addConsoleMessage(java.lang.String message)

doOnCancel

protected boolean doOnCancel()

Description copied from class: ToolDialog

May be overridden if a special action should be done on cancellation. If this method returns false no cancellation takes place.

Overrides:

doOnCancel in class ToolDialog<C extends ApplicationContext>

setProgress

public void setProgress(int taskIndex,
               TaskEvent e)

Sets the progress for the TaskCheckLabel at the given taskIndex. Note that the taskIndex is NOT the same as the childCount in the RunStateFlag. Repeating tasks for instance keep their index unchanged while the childCount is incremented.

setDone

public void setDone(boolean isFailed)

popup

public void popup(boolean isAutoClose)

doOnClose

protected boolean doOnClose()
                     throws java.lang.Exception

Description copied from class: ToolDialog

This method is called before this dialog is made invisible. Closing can be vetoed by returning false.

Overrides:

doOnClose in class ToolDialog<C extends ApplicationContext>

Returns:

true by default.

Throws:

java.lang.Exception

isDone

public boolean isDone()

flagTaskAsSucceeded

public void flagTaskAsSucceeded(int taskIndex)