edu.northwestern.at.utils.swing
Class XFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      edu.northwestern.at.utils.swing.WindowsMenuManager
                          edu.northwestern.at.utils.swing.XFrame

All Implemented Interfaces:

PrintableContainer, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

AbstractWindow, Notepad, SystemInformationWindow

public class XFrame
extends WindowsMenuManager
implements PrintableContainer

An extended version of a JFrame.

An XFrame knows how to print itself or its child windows, and adds a few support routines for windows positioning, termination, and about box display; and can keep track of sibling frames.

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

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

protected javax.swing.JFrame	aboutBox The About box.
protected javax.swing.JFrame	prefsWindow The preferences dialog.

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

XFrame()
Create untitled XFrame.

XFrame(java.lang.String title)
Create titled XFrame.

Method Summary

void	about() Display about box, if any.
protected void	common() Perform common initialization tasks for all constructors.
void	doPageSetup() Perform page setup.
void	doPrint() Do printing.
void	doPrint(java.awt.Component component) Do printing.
void	doPrint(java.awt.Component component, java.lang.String title) Do printing.
void	doPrintPreview() Perform print preview.
void	doPrintPreview(java.awt.Component component) Perform print preview.
void	doPrintPreview(java.awt.Component component, java.lang.String title) Perform print preview.
void	pack() Packs an XFrame with no parent.
void	pack(java.awt.Window parent) Packs an XFrame and staggers it over its parent frame.
void	prefs() Display preferences dialog, if any.
void	quit() Quit program.
void	setAboutBox(javax.swing.JFrame aboutBox) Set the about box.
static void	setDefaultImage(java.awt.Image image) Set default image.
void	setPrefsWindow(javax.swing.JFrame prefsWindow) Set the preferences dialog.

Methods inherited from class edu.northwestern.at.utils.swing.WindowsMenuManager

dispose, getActiveWindow, getAllOpenWindows, getWindowsMenu, handleLastWindowClosed, setJMenuBar, setTitle, setVisible, setWindowsMenu

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, 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, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, 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, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, 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

aboutBox

protected javax.swing.JFrame aboutBox

The About box.

prefsWindow

protected javax.swing.JFrame prefsWindow

The preferences dialog.

Constructor Detail

XFrame

public XFrame()

Create untitled XFrame.

XFrame

public XFrame(java.lang.String title)

Create titled XFrame.

Parameters:

title - The frame's title.

Method Detail

common

protected void common()

Perform common initialization tasks for all constructors.

doPageSetup

public void doPageSetup()

Perform page setup. Override this if necessary in subclasses.

Specified by:

doPageSetup in interface PrintableContainer

doPrintPreview

public void doPrintPreview()

Perform print preview. Override this if necessary in subclasses.

Specified by:

doPrintPreview in interface PrintableContainer

doPrintPreview

public void doPrintPreview(java.awt.Component component)

Perform print preview. Override this if necessary in subclasses.

doPrintPreview

public void doPrintPreview(java.awt.Component component,
                           java.lang.String title)

Perform print preview. Override this if necessary in subclasses.

doPrint

public void doPrint()

Do printing. Override this if necessary in subclasses.

Specified by:

doPrint in interface PrintableContainer

doPrint

public void doPrint(java.awt.Component component)

Do printing. Override this if necessary in subclasses.

doPrint

public void doPrint(java.awt.Component component,
                    java.lang.String title)

Do printing. Override this if necessary in subclasses.

pack

public void pack(java.awt.Window parent)

Packs an XFrame and staggers it over its parent frame.

Parameters:

parent - The parent window.

pack

public void pack()

Packs an XFrame with no parent.

Overrides:

pack in class java.awt.Window

about

public void about()

Display about box, if any.

prefs

public void prefs()

Display preferences dialog, if any.

quit

public void quit()

Quit program.

Does a System.exit( 0 ). You may want to override this to ask for confirmation before quitting.

setAboutBox

public void setAboutBox(javax.swing.JFrame aboutBox)

Set the about box.

Parameters:

aboutBox - The about box window.

setPrefsWindow

public void setPrefsWindow(javax.swing.JFrame prefsWindow)

Set the preferences dialog.

Parameters:

prefsWindow - The preferences window.

setDefaultImage

public static void setDefaultImage(java.awt.Image image)

Set default image.

Parameters:

image - The image to use as a window icon.