de.must.wuic

Class MenuFrame

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.MustFrameWithStatusLabel

de.must.wuic.MenuFrame

All Implemented Interfaces:

AppTextResource, ContextHelp, MustContainer.Owner, PublishableContainer.Owner, 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

public abstract class MenuFrame
extends MustFrameWithStatusLabel
implements PublishableContainer.Owner

A menu frame.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MenuFrame.ContainerCreator

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 javax.swing.JPanel	bottomPanel
protected javax.swing.JPanel	centerPanel
protected MustMenuBar	menuBar Accessing methods of menuBar directly by the sub class will become deprecated since we want to avoid menu item disabled by entitlement
protected javax.swing.JPanel	toolbarPanel

Fields inherited from class de.must.wuic.MustFrameWithStatusLabel

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
MenuFrame()
MenuFrame(javax.swing.ImageIcon centerImage)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsClosingDueToInactivity() Returns true if frame accepts closing due to inactivity.
protected void	addMenuItem(java.lang.String menuText, boolean dialogBeforeAction, Callback callback)
protected void	addMenuItem(java.lang.String menuText, boolean dialogBeforeAction, int subjectArea, Callback callback)
protected void	addMenuItem(java.lang.String menuText, Callback callback)
protected void	addMenuItem(java.lang.String menuText, int subjectArea, Callback callback)
protected void	addMenuItem(java.lang.String menuText, int subjectArea, int keyEvent, Callback callback)
protected void	addMenuItem(java.lang.String menuText, int territory, int keyEvent, int keyControlEvent, Callback callback)
protected void	addMenuItem(java.lang.String imageIconName, java.lang.String menuText, boolean dialogBeforeAction, Callback callback)
protected void	addMenuItem(java.lang.String imageIconName, java.lang.String menuText, boolean dialogBeforeAction, int subjectArea, Callback callback)
protected void	addMenuItem(java.lang.String imageIconName, java.lang.String menuText, Callback callback)
protected void	addMenuItem(java.lang.String imageIconName, java.lang.String menuText, int subjectArea, Callback callback)
protected void	addMenuItem(java.lang.String imageIconName, java.lang.String menuText, int subjectArea, int keyEvent, Callback callback)
protected void	addMenuItem(java.lang.String imageIconName, java.lang.String menuText, int territory, int keyEvent, int keyControlEvent, Callback callback)
protected void	addSeparator()
protected void	beginSubMenu(java.lang.String menuText, int territory)
protected void	beginSubMenu(java.lang.String imageIconName, java.lang.String menuText, int territory)
void	callDirectly(java.lang.Class<? extends PublishableContainer> publishableContainer, MenuFrame.ContainerCreator containerCreator, java.lang.String initialMessage)
protected void	closeRequest() Handles user's intention to close windows and terminate application.
protected boolean	closeRequestPart1WithoutTerminating() Closes the main application windows if allowed and returns true if windows have been closed.
protected void	closeRequestPart2Terminating() Terminates background threads, releases external resources and terminate virtual machine by calling System.exit.
protected void	closeSubMenu()
protected void	creationEnding()
protected abstract EntitlementStd	getEntitlement()
MustFrameWithStatusLabel	getFrame()
boolean	interpret(java.awt.event.KeyEvent keyEventToInterpret, java.awt.Container context)
boolean	isClosingAllowed(int closeConfirmId) Returns true if closing of the window is allowed.
boolean	isEntitled(int area)
protected boolean	isToCollectAvailableFuntions()
protected javax.swing.JMenu	newMenu(java.lang.String menuText) Closes all sub menus and starts to build an new main menu with the given text.
protected javax.swing.JMenu	newMenu(java.lang.String menuText, int territory) Closes all sub menus and starts to build an new main menu with the given text.
PublishableContainer	open(java.lang.Class<? extends PublishableContainer> containerClass, int mode, MenuFrame.ContainerCreator creator)
PublishableContainer	open(java.lang.Class<? extends PublishableContainer> containerClass, MenuFrame.ContainerCreator creator)
protected void	packIfNotLaidOut() Packs the frame if it isn't already laid-out by user.
protected void	releaseExternalResources() Release external resources.
void	remove(PublishableContainer publishableContainer)
void	removeAllTabs()
void	removeTab(java.lang.Class<? extends PublishableContainer> containerClass)
void	setDefaultLocation(int width, int height)
void	setDefaultSize(java.awt.Dimension layoutDim)
void	setTitle(java.lang.String newTitle) Sets the title of the menu frame.
void	setTitle(java.lang.String newTitle, int licenceType) Sets the title of the menu frame with a hint to demo version if it is one.
void	windowClosing(java.awt.event.WindowEvent e) Called when window is going to be closed.

Methods inherited from class de.must.wuic.MustFrameWithStatusLabel

generalActionBeginnung, generalActionEnding, init, resetMessage, resetTemporaryMessage, setDefaultStatustext, setMessage, setMessageToKeep, setMessageToKeep

Methods inherited from class de.must.wuic.MustFrame

adjustSizeToPlausibleValue, bringToFrontAll, closeAll, closeAll, closeAllDueToInactivity, closeInstance, closeMainInstance, componentHidden, componentMoved, componentResized, componentShown, deiconifyAllExept, deregisterAsMainInstance, destroy, finalize, free, getAppResStr, getHelpTarget, getHelpTopic, getLocale, getOrCreateMainInstance, getOrCreateMainInstance, getTranslation, iconifyAllExept, isCached, isClosingAllowedForAllFrames, isLaidOut, isRevivable, locateInCenter, logDebug, logError, logError, logError, logInfo, maximizeToBottomAndRight, open, packAndLocateInCenter, packAndLocateInCenterIfNotLaidOut, popupMessage, reInitialize, setDefaultIconImage, setDefaultIconImages, setHelpContext, setHelpContext, setIconImages, setLocaleStatically, toFront, windowActivated, windowClosed, 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

