AFLPgui
Class OptionDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--AFLPgui.OptionDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.awt.event.WindowListener

public class OptionDialog

extends java.awt.Dialog

implements java.awt.event.ActionListener, java.awt.event.WindowListener

This class will display options in a dialog box. The options are associated with a GUI component by keeping the components in a parrallel array. The components are displayed on the left side of the dialog, and if the number of options cause the display space required to exceed the size of the dialog, a scroll bar becomes available. The dialog will check to see if all of the required options have been set before closing.

See Also:

Option, Serialized Form

Inner classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Inner classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

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

OptionDialog(Option[] opts, java.awt.Frame parent)
Creates a new option dialog with the specified parameters.

OptionDialog(Option[] opts, java.awt.Frame parent, java.lang.String title)
Creates a new option dialog with the specified parameters

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Handles the buttons.
void	addOption(Option option, int pos, int index) Creates a GUI component for the specified option and places it at the specified position.
Option[]	getOptions() Gives the options as they were set by the user in the dialog box.
boolean	isCanceled() Tells whether the dialog was canceled or not.
void	windowActivated(java.awt.event.WindowEvent e) Unused
void	windowClosed(java.awt.event.WindowEvent e) Unused
void	windowClosing(java.awt.event.WindowEvent e) Closes the dialog and is equivalent to pressing cancel.
void	windowDeactivated(java.awt.event.WindowEvent e) Unused
void	windowDeiconified(java.awt.event.WindowEvent e) Unused
void	windowIconified(java.awt.event.WindowEvent e) Unused
void	windowOpened(java.awt.event.WindowEvent e) Unused

Methods inherited from class java.awt.Dialog

addNotify, dispose, getAccessibleContext, getTitle, hide, isModal, isResizable, paramString, setModal, setResizable, setTitle, show

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, processWindowEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFont, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionDialog

public OptionDialog(Option[] opts,
                    java.awt.Frame parent)

Creates a new option dialog with the specified parameters.

Parameters:

opts - the options to display

parent - the owner of this dialog box.

OptionDialog

public OptionDialog(Option[] opts,
                    java.awt.Frame parent,
                    java.lang.String title)

Creates a new option dialog with the specified parameters

Parameters:

opts - the options to display

parent - the owner of this dialog box.

title - the title of the dialog box.

Method Detail

getOptions

public Option[] getOptions()

Gives the options as they were set by the user in the dialog box.

Returns:

the options for the dialog box.

isCanceled

public boolean isCanceled()

Tells whether the dialog was canceled or not.

Returns:

true if the dialog was cancelled.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Handles the buttons. If ok is clicked, then the options are read. if all of the options are set, then it closes the dialog. If not, then an error is shown. Cancel simply closes the dialog.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

windowClosing

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

Closes the dialog and is equivalent to pressing cancel.

Specified by:

windowClosing in interface java.awt.event.WindowListener

addOption

public void addOption(Option option,
                      int pos,
                      int index)

Creates a GUI component for the specified option and places it at the specified position. The component is then stored in an array at the specified index.

Parameters:

option - the option to add to the display

pos - the vertical position to add it at

index - the index into the array of GUI components. This is the same as the index of the option in the option array.

windowOpened

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

Unused

Specified by:

windowOpened in interface java.awt.event.WindowListener

windowClosed

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

Unused

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowIconified

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

Unused

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowDeiconified

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

Unused

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowActivated

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

Unused

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowDeactivated

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

Unused

Specified by:

windowDeactivated in interface java.awt.event.WindowListener