g2d.mwa

Class MWAFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

g2d.swing.IOPFrame

g2d.mwa.MWAFrame

All Implemented Interfaces:

ControlListener, java.awt.event.ComponentListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Comparable<MWAFrame>, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

IDFrame, ManagerFrame

public class MWAFrame
extends IOPFrame
implements ControlListener, java.lang.Comparable<MWAFrame>, java.awt.event.ComponentListener, java.awt.event.WindowListener

Implements a window in an Multi-Window Application. One can build up a hierachy of MWA windows using the notion of a parent window at object creation time.

Note: This class has a natural ordering based on the title of the frame that is inconsistent with equals.

Author:

Linda, Ian genericized it in January 2007, & added topFrames in June 2009.

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

Modifier and Type	Field and Description
protected static java.awt.Dimension	initialSize
static java.util.List<MWAFrame>	topFrames
protected javax.swing.JMenu	windowMenu

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

Constructors

Constructor and Description
MWAFrame(java.lang.String title) Creates this frame with the given title.
MWAFrame(java.lang.String title, int hgap, int vgap) Creates this frame with the given title and sets gaps of layout manager of the content pane.
MWAFrame(java.lang.String title, int hgap, int vgap, MWAFrame parent) Creates this frame with the given title and sets gaps of layout manager and assigns a given parent.
MWAFrame(java.lang.String title, MWAFrame parent) Creates this frame with the given title and with a given parent.

Method Summary

Modifier and Type	Method and Description
void	close() Called when MWAControl wants to shut-down.
int	compareTo(MWAFrame o)
void	componentHidden(java.awt.event.ComponentEvent event)
void	componentMoved(java.awt.event.ComponentEvent event)
void	componentResized(java.awt.event.ComponentEvent event)
void	componentShown(java.awt.event.ComponentEvent event)
MWAFrame[]	getChildrenFrames() Obtain array of frames that are children of this frame.
static java.awt.Dimension	getInitialSize()
javax.swing.JMenuBar	getJMenuBar() Get menu bar without the "Window" menu.
javax.swing.JMenuBar	getOrigJMenuBar() Jan 2 '07: Ian added this to circumnavigate a weird swing gotcha that this design seems to tickle, namely adding a menu from one bar seems to disable it in the previous bar.
MWAFrame	getParentFrame() Obtain parent frame of this frame.
MWAFrame	getTopFrame() Walks up the ancestors of this frame until one is found that doesn't have a parent.
void	setDefaultCloseOperation(int i) Do not allow users of this class to override default close operation.
static void	setInitialSize(java.awt.Dimension initialSize)
void	setJMenuBar(javax.swing.JMenuBar menubar) Set menu bar and append the "Window" menu at end.
void	setTitle(java.lang.String s)
void	toggle()
java.lang.String	toString()
void	updateWindows() Called when the population of windows controlled by MWAControl changes.
void	updateWindows(boolean tilings) Called when the population of windows controlled by MWAControl changes.
void	windowActivated(java.awt.event.WindowEvent event)
void	windowClosed(java.awt.event.WindowEvent event)
void	windowClosing(java.awt.event.WindowEvent event)
void	windowDeactivated(java.awt.event.WindowEvent event)
void	windowDeiconified(java.awt.event.WindowEvent event)
void	windowIconified(java.awt.event.WindowEvent event)
void	windowOpened(java.awt.event.WindowEvent event)

Methods inherited from class g2d.swing.IOPFrame

add, add, add, getScreenSize, setSize, setSize

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, 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, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, 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, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, 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 java.awt.MenuContainer

getFont, postEvent

Field Detail

topFrames

public static final java.util.List<MWAFrame> topFrames

initialSize

protected static java.awt.Dimension initialSize

windowMenu

protected javax.swing.JMenu windowMenu

Constructor Detail

MWAFrame

public MWAFrame(java.lang.String title)

Creates this frame with the given title.

Parameters:

title - String with title to be used for window

See Also:

IOPFrame.IOPFrame(String)

MWAFrame

public MWAFrame(java.lang.String title,
                int hgap,
                int vgap)

