ij.gui
Class GenericDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--ij.gui.GenericDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.event.KeyListener, java.awt.MenuContainer, java.io.Serializable, java.awt.event.TextListener

Direct Known Subclasses:

woSource.GenericDialogPlus, GenericDialogScroll

public class GenericDialog

extends java.awt.Dialog

implements java.awt.event.ActionListener, java.awt.event.TextListener, java.awt.event.FocusListener, java.awt.event.ItemListener, java.awt.event.KeyListener

This class is a customizable modal dialog box.

See Also:

Serialized Form

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

GenericDialog(java.lang.String title)
Creates a new GenericDialog with the specified title.

GenericDialog(java.lang.String title, java.awt.Frame parent)
Creates a new GenericDialog using the specified title and parent frame.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
void	addCheckbox(java.lang.String label, boolean defaultValue) Adds a checkbox.
void	addCheckboxGroup(int rows, int columns, java.lang.String[] labels, boolean[] defaultValues) Adds a group of checkboxs using a grid layout.
void	addChoice(java.lang.String label, java.lang.String[] items, java.lang.String defaultItem) Adds a popup menu.
void	addMessage(java.lang.String text) Adds a message consisting of one or more lines of text.
void	addNumericField(java.lang.String label, double defaultValue, int digits) Adds a numeric field.
void	addStringField(java.lang.String label, java.lang.String defaultText) Adds an 8 column text field.
void	addStringField(java.lang.String label, java.lang.String defaultText, int columns) Adds a text field.
void	addTextAreas(java.lang.String text1, java.lang.String text2, int rows, int columns) Adds one or two (side by side) text areas.
void	focusGained(java.awt.event.FocusEvent e)
void	focusLost(java.awt.event.FocusEvent e)
java.awt.Insets	getInsets()
boolean	getNextBoolean() Returns the state of the next checkbox.
java.lang.String	getNextChoice() Returns the selected item in the next popup menu.
int	getNextChoiceIndex() Returns the index of the selected item in the next popup menu.
double	getNextNumber() Returns the contents of the next numeric field.
java.lang.String	getNextString() Returns the contents of the next text field.
java.lang.String	getNextText() Returns the contents of the next text area.
boolean	invalidNumber() Returns true if one or more of the numeric fields contained an invalid number.
void	itemStateChanged(java.awt.event.ItemEvent e)
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
void	paint(java.awt.Graphics g)
void	showDialog() Displays this dialog box.
void	textValueChanged(java.awt.event.TextEvent e)
boolean	wasCanceled() Returns true if the user clicks on "Cancel".

Methods inherited from class java.awt.Dialog

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

Methods inherited from class java.awt.Window

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

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, 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

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

Constructor Detail

GenericDialog

public GenericDialog(java.lang.String title)

Creates a new GenericDialog with the specified title. Uses the current image image window as the parent frame or the ImageJ frame if no image windows are open. Dialog parameters are recorded by ImageJ's command recorder but this requires that the first word of each label be unique.

GenericDialog

public GenericDialog(java.lang.String title,
                     java.awt.Frame parent)

Creates a new GenericDialog using the specified title and parent frame.

Method Detail

addNumericField

public void addNumericField(java.lang.String label,
                            double defaultValue,
                            int digits)

Adds a numeric field. The first word of the label must be unique or command recording will not work.

Parameters:

label - the label

defaultValue - value to be initially displayed

digits - number of digits to right of decimal point

addStringField

public void addStringField(java.lang.String label,
                           java.lang.String defaultText)

Adds an 8 column text field.

Parameters:

label - the label

defaultText - the text initially displayed

addStringField

public void addStringField(java.lang.String label,
                           java.lang.String defaultText,
                           int columns)

Adds a text field.

Parameters:

label - the label

defaultText - text initially displayed

columns - width of the text field

addCheckbox

public void addCheckbox(java.lang.String label,
                        boolean defaultValue)

Adds a checkbox.

Parameters:

label - the label

defaultValue - the initial state

addCheckboxGroup

public void addCheckboxGroup(int rows,
                             int columns,
                             java.lang.String[] labels,
                             boolean[] defaultValues)

Adds a group of checkboxs using a grid layout.

Parameters:

rows - the number of rows

columns - the number of columns

labels - the labels

defaultValues - the initial states

addChoice

public void addChoice(java.lang.String label,
                      java.lang.String[] items,
                      java.lang.String defaultItem)

Adds a popup menu.

Parameters:

label - the label

items - the menu items

defaultItem - the menu item initially selected

addMessage

public void addMessage(java.lang.String text)

Adds a message consisting of one or more lines of text.

addTextAreas

public void addTextAreas(java.lang.String text1,
                         java.lang.String text2,
                         int rows,
                         int columns)

Adds one or two (side by side) text areas.

Parameters:

text1 - initial contents of the first text area

text2 - initial contents of the second text area or null

rows - the number of rows

rows - the number of columns

wasCanceled

public boolean wasCanceled()

Returns true if the user clicks on "Cancel".

getNextNumber

public double getNextNumber()

Returns the contents of the next numeric field.

invalidNumber

public boolean invalidNumber()

Returns true if one or more of the numeric fields contained an invalid number.

getNextString

public java.lang.String getNextString()

Returns the contents of the next text field.

getNextBoolean

public boolean getNextBoolean()

Returns the state of the next checkbox.

getNextChoice

public java.lang.String getNextChoice()

Returns the selected item in the next popup menu.

getNextChoiceIndex

public int getNextChoiceIndex()

Returns the index of the selected item in the next popup menu.

getNextText

public java.lang.String getNextText()

Returns the contents of the next text area.

showDialog

public void showDialog()

Displays this dialog box.

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

textValueChanged

public void textValueChanged(java.awt.event.TextEvent e)

Specified by:

textValueChanged in interface java.awt.event.TextListener

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

focusGained

public void focusGained(java.awt.event.FocusEvent e)

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent e)

Specified by:

focusLost in interface java.awt.event.FocusListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

getInsets

public java.awt.Insets getInsets()

Overrides:

getInsets in class java.awt.Container

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class java.awt.Container