menuBar

protected MustMenuBar menuBar

Accessing methods of menuBar directly by the sub class will become deprecated since we want to avoid menu item disabled by entitlement

toolbarPanel

protected javax.swing.JPanel toolbarPanel

centerPanel

protected javax.swing.JPanel centerPanel

bottomPanel

protected javax.swing.JPanel bottomPanel

Constructor Detail

MenuFrame

public MenuFrame()

MenuFrame

public MenuFrame(javax.swing.ImageIcon centerImage)

Method Detail

getEntitlement

protected abstract EntitlementStd getEntitlement()

creationEnding

protected void creationEnding()

setTitle

public void setTitle(java.lang.String newTitle,
                     int licenceType)

Sets the title of the menu frame with a hint to demo version if it is one.

Parameters:

newTitle - the regular title to set

licenceType - the license type

setTitle

public void setTitle(java.lang.String newTitle)

Sets the title of the menu frame.

Overrides:

setTitle in class MustFrame

Parameters:

newTitle - the new title of the menu frame

newMenu

protected javax.swing.JMenu newMenu(java.lang.String menuText)

Closes all sub menus and starts to build an new main menu with the given text.

Parameters:

menuText - the menu's label

newMenu

protected javax.swing.JMenu newMenu(java.lang.String menuText,
                                    int territory)

Closes all sub menus and starts to build an new main menu with the given text.

Parameters:

menuText - the menu's label

addSeparator

protected void addSeparator()

addMenuItem

protected void addMenuItem(java.lang.String menuText,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String imageIconName,
                           java.lang.String menuText,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String imageIconName,
                           java.lang.String menuText,
                           boolean dialogBeforeAction,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String menuText,
                           boolean dialogBeforeAction,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String menuText,
                           int subjectArea,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String menuText,
                           boolean dialogBeforeAction,
                           int subjectArea,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String menuText,
                           int subjectArea,
                           int keyEvent,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String menuText,
                           int territory,
                           int keyEvent,
                           int keyControlEvent,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String imageIconName,
                           java.lang.String menuText,
                           int subjectArea,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String imageIconName,
                           java.lang.String menuText,
                           boolean dialogBeforeAction,
                           int subjectArea,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String imageIconName,
                           java.lang.String menuText,
                           int subjectArea,
                           int keyEvent,
                           Callback callback)

addMenuItem

protected void addMenuItem(java.lang.String imageIconName,
                           java.lang.String menuText,
                           int territory,
                           int keyEvent,
                           int keyControlEvent,
                           Callback callback)

isToCollectAvailableFuntions

protected boolean isToCollectAvailableFuntions()

beginSubMenu

protected void beginSubMenu(java.lang.String menuText,
                            int territory)

beginSubMenu

protected void beginSubMenu(java.lang.String imageIconName,
                            java.lang.String menuText,
                            int territory)

closeSubMenu

protected void closeSubMenu()

setDefaultSize

public void setDefaultSize(java.awt.Dimension layoutDim)

setDefaultLocation

public void setDefaultLocation(int width,
                               int height)

packIfNotLaidOut

protected void packIfNotLaidOut()

Description copied from class: MustFrame

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

Overrides:

packIfNotLaidOut in class MustFrame

isEntitled

public boolean isEntitled(int area)

interpret

public boolean interpret(java.awt.event.KeyEvent keyEventToInterpret,
                         java.awt.Container context)

callDirectly

public void callDirectly(java.lang.Class<? extends PublishableContainer> publishableContainer,
                         MenuFrame.ContainerCreator containerCreator,
                         java.lang.String initialMessage)

open

public PublishableContainer open(java.lang.Class<? extends PublishableContainer> containerClass,
                                 MenuFrame.ContainerCreator creator)

open

public PublishableContainer open(java.lang.Class<? extends PublishableContainer> containerClass,
                                 int mode,
                                 MenuFrame.ContainerCreator creator)

removeTab

public void removeTab(java.lang.Class<? extends PublishableContainer> containerClass)

remove

public void remove(PublishableContainer publishableContainer)

Specified by:

remove in interface PublishableContainer.Owner

removeAllTabs

public void removeAllTabs()

windowClosing

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

Description copied from class: MustFrame

Called when window is going to be closed.

Specified by:

windowClosing in interface java.awt.event.WindowListener

Overrides:

windowClosing in class MustFrame

Parameters:

e - the window event

closeRequest

protected void closeRequest()

Handles user's intention to close windows and terminate application.

closeRequestPart1WithoutTerminating

protected boolean closeRequestPart1WithoutTerminating()

Closes the main application windows if allowed and returns true if windows have been closed. Virtual machine is not terminated by System.exit, yet. closeRequest() will terminate virtual machine later by calling closeRequestPart2Terminating(). If you do not want this, e.g. because backup is running, override this method and return false.

Returns:

true if windows have been closed

closeRequestPart2Terminating

protected void closeRequestPart2Terminating()

Terminates background threads, releases external resources and terminate virtual machine by calling System.exit.

releaseExternalResources

protected void releaseExternalResources()

Release external resources. Override this method for individual implementation.

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

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

getFrame

public MustFrameWithStatusLabel getFrame()

Specified by:

getFrame in interface MustContainer.Owner

Overrides:

getFrame in class MustFrame