ij.gui
Class GenericDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by ij.gui.GenericDialog
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class GenericDialog
extends java.awt.Dialog
implements java.awt.event.ActionListener

This class is a customizable modal dialog box.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 
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
static int MAX_ITEMS
          Maximum number of each component (numeric field, checkbox, etc).
 
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
 
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.
 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 paint(java.awt.Graphics g)
           
 void showDialog()
          Displays this dialog box.
 boolean wasCanceled()
          Returns true if the user clicks on "Cancel".
 
Methods inherited from class java.awt.Dialog
addNotify, getAccessibleContext, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, paramString, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, 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, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_ITEMS

public static final int MAX_ITEMS
Maximum number of each component (numeric field, checkbox, etc).

See Also:
Constant Field Values
Constructor Detail

GenericDialog

public GenericDialog(java.lang.String title)
Creates a new GenericDialog with the specified title. Uses the current image window as the parent frame or the ImageJ frame if no image windows are open.


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.

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

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