org.dmonix.gui.frames
Class BaseFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.dmonix.gui.frames.BaseFrame

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants, java.awt.event.WindowListener

public class BaseFrame

extends javax.swing.JFrame

implements java.awt.event.WindowListener

A base frame class to be used by all swing applications.

Copyright: Copyright (c) 2003

Company: dmonix.org

Version:

1.0

Author:

Peter Nerg

See Also:

Serialized Form

Nested Class Summary

protected class	BaseFrame.ActionLooknFeel The "look n feel" action class.
class	BaseFrame.BaseFrame_menuItemAbout_actionAdapter

Nested classes inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected SimpleButtonGroup	btnGroupLooknFeel
protected static javax.swing.ImageIcon	ICON_LOGO
protected static java.lang.String	LOOKNFEEL_CROSS
protected static java.lang.String	LOOKNFEEL_GTK
protected static java.lang.String	LOOKNFEEL_METAL
protected static java.lang.String	LOOKNFEEL_MOTIF
protected static java.lang.String	LOOKNFEEL_SUN
protected static java.lang.String	LOOKNFEEL_WINDOWS
protected javax.swing.JMenuItem	menuItemAbout
protected javax.swing.JMenu	menuLooknFeel Menu containing all the available look and feels.
protected javax.swing.JPanel	panelFrame

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

Fields inherited from class java.awt.Container

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

BaseFrame()

Method Summary

protected void	configure(java.lang.String path) This will read the config.xml file and store the properties in a static hashtable.
protected void	exitError(java.lang.Exception ex) Something has gone wrong, log the error and exit the program
protected void	exitError(java.lang.String configFile, java.lang.Exception ex) Something has gone wrong, log the error and exit the program
protected java.lang.String	getProperty(java.lang.String name) Get a property from the config.xml file
protected void	setFont(javax.swing.JMenuBar menuBar, java.awt.Font fontMenu, java.awt.Font fontMenuItem) Set the font for the all menu and menu items in the given menu bar.
protected void	setFont(javax.swing.JMenu menu, java.awt.Font fontMenu, java.awt.Font fontMenuItem) Set the font for the all menu and menu items in the given menu bar.
protected void	setLooknFeel(java.lang.String looknfeel) Set the look and feel for the GUI.
protected void	showSplashScreen(boolean allowClose)
void	windowActivated(java.awt.event.WindowEvent e) Handle window activated event
void	windowClosed(java.awt.event.WindowEvent e) Handle window closing event
void	windowClosing(java.awt.event.WindowEvent e) Handle window closing event
void	windowDeactivated(java.awt.event.WindowEvent e) Handle window deactivated event
void	windowDeiconified(java.awt.event.WindowEvent e) Handle window deiconified event
void	windowIconified(java.awt.event.WindowEvent e) Handle window iconified event
void	windowOpened(java.awt.event.WindowEvent e) Handle window opened event

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, 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

ICON_LOGO

protected static final javax.swing.ImageIcon ICON_LOGO

LOOKNFEEL_SUN

protected static final java.lang.String LOOKNFEEL_SUN

See Also:

Constant Field Values

LOOKNFEEL_GTK

protected static final java.lang.String LOOKNFEEL_GTK

See Also:

Constant Field Values

LOOKNFEEL_METAL

protected static final java.lang.String LOOKNFEEL_METAL

See Also:

Constant Field Values

LOOKNFEEL_CROSS

protected static final java.lang.String LOOKNFEEL_CROSS

LOOKNFEEL_WINDOWS

protected static final java.lang.String LOOKNFEEL_WINDOWS

See Also:

Constant Field Values

LOOKNFEEL_MOTIF

protected static final java.lang.String LOOKNFEEL_MOTIF

See Also:

Constant Field Values

menuLooknFeel

protected javax.swing.JMenu menuLooknFeel

Menu containing all the available look and feels.

btnGroupLooknFeel

protected SimpleButtonGroup btnGroupLooknFeel

menuItemAbout

protected javax.swing.JMenuItem menuItemAbout

panelFrame

protected javax.swing.JPanel panelFrame

Constructor Detail

BaseFrame

public BaseFrame()
          throws java.lang.Exception

Method Detail

windowClosed

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

Handle window closing event

Specified by:

windowClosed in interface java.awt.event.WindowListener

Parameters:

e - The event

windowDeiconified

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

Handle window deiconified event

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

e - The event

windowIconified

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

Handle window iconified event

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

e - The event

windowActivated

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

Handle window activated event

Specified by:

windowActivated in interface java.awt.event.WindowListener

Parameters:

e - The event

windowDeactivated

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

Handle window deactivated event

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

Parameters:

e - The event

windowOpened

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

Handle window opened event

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

e - The event

windowClosing

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

Handle window closing event

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

e - The event

configure

protected void configure(java.lang.String path)

This will read the config.xml file and store the properties in a static hashtable.

Parameters:

path - The path to the config file

exitError

protected void exitError(java.lang.Exception ex)

Something has gone wrong, log the error and exit the program

Parameters:

ex - The exception to log

exitError

protected void exitError(java.lang.String configFile,
                         java.lang.Exception ex)

Something has gone wrong, log the error and exit the program

Parameters:

configFile - The name of the log file

ex - The exception to log

getProperty

protected java.lang.String getProperty(java.lang.String name)

Get a property from the config.xml file

Parameters:

name - The name of the property

Returns:

The property value

setFont

protected void setFont(javax.swing.JMenuBar menuBar,
                       java.awt.Font fontMenu,
                       java.awt.Font fontMenuItem)

Set the font for the all menu and menu items in the given menu bar.
The method will recursively iterate through all menus and sub-menus.

Parameters:

menuBar - The menu bar

fontMenu - The font for the menus

fontMenuItem - The font for the menu items

setFont

protected void setFont(javax.swing.JMenu menu,
                       java.awt.Font fontMenu,
                       java.awt.Font fontMenuItem)

Set the font for the all menu and menu items in the given menu bar.
The method will recursively iterate through all menus and sub-menus.

Parameters:

menu - The menu

fontMenu - The font for the menus

fontMenuItem - The font for the menu items

setLooknFeel

protected void setLooknFeel(java.lang.String looknfeel)
                     throws java.lang.Exception

Set the look and feel for the GUI.

Parameters:

looknfeel - The look and feel

Throws:

java.lang.Exception

showSplashScreen

protected void showSplashScreen(boolean allowClose)