de.esprit.appsuite.gui

Class ApplicationMainFrame<C extends ApplicationContext>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.esprit.common.gui.ZFrame

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ClientMainFrame, EspritDemoMainFrame

public abstract class ApplicationMainFrame<C extends ApplicationContext>
extends ZFrame
implements SimpleLogSupport, EnvStorable, Exitable, ApplicationObject<C>

This frame is supposed to be the main-frame of an application. It provides an EnvStore for storing GUI component properties as well as the properties of this frame itself.

Author:

Rainer Buesch

See Also:

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 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 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, 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
ApplicationMainFrame(C ctx)
ApplicationMainFrame(C ctx, NlsKey titleKey)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnvProperties(EnvMap props) This method is called on the implementing class in order to give it a chance to fill the passed Properties object with key-value pairs that should be saved in the environment properties file.
void	close() Makes the frame invisible.
protected void	closeByIcon() Is called when closing the window by the close-icon
protected java.lang.String	createEnvKey()
protected EnvStore	createEnvStore()
boolean	exit() This method is called by the ExitButton on it's registered target.
de.esprit.appsuite.gui.ApplicationMainFrame.MyCancelAsyncActivityAction	getActionCancelAllAsyncActivity()
de.esprit.appsuite.gui.ApplicationMainFrame.MyExitAction	getActionExit()
C	getApplicationContext()
EnvStore	getEnvStore()
LogChannel	getLogChannel()
void	initFromEnvStore(EnvStore envStore)
boolean	isLogDebug()
boolean	isLogVerbose()
void	logDebug(java.lang.String message)
void	logDump(java.lang.String message)
void	logError(java.lang.String message)
void	logError(java.lang.String message, java.lang.Exception e)
void	logFatal(java.lang.String message, java.lang.Exception e)
void	logInfo(java.lang.String message)
void	logVerbose(java.lang.String message)
void	logWarning(java.lang.String message)
void	pack() Overridden to provide a default center location
void	setLogChannel(LogChannel logCh)

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

createWindowAdapter, getMinimumHeight, getMinimumWidth, getWindowAdapter, isErrorAttachable, isLocated, isPacked, popup, repack, setIcon, setIcon, setLocation, setLocationRelativeTo, setLocationRelativeTo, setLocationToCenter, setTitle, setVisible, shiftLocation, toDumpString, toDumpString, toString, toString

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, setTitle, 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, getLocale, 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, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocationByPlatform, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, 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, 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.common.gui.ToolWindow

getLocation, getSize, getTitle, getToolkit, setMinimumSize, setPreferredSize

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

ApplicationMainFrame

public ApplicationMainFrame(C ctx)

ApplicationMainFrame

public ApplicationMainFrame(C ctx,
                    NlsKey titleKey)

Method Detail

getApplicationContext

public final C getApplicationContext()

Specified by:

getApplicationContext in interface ApplicationObject<C extends ApplicationContext>

getEnvStore

public EnvStore getEnvStore()

createEnvStore

protected EnvStore createEnvStore()

createEnvKey

protected java.lang.String createEnvKey()

addEnvProperties

public void addEnvProperties(EnvMap props)

Description copied from interface: EnvStorable

This method is called on the implementing class in order to give it a chance to fill the passed Properties object with key-value pairs that should be saved in the environment properties file.

Specified by:

addEnvProperties in interface EnvStorable

initFromEnvStore

public void initFromEnvStore(EnvStore envStore)

Specified by:

initFromEnvStore in interface EnvStorable

getActionExit

public final de.esprit.appsuite.gui.ApplicationMainFrame.MyExitAction getActionExit()

getActionCancelAllAsyncActivity

public final de.esprit.appsuite.gui.ApplicationMainFrame.MyCancelAsyncActivityAction getActionCancelAllAsyncActivity()

pack

public void pack()

Overridden to provide a default center location

Specified by:

pack in interface ToolWindow

Overrides:

pack in class ZFrame

closeByIcon

protected final void closeByIcon()

Description copied from class: ZFrame

Is called when closing the window by the close-icon

Overrides:

closeByIcon in class ZFrame

close

public void close()

Description copied from class: ZFrame

Makes the frame invisible.

Specified by:

close in interface Closeable

Overrides:

close in class ZFrame

exit

public boolean exit()

Description copied from interface: Exitable

This method is called by the ExitButton on it's registered target.

Specified by:

exit in interface Exitable

Returns:

false if the exit was actually prevented by any check

logFatal

public void logFatal(java.lang.String message,
            java.lang.Exception e)

Specified by:

logFatal in interface SimpleLogSupport

logError

public void logError(java.lang.String message,
            java.lang.Exception e)

Specified by:

logError in interface SimpleLogSupport

logError

public void logError(java.lang.String message)

Specified by:

logError in interface SimpleLogSupport

logWarning

public void logWarning(java.lang.String message)

Specified by:

logWarning in interface SimpleLogSupport

logInfo

public void logInfo(java.lang.String message)

Specified by:

logInfo in interface SimpleLogSupport

logVerbose

public void logVerbose(java.lang.String message)

Specified by:

logVerbose in interface SimpleLogSupport

logDebug

public void logDebug(java.lang.String message)

Specified by:

logDebug in interface SimpleLogSupport

logDump

public void logDump(java.lang.String message)

Specified by:

logDump in interface SimpleLogSupport

getLogChannel

public LogChannel getLogChannel()

Specified by:

getLogChannel in interface SimpleLogSupport

setLogChannel

public void setLogChannel(LogChannel logCh)

Specified by:

setLogChannel in interface SimpleLogSupport

isLogDebug

public boolean isLogDebug()

Specified by:

isLogDebug in interface SimpleLogSupport

isLogVerbose

public boolean isLogVerbose()

Specified by:

isLogVerbose in interface SimpleLogSupport