proper.gui.core.frame
Class CommandLineFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      proper.gui.core.frame.ProperFrame
                          proper.gui.core.frame.CommandLineFrame

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants, CommandLineInterface, ProperInterface

Direct Known Subclasses:

ApplicationFrame, ChildFrame

public class CommandLineFrame
extends ProperFrame
implements CommandLineInterface

This class defines a frame that handles command line arguments.
This class is started with the command line parameters like this:

    ...
    public static void main(String[] args)
    {
       CommandLineFrame         frame;
       frame = new CommandLineFrame("Whatever Title");
       frame.run(args);
    }
 

Any additional code can be placed in the beforeCreate() or the afterCreatemethod, which are called before and after createFrame.

Version:

$Revision: 1.3 $

Author:

FracPete

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

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 proper.core.ProperInterface

VERSION

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, PROPERTIES, SOMEBITS

Constructor Summary

CommandLineFrame(java.lang.String title)
sets defaultcloseoperation to DO_NOTHING_ON_CLOSE.

Method Summary

void	checkCommandLine() checks whether all necessary parameters are provided
java.lang.String	fixAdditionalArg(java.lang.String arg) changes the '=' to '-' again (necessary, since the arguments are treated as seperate arguments!)
boolean	getConfirmExit() returns the setting of whether to display a confirm messagebox or not on exit
static void	main(java.lang.String[] args) for testing only
void	parameterError() prints the usage if not all necessary parameters were provided
void	printDescription() prints a short description of this class
void	printUsage() prints the usage of the application, with all necessary parameters
boolean	run(java.lang.String[] args) processes the commandline parameters and starts the frame, additional code should be place in "beforeShow()"
void	setArgs(CommandLine cl) sets the commandline object
void	setConfirmExit(boolean confirm) whether to present a MessageBox on Exit or not
java.lang.String	toString() outputs the current parameters
void	windowClosing(java.awt.event.WindowEvent e) invoked when a window is in the process of closing

Methods inherited from class proper.gui.core.frame.ProperFrame

actionPerformed, addListener, addOutput, changedUpdate, classInVerbose, debugprint, debugprint, debugprint, debugprint, debugprintln, debugprintln, debugprintln, debugprintln, debugprintln, getListeners, getRuntime, getVerbose, getVerboseLevel, getVerboseLevelForClass, getVerboseString, getVerboseStringForClass, insertUpdate, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, notifyListener, notifyListeners, print, print, print, print, println, println, println, println, println, printMemory, refresh, removeListener, removeUpdate, setCenteredLocation, setOutput, setVerbose, setVerboseLevel, setVerboseString, showMessageBox, showMessageBox, showStatus, windowActivated, windowClosed, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, 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, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

CommandLineFrame

public CommandLineFrame(java.lang.String title)

sets defaultcloseoperation to DO_NOTHING_ON_CLOSE. the actual frame is created in the run method via the createFrame method.

Parameters:

title - the title of the frame

See Also:

run(String[])

Method Detail

setArgs

public void setArgs(CommandLine cl)

sets the commandline object

Specified by:

setArgs in interface CommandLineInterface

checkCommandLine

public void checkCommandLine()

checks whether all necessary parameters are provided

Specified by:

checkCommandLine in interface CommandLineInterface

parameterError

public void parameterError()

prints the usage if not all necessary parameters were provided

Specified by:

parameterError in interface CommandLineInterface

printDescription

public void printDescription()

prints a short description of this class

Specified by:

printDescription in interface CommandLineInterface

printUsage

public void printUsage()

prints the usage of the application, with all necessary parameters

Specified by:

printUsage in interface CommandLineInterface

setConfirmExit

public void setConfirmExit(boolean confirm)

whether to present a MessageBox on Exit or not

Parameters:

confirm - whether a MessageBox pops up or not to confirm exit

getConfirmExit

public boolean getConfirmExit()

returns the setting of whether to display a confirm messagebox or not on exit

Returns:

whether a messagebox is displayed or not

windowClosing

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

invoked when a window is in the process of closing

Specified by:

windowClosing in interface java.awt.event.WindowListener

Overrides:

windowClosing in class ProperFrame

fixAdditionalArg

public java.lang.String fixAdditionalArg(java.lang.String arg)

changes the '=' to '-' again (necessary, since the arguments are treated as seperate arguments!)

run

public boolean run(java.lang.String[] args)
            throws java.lang.Exception

processes the commandline parameters and starts the frame, additional code should be place in "beforeShow()"

Specified by:

run in interface CommandLineInterface

Returns:

returns TRUE if successful run

Throws:

java.lang.Exception

toString

public java.lang.String toString()

outputs the current parameters

Overrides:

toString in class ProperFrame

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

for testing only

Throws:

java.lang.Exception