de.must.wuic

Class MustDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

de.must.wuic.MustDialog

All Implemented Interfaces:

AppTextResource, Exemptible, ExemptibleManager, ContextHelp, 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:

DBWaitDialog, DiDltD, DiPrTxD, DiSaveCancelReturnD, InfoDialog, PageViewer, ParameterDialog, PartialRemoveDialog, SelectDialog, WaitForFrame

public abstract class MustDialog
extends javax.swing.JDialog
implements ContextHelp, java.awt.event.WindowListener, ExemptibleManager, AppTextResource

A dialog with help context. Does not interpret shortcuts, but listens to help request F1

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
protected boolean	alreadyMadeInvisible
static java.awt.Cursor	defaultCursor
protected MustDialog	ownerDialog
protected java.awt.Frame	ownerFrame
protected FrontendResources	sd
static boolean	storedLayout
static java.awt.Cursor	waitCursor

Fields inherited from class javax.swing.JDialog

accessibleContext, 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
MustDialog()
MustDialog(java.awt.Frame ownerFrame) Constructs a new dialog with the specified owner frame.
MustDialog(MustDialog ownerDialog) Constructs a new dialog with the specified owner frame.

Method Summary

Modifier and Type	Method and Description
abstract boolean	acceptsClosingDueToInactivity() Returns true if frame accepts closing due to inactivity.
protected boolean	adjustSizeToPlausibleValue() Checks whether the width laid out by user is less then the width resulting by pack(), resizes the frame in this case to the packed value and returns true.
static void	closeAll() Closes all dialogs.
static void	closeAllDueToInactivity() Closes all dialogs that accept closing due to inactivity.
void	closeInstance() Closes the instance after reminding size and position of the frame as it was laid-out by the user.
void	free() Releases external resources.
java.lang.String	getAppResStr(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle.
MustDialog	getFrame()
java.lang.String	getHelpTarget() Returns the target of the component's help context
java.lang.String	getHelpTopic() Returns the topic of the component's help context
javax.swing.JRootPane	getRootPane()
protected java.lang.String	getTranslation(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle of the package.
boolean	isLaidOut() Returns true if the frame has already been laid-out.
protected void	locateInCenter() Centers the dialog on screen.
protected void	packAndLocateInCenter() Packs the dialog and centers it.
protected void	packAndLocateInCenterIfNotLaidOut() Packs the dialog and centers it, if it was't already laid-out.
protected void	packIfNotLaidOut() Packs the frame if it isn't already laid-out by user.
protected void	popupMessage(java.lang.String messageToKeep)
static void	prepareForProgrammaticalClosing() Prepares dialogs to be programmatically closed.
void	register(Exemptible exemptible) Registers an object to free its external resources as soon as they are not needed any more.
protected void	setDefaultLocation(int x, int y) Sets the location of the frame
protected void	setDefaultSize(java.awt.Dimension LayoutDim) Constructs a frame using specified dimension(width & height).
void	setHelpContext(java.lang.String helpTopic) Sets the component's context help.
void	setHelpContext(java.lang.String helpTopic, java.lang.String helpTarget) Sets the component's context help.
protected void	setIconImages(java.lang.String[] imageIconNames, ImageResource imageResource)
void	setImageIcon(java.lang.String imageIconName)
void	setTitle(java.lang.String title)
void	setVisible(boolean b)
void	windowActivated(java.awt.event.WindowEvent e)
void	windowClosed(java.awt.event.WindowEvent e)
void	windowClosing(java.awt.event.WindowEvent e)
void	windowDeactivated(java.awt.event.WindowEvent e)
void	windowDeiconified(java.awt.event.WindowEvent e)
void	windowIconified(java.awt.event.WindowEvent e)
void	windowOpened(java.awt.event.WindowEvent e)

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, 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, setUndecorated, 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

defaultCursor

public static java.awt.Cursor defaultCursor

waitCursor

public static java.awt.Cursor waitCursor

storedLayout

public static boolean storedLayout

ownerFrame

protected java.awt.Frame ownerFrame

sd

protected FrontendResources sd

ownerDialog

protected MustDialog ownerDialog

alreadyMadeInvisible

protected boolean alreadyMadeInvisible

Constructor Detail

MustDialog

public MustDialog()

MustDialog

public MustDialog(java.awt.Frame ownerFrame)

Constructs a new dialog with the specified owner frame.

Parameters:

ownerFrame - the frame which owns the dialog

MustDialog

public MustDialog(MustDialog ownerDialog)

Constructs a new dialog with the specified owner frame.

Parameters:

ownerFrame - the frame which owns the dialog

Method Detail

prepareForProgrammaticalClosing

public static void prepareForProgrammaticalClosing()

Prepares dialogs to be programmatically closed. Call this method before calling closeAllDueToInactivity.

closeAllDueToInactivity

public static void closeAllDueToInactivity()

Closes all dialogs that accept closing due to inactivity. prepareForProgrammaticalClosing() has to be called previously to use this function.

closeAll

public static void closeAll()

Closes all dialogs. prepareForProgrammaticalClosing() has to be called previously to use this function.

setIconImages

protected void setIconImages(java.lang.String[] imageIconNames,
                             ImageResource imageResource)

setTitle

public void setTitle(java.lang.String title)

Overrides:

setTitle in class java.awt.Dialog

getRootPane

public javax.swing.JRootPane getRootPane()

Specified by:

getRootPane in interface javax.swing.RootPaneContainer

Overrides:

getRootPane in class javax.swing.JDialog

getAppResStr

public java.lang.String getAppResStr(java.lang.String resourceKey)

Description copied from interface: AppTextResource

Returns a text in the corresponding language according to the locale specific resource bundle.

Specified by:

getAppResStr in interface AppTextResource

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

a text in the corresponding language according to the locale specific resource bundle

getTranslation

protected java.lang.String getTranslation(java.lang.String resourceKey)

Returns a text in the corresponding language according to the locale specific resource bundle of the package.

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

the resource

setDefaultSize

protected void setDefaultSize(java.awt.Dimension LayoutDim)

Constructs a frame using specified dimension(width & height).

Parameters:

layoutDim - layout dimension(width & height)

setDefaultLocation

protected void setDefaultLocation(int x,
                                  int y)

Sets the location of the frame

Parameters:

x - the frame's start location(x)

y - the frame's end location(y)

isLaidOut

public boolean isLaidOut()

Returns true if the frame has already been laid-out. This happens, when a user first uses the frame. For personalization, position and size of the frame is stored in a user specific local file.

Returns:

true if the frame has already been laid-out

See Also:

WinContr

packIfNotLaidOut

protected void packIfNotLaidOut()

Packs the frame if it isn't already laid-out by user.

locateInCenter

protected void locateInCenter()

Centers the dialog on screen.

packAndLocateInCenter

protected void packAndLocateInCenter()

Packs the dialog and centers it.

packAndLocateInCenterIfNotLaidOut

protected void packAndLocateInCenterIfNotLaidOut()

Packs the dialog and centers it, if it was't already laid-out.

adjustSizeToPlausibleValue

protected boolean adjustSizeToPlausibleValue()

Checks whether the width laid out by user is less then the width resulting by pack(), resizes the frame in this case to the packed value and returns true. Thus, all elements should be visible, even if they are not embedded in scroll panes. It also may happen that a new JRE renders components differently, bigger button sizes may be compensated that way. Disadvantage: also components in scroll panes will influence packed width, they will cause the frame to be resized even if not necessary.

Returns:

true if the packed size has been re-established

getFrame

public MustDialog getFrame()

setHelpContext

public void setHelpContext(java.lang.String helpTopic)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

setHelpContext

public void setHelpContext(java.lang.String helpTopic,
                           java.lang.String helpTarget)

Sets the component's context help.

Specified by:

setHelpContext in interface ContextHelp

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpTopic

public java.lang.String getHelpTopic()

Returns the topic of the component's help context

Specified by:

getHelpTopic in interface ContextHelp

Returns:

the topic of the component's help context

getHelpTarget

public java.lang.String getHelpTarget()

Returns the target of the component's help context

Specified by:

getHelpTarget in interface ContextHelp

Returns:

the target of the component's help context

register

public void register(Exemptible exemptible)

Description copied from interface: ExemptibleManager

Registers an object to free its external resources as soon as they are not needed any more. The purpose of this registration is to ensure that already during the construction of this object, that certain resources are automatically released at a suitable later moment.

Specified by:

register in interface ExemptibleManager

Parameters:

exemptible - the exemptible object to register

setImageIcon

public void setImageIcon(java.lang.String imageIconName)

popupMessage

protected void popupMessage(java.lang.String messageToKeep)

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)

Specified by:

windowOpened in interface java.awt.event.WindowListener

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

acceptsClosingDueToInactivity

public abstract boolean acceptsClosingDueToInactivity()

Returns true if frame accepts closing due to inactivity.

Returns:

true if frame accepts closing due to inactivity

free

public void free()

Description copied from interface: ExemptibleManager

Releases external resources. May be called manually without waiting for garbage collection to occur.

Specified by:

free in interface Exemptible

Specified by:

free in interface ExemptibleManager

closeInstance

public void closeInstance()

Closes the instance after reminding size and position of the frame as it was laid-out by the user.

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class java.awt.Dialog