jwo.utils
Class JWFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--jwo.utils.JWFrame

All Implemented Interfaces:

Accessible, ActionListener, EventListener, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

HistoBox, PrintArea, ProfileQueryBox, RastInfoBox, RastQueryBox, ScaleQueryBox, ScatterPlotBox, VectInfoBox

public abstract class JWFrame

extends Frame

implements ActionListener

Abstract class to use as basis for simple non-modal windows. Contains an OK return button. Uses the GridBag Layout manager for maximum portability with different window sizes.

Version:

1.8.0, 18th September, 1999

Author:

Jo Wood

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

Constructor Summary

JWFrame()
Creates simple window with OK button.

JWFrame(String winTitle)
Creates simple window with title, and OK button.

JWFrame(String winTitle, String mainTitle)
Creates simple window with titles, and OK button.

Method Summary

void	actionPerformed(ActionEvent event) Closes the frame if the OK button is pressed.
Component	add(Component c) Adds a component to the frame above the OK button if it is defined.
void	addReturnButtons() Adds the return button to this frame.
abstract void	closeFrame() Method that allows action to be performed when frame is closed.
GridBagConstraints	getGBConstraints() Retrieves the default GridBag layout constraints associated with this frame.
GridBagLayout	getGBLayout() Retrieves current GridBagLayout (needed to add new componets to the frame.

Methods inherited from class java.awt.Frame

addNotify, finalize, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, 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, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, addImpl, 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, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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

Constructor Detail

JWFrame

public JWFrame()

Creates simple window with OK button. Uses the default colour schemes for the window. Includes icon if one exists (called Icon16.gif).

JWFrame

public JWFrame(String winTitle)

Creates simple window with title, and OK button. Uses the default colour schemes for the window. Includes icon if one exists (called Icon16.gif).

Parameters:

winTitle - Title placed on window bar.

JWFrame

public JWFrame(String winTitle,
               String mainTitle)

Creates simple window with titles, and OK button. Uses the default colour schemes for the window. Includes icon if one exists (called Icon16.gif).

Parameters:

winTitle - Title placed on window bar.

mainTitle - Main title displayed in dialogue window.

Method Detail

getGBConstraints

public GridBagConstraints getGBConstraints()

Retrieves the default GridBag layout constraints associated with this frame. Default assumes

• fill - fill horizontal space (HORIZONTAL)
• gridwidth - last on line (REMAINDER)
• anchor - top left of window (NORTHWEST)
• ipadx - 4 pixels
• ipady - 4 pixels
• weightx - 0.5
• weighty - 0.5

Returns:

Default GridBagConstraints.

getGBLayout

public GridBagLayout getGBLayout()

Retrieves current GridBagLayout (needed to add new componets to the frame.

Returns:

Current GridBagLayout.

add

public Component add(Component c)

Adds a component to the frame above the OK button if it is defined.

Overrides:

add in class Container

Returns:

Component added.

addReturnButtons

public void addReturnButtons()

Adds the return button to this frame.

actionPerformed

public void actionPerformed(ActionEvent event)

Closes the frame if the OK button is pressed.

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - Event associated with OK button press.

closeFrame

public abstract void closeFrame()

Method that allows action to be performed when frame is closed. Must be implemented and should dispose of window when complete.