Creates this frame with the given title and sets gaps of layout manager of the content pane.

Parameters:

title - String with title to be used for window

hgap - number of pixels used as horizontal gap

vgap - number of pixels used as vertical gap

See Also:

IOPFrame.IOPFrame(String, int, int)

MWAFrame

public MWAFrame(java.lang.String title,
                MWAFrame parent)

Creates this frame with the given title and with a given parent.

Parameters:

title - String with title to be used for window

parent - MWAFrame that is the parent of this frame

MWAFrame

public MWAFrame(java.lang.String title,
                int hgap,
                int vgap,
                MWAFrame parent)

Creates this frame with the given title and sets gaps of layout manager and assigns a given parent.

Parameters:

title - String with title to be used for window

hgap - number of pixels used as horizontal gap

vgap - number of pixels used as vertical gap

parent - MWAFrame that is the parent of this frame

Method Detail

getParentFrame

public MWAFrame getParentFrame()

Obtain parent frame of this frame. May be null if this frame does not have a parent.

Returns:

MWAFrame that is the parent of this frame (may be null)

getTopFrame

public MWAFrame getTopFrame()

Walks up the ancestors of this frame until one is found that doesn't have a parent. Returns that frame.

Returns:

Frame that is ancestor of this one and does not have any parent

getChildrenFrames

public MWAFrame[] getChildrenFrames()

Obtain array of frames that are children of this frame. The resulting array may be of lenght 0.

Returns:

Array of frames that are children

getInitialSize

public static java.awt.Dimension getInitialSize()

setInitialSize

public static void setInitialSize(java.awt.Dimension initialSize)

setTitle

public void setTitle(java.lang.String s)

Overrides:

setTitle in class java.awt.Frame

setDefaultCloseOperation

public void setDefaultCloseOperation(int i)

Do not allow users of this class to override default close operation.

Overrides:

setDefaultCloseOperation in class javax.swing.JFrame

Parameters:

i - (not used)

getOrigJMenuBar

public javax.swing.JMenuBar getOrigJMenuBar()

Jan 2 '07: Ian added this to circumnavigate a weird swing gotcha that this design seems to tickle, namely adding a menu from one bar seems to disable it in the previous bar.

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()

Get menu bar without the "Window" menu. Due to a bug, user MUST invoke setJMenuBar(javax.swing.JMenuBar) afterward with something sensible (e.g., return value of this method) to maintain the current menu bar!

Overrides:

getJMenuBar in class javax.swing.JFrame

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar menubar)

Set menu bar and append the "Window" menu at end. If null is given, new menu bar will only contain the "Window" menu.

Overrides:

setJMenuBar in class javax.swing.JFrame

Parameters:

menubar - JMenuBar to be used for this frame (without "Window" menu); can be null

updateWindows

public void updateWindows()

Description copied from interface: ControlListener

Called when the population of windows controlled by MWAControl changes. Omits the horizontal and vertical tiling options.

Specified by:

updateWindows in interface ControlListener

updateWindows

public void updateWindows(boolean tilings)

Description copied from interface: ControlListener

Called when the population of windows controlled by MWAControl changes. Include the horizontal and vertical tiling options.

Specified by:

updateWindows in interface ControlListener

close

public void close()

Description copied from interface: ControlListener

Called when MWAControl wants to shut-down.

Specified by:

close in interface ControlListener

compareTo

public int compareTo(MWAFrame o)

Specified by:

compareTo in interface java.lang.Comparable<MWAFrame>

componentResized

public void componentResized(java.awt.event.ComponentEvent event)

Specified by:

componentResized in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent event)

Specified by:

componentMoved in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent event)

Specified by:

componentShown in interface java.awt.event.ComponentListener

componentHidden

public void componentHidden(java.awt.event.ComponentEvent event)

Specified by:

componentHidden in interface java.awt.event.ComponentListener

windowOpened

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

Specified by:

windowOpened in interface java.awt.event.WindowListener

windowClosing

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

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowClosed

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

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowIconified

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

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowDeiconified

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

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowActivated

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

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowDeactivated

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

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

toggle

public void toggle()