de.must.wuic

Class BatchThreadControllerFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.must.wuic.MustFrame

de.must.wuic.BatchThreadControllerFrame

All Implemented Interfaces:

AliveConfirmer, AppTextResource, StatusInfoPresenter, ThreadController, ContextHelp, java.awt.event.ComponentListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

RemServerProcessControllerFrame

public class BatchThreadControllerFrame
extends MustFrame
implements ThreadController, StatusInfoPresenter, AliveConfirmer

Frame to control a process an show its progress.

See Also:

InterruptibleBatchThread, Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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
protected MustButton	buttonCancel
protected MustStatusLabel	statusLabel

Fields inherited from class de.must.wuic.MustFrame

defaultCursor, ownerFrame, waitCursor

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

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_CURSOR

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, 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
BatchThreadControllerFrame() Constructs a new batch thread controller frame.
BatchThreadControllerFrame(java.lang.String windowTitle)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsClosingDueToInactivity() Returns true if frame accepts closing due to inactivity.
protected void	cancelAction()
void	closeInstance() Closes this frame instance.
boolean	isClosingAllowed(int closeConfirmId) Returns true if closing of the window is allowed.
boolean	isToCancel() Returns true if the thread is to cancel.
boolean	isToRun() Returns true if the thread is to be continued.
void	setCancelButtonEnabled(boolean enabled) Enables or disables the cancel button.
protected void	setMessageToKeep(java.lang.String messageToKeep) Sets the message to be read by the user, it is not reset by generalActionEnding when action completed.
void	setStatusInformation(java.lang.String message) Sets the message to be read by the user, which is presented in the status label in this context.
void	taskIsDone() Called by the controlled batch thread when its task is done.

Methods inherited from class de.must.wuic.MustFrame

adjustSizeToPlausibleValue, bringToFrontAll, closeAll, closeAll, closeAllDueToInactivity, closeMainInstance, componentHidden, componentMoved, componentResized, componentShown, deiconifyAllExept, deregisterAsMainInstance, destroy, finalize, free, generalActionBeginnung, getAppResStr, getFrame, getHelpTarget, getHelpTopic, getLocale, getOrCreateMainInstance, getOrCreateMainInstance, getTranslation, iconifyAllExept, isCached, isClosingAllowedForAllFrames, isLaidOut, isRevivable, locateInCenter, logDebug, logError, logError, logError, logInfo, maximizeToBottomAndRight, open, packAndLocateInCenter, packAndLocateInCenterIfNotLaidOut, packIfNotLaidOut, popupMessage, reInitialize, setDefaultIconImage, setDefaultIconImages, setHelpContext, setHelpContext, setIconImages, setLocaleStatically, setTitle, toFront, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setUndecorated

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, 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, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack

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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

buttonCancel

protected MustButton buttonCancel

statusLabel

protected MustStatusLabel statusLabel

Constructor Detail

BatchThreadControllerFrame

public BatchThreadControllerFrame()

Constructs a new batch thread controller frame.

BatchThreadControllerFrame

public BatchThreadControllerFrame(java.lang.String windowTitle)

Method Detail

cancelAction

protected void cancelAction()

setCancelButtonEnabled

public void setCancelButtonEnabled(boolean enabled)

Enables or disables the cancel button. E.g. when the controlled thread waits for an external process, it doesn't make sense to keep the button enabled, because the button won't stop the external process. By default, the cancel button is enabled.

Specified by:

setCancelButtonEnabled in interface ThreadController

Parameters:

enabled - whether or not the cancel button should be enabled

isToCancel

public boolean isToCancel()

Returns true if the thread is to cancel. Is answered true if user clicked the cancel button meanwhile.

Specified by:

isToCancel in interface ThreadController

Returns:

true if the thread is to cancel

isToRun

public boolean isToRun()

Description copied from interface: AliveConfirmer

Returns true if the thread is to be continued. E.g. false is returned if user clicked a controller's cancel button meanwhile.

Specified by:

isToRun in interface AliveConfirmer

Returns:

true if the thread is to be continued

setStatusInformation

public void setStatusInformation(java.lang.String message)

Sets the message to be read by the user, which is presented in the status label in this context.

Specified by:

setStatusInformation in interface StatusInfoPresenter

Specified by:

setStatusInformation in interface ThreadController

Parameters:

message - the message for the user

setMessageToKeep

protected void setMessageToKeep(java.lang.String messageToKeep)

Sets the message to be read by the user, it is not reset by generalActionEnding when action completed. Thus, the user is able to notify the message without pressing a confirmation button.

Parameters:

messageToKeep - the message for the user

isClosingAllowed

public boolean isClosingAllowed(int closeConfirmId)

Description copied from class: MustFrame

Returns true if closing of the window is allowed.

Specified by:

isClosingAllowed in class MustFrame

Parameters:

closeConfirmId - the ID of the confirmation issue - a way to avoid multiple question regarding the same issue

Returns:

true if closing of the window is allowed

taskIsDone

public void taskIsDone()

Called by the controlled batch thread when its task is done. Closes the window.

Specified by:

taskIsDone in interface ThreadController

acceptsClosingDueToInactivity

public boolean acceptsClosingDueToInactivity()

Description copied from class: MustFrame

Returns true if frame accepts closing due to inactivity.

Specified by:

acceptsClosingDueToInactivity in class MustFrame

Returns:

true if frame accepts closing due to inactivity

closeInstance

public void closeInstance()

Closes this frame instance.

Overrides:

closeInstance in class MustFrame