de.must.wuic

Class MustContainer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

de.must.wuic.MustContainer

All Implemented Interfaces:

AppTextResource, MessageReceiver, WindowController, ContextHelp, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

AbstractDataListInlay, PresentationInlay, PropertyAdministrationInlay, PublishableContainer

public abstract class MustContainer
extends javax.swing.JComponent
implements ContextHelp, AppTextResource, WindowController

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MustContainer.Creator Creator class for container.
static interface	MustContainer.Owner

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

javax.swing.JComponent.AccessibleJComponent

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	destroyed
protected boolean	dirty
protected javax.swing.JLabel	header
protected MustContainer.Owner	owner
protected SessionResources	sd to unify multilingualism handling of web server and desktop applications
protected javax.swing.ImageIcon	specialImageIcon
protected MustStatusLabel	statusLabel

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
MustContainer(MustContainer.Owner owner)

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected void	free() Releases external resources.
void	generalActionBeginnung()
void	generalActionEnding()
java.lang.String	getAppResStr(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle.
java.awt.Container	getContentPane()
MustFrameWithStatusLabel	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
protected javax.swing.ImageIcon	getImageIcon(java.lang.String imageIconName)
java.util.Locale	getLocale()
javax.swing.JRootPane	getRootPane()
java.lang.String	getTranslation(java.lang.String key)
boolean	isCancelAllowed() Returns true if it is allowed to cancel user interaction.
boolean	isClosingAllowed() Returns true if closing of the window is allowed.
boolean	isClosingAllowed(int closeConfirmId)
void	receive(java.lang.String message)
DataObject	register(DataObject dataObject) Registers an object to free its external resources as soon as they are not needed any more.
void	register(Exemptible exemptible) Registers an object to free its external resources as soon as they are not needed any more.
void	resetMessage()
void	resetTemporaryMessage()
void	setDefaultButton(MustButton button)
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.
void	setMessage(java.lang.String message) Sets the message to be read by the user, which is presented in the status label in this context.
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	setMessageToKeep(java.lang.String messageToKeep, java.lang.Object origin) Sets the message to be read by the user, it is not reset by generalActionEnding when action completed.
void	setTitle(java.lang.String headerText)

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, 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

owner

protected MustContainer.Owner owner

sd

protected SessionResources sd

to unify multilingualism handling of web server and desktop applications

header

protected javax.swing.JLabel header

specialImageIcon

protected javax.swing.ImageIcon specialImageIcon

statusLabel

protected MustStatusLabel statusLabel

dirty

protected boolean dirty

destroyed

protected boolean destroyed

Constructor Detail

MustContainer

public MustContainer(MustContainer.Owner owner)

Method Detail

setTitle

public void setTitle(java.lang.String headerText)

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

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

getFrame

public MustFrameWithStatusLabel getFrame()

getRootPane

public javax.swing.JRootPane getRootPane()

Overrides:

getRootPane in class javax.swing.JComponent

getContentPane

public java.awt.Container getContentPane()

register

public void register(Exemptible exemptible)

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.

Parameters:

exemptible - the exemptible object to register

register

public DataObject register(DataObject dataObject)

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.

Parameters:

dataObject - the data object to register to be released at a suitable later moment

Returns:

the data object - this, this method can be included in nested instructions

getLocale

public java.util.Locale getLocale()

Overrides:

getLocale in class java.awt.Component

getTranslation

public java.lang.String getTranslation(java.lang.String key)

getImageIcon

protected javax.swing.ImageIcon getImageIcon(java.lang.String imageIconName)

isClosingAllowed

public boolean isClosingAllowed()

Returns true if closing of the window is allowed.

Returns:

true if closing of the window is allowed

isClosingAllowed

public boolean isClosingAllowed(int closeConfirmId)

generalActionBeginnung

public void generalActionBeginnung()

Specified by:

generalActionBeginnung in interface WindowController

generalActionEnding

public void generalActionEnding()

Specified by:

generalActionEnding in interface WindowController

setDefaultButton

public void setDefaultButton(MustButton button)

receive

public void receive(java.lang.String message)

Specified by:

receive in interface MessageReceiver

setMessage

public void setMessage(java.lang.String message)

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

Parameters:

message - the message for the user

setMessageToKeep

public 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

setMessageToKeep

public void setMessageToKeep(java.lang.String messageToKeep,
                             java.lang.Object origin)

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

origin - the origin witch caused message - special value to suppress dialog completely

resetMessage

public void resetMessage()

resetTemporaryMessage

public void resetTemporaryMessage()

isCancelAllowed

public boolean isCancelAllowed()

Returns true if it is allowed to cancel user interaction.

Returns:

true if it is allowed to cancel user interaction

free

protected void free()

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

destroy

public void destroy()