Package adams.gui.core

Class AbstractFrameWithOptionHandling

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

adams.gui.core.BaseFrame

adams.gui.core.AbstractFrameWithOptionHandling

All Implemented Interfaces:

Destroyable, LoggingSupporter, OptionHandler, HomeRelocator, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

AbstractApplicationFrame, InstanceCompare

public abstract class AbstractFrameWithOptionHandling
extends BaseFrame
implements OptionHandler, HomeRelocator

Ancestor to all frames that handle command-line options.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Home	the directory to use as the project's home directory.
protected OptionManager	m_OptionManager	for managing the available options.

Fields inherited from class adams.gui.core.BaseFrame

m_Logger, m_MaximizationFixWindowListener, m_UISettingsApplied, m_UISettingsPrefix, m_UISettingsStored, m_UseMaximizationFix

Fields inherited from class javax.swing.JFrame

accessibleContext, 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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
AbstractFrameWithOptionHandling()	Constructor for creating frame with no title.
AbstractFrameWithOptionHandling(String title)	The constructor for creating frame with title.

Method Summary

Modifier and Type	Method	Description
void	cleanUpOptions()	Cleans up the options.
void	defineOptions()	Adds options to the internal list of options.
void	destroy()	Frees up memory in a "destructive" non-reversible way.
static AbstractFrameWithOptionHandling	forName(String classname, String[] options)	Instantiates the frame with the given options.
String	getHome()	Returns the directory to use as home directory instead of the automatically determined one.
OptionManager	getOptionManager()	Returns the option manager.
String	homeTipText()	Returns the tip text for this property.
protected OptionManager	newOptionManager()	Returns a new instance of the option manager.
protected void	performInitialization()	Contains all the initialization steps to perform.
protected void	reset()	For resetting the frame.
static AbstractFrameWithOptionHandling	runFrame(Class env, Class app, String[] options)	Runs the frame from the commandline.
void	setHome(String value)	Overrides the automatic detection of the project's home directory and uses the specified directory instead.
String	toCommandLine()	Returns the commandline string.

Methods inherited from class adams.gui.core.BaseFrame

afterHide, afterShow, applyUISettings, beforeHide, beforeShow, finishInit, forName, getLogger, getUISettingsApplied, getUISettingsPrefix, initGUI, initialize, initializeLogger, isLoggingEnabled, runFrame, setBounds, setLocationRelativeTo, setUISettingsPrefix, setUISettingsPrefix, setVisible, storeUISettings

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, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

m_OptionManager

protected OptionManager m_OptionManager

for managing the available options.

m_Home

protected String m_Home

the directory to use as the project's home directory.

Constructor Detail

AbstractFrameWithOptionHandling

public AbstractFrameWithOptionHandling()

Constructor for creating frame with no title.

AbstractFrameWithOptionHandling

public AbstractFrameWithOptionHandling(String title)

The constructor for creating frame with title.

Parameters:

title - the title of the frame

Method Detail

performInitialization

protected void performInitialization()

Contains all the initialization steps to perform.

Overrides:

performInitialization in class BaseFrame

newOptionManager

protected OptionManager newOptionManager()

Returns a new instance of the option manager.

Returns:

the manager to use

defineOptions

public void defineOptions()

Adds options to the internal list of options. Derived classes must override this method to add additional options.

Specified by:

defineOptions in interface OptionHandler

reset

protected void reset()

For resetting the frame.

Default implementation does nothing.

getOptionManager

public OptionManager getOptionManager()

Returns the option manager.

Specified by:

getOptionManager in interface OptionHandler

Returns:

the manager

cleanUpOptions

public void cleanUpOptions()

Cleans up the options.

Specified by:

cleanUpOptions in interface OptionHandler

destroy

public void destroy()

Frees up memory in a "destructive" non-reversible way.

Cleans up the options.

Specified by:

destroy in interface Destroyable

See Also:

cleanUpOptions()

setHome

public void setHome(String value)

Overrides the automatic detection of the project's home directory and uses the specified directory instead. No placeholders allowed, should be absolute.

Specified by:

setHome in interface HomeRelocator

Parameters:

value - the directory to use

getHome

public String getHome()

Returns the directory to use as home directory instead of the automatically determined one.

Specified by:

getHome in interface HomeRelocator

Returns:

the directory to use

homeTipText

public String homeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

toCommandLine

public String toCommandLine()

Returns the commandline string.

Specified by:

toCommandLine in interface OptionHandler

Returns:

the commandline

forName

public static AbstractFrameWithOptionHandling forName(String classname,
                                                      String[] options)

Instantiates the frame with the given options.

Parameters:

classname - the classname of the frame to instantiate

options - the options for the frame

Returns:

the instantiated frame or null if an error occurred

runFrame

public static AbstractFrameWithOptionHandling runFrame(Class env,
                                                       Class app,
                                                       String[] options)

Runs the frame from the commandline.

Parameters:

env - the environment class to use

app - the frame class

options - the commandline options

Returns:

the instantiated frame, null in case of an error or help being invoked