GenericDialogPlus (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Dialog
      - ij.gui.GenericDialog
        
        fiji.util.gui.GenericDialogPlus

All Implemented Interfaces:

ActionListener, AdjustmentListener, FocusListener, ItemListener, KeyListener, TextListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

EnhancedGenericDialog, OpenerGenericDialog
```
public class GenericDialogPlus
extends GenericDialog
```
The GenericDialogPlus class enhances the GenericDialog by a few additional methods. It adds a method to add a file chooser, a dialog chooser, an image chooser, a button, and makes string (and file) fields drop targets.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Dialog
  Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
- Nested classes/interfaces inherited from class java.awt.Window
  Window.AccessibleAWTWindow, Window.Type
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type Field and Description

protected int[] windowIDs

protected String[] windowTitles
- Fields inherited from class ij.gui.GenericDialog
  checkbox, choice, defaultChoiceIndexes, defaultStrings, defaultText, defaultValues, numberField, radioButtonGroups, slider, stringField, textArea1, textArea2, theLabel
- Fields inherited from class java.awt.Dialog
  DEFAULT_MODALITY_TYPE
- Fields inherited from class java.awt.Component
  accessibleContext, 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

Fields
Modifier and Type	Field and Description
`protected int[]`	`windowIDs`
`protected String[]`	`windowTitles`

Constructor Summary

Constructors
Constructor and Description

GenericDialogPlus(String title)

GenericDialogPlus(String title, Frame parent)

Constructors
Constructor and Description
`GenericDialogPlus(String title)`
`GenericDialogPlus(String title, Frame parent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addButton(String label, ActionListener listener)` Add button to the dialog
`void`	`addComponent(Component component)`
`void`	`addComponent(Component component, int fill, double weightx)`
`void`	`addDirectoryField(String label, String defaultPath)`
`void`	`addDirectoryField(String label, String defaultPath, int columns)`
`void`	`addDirectoryOrFileField(String label, String defaultPath)`
`void`	`addDirectoryOrFileField(String label, String defaultPath, int columns)`
`void`	`addFileField(String label, String defaultPath)`
`void`	`addFileField(String label, String defaultPath, int columns)`
`JLabel`	`addImage(ImageIcon image)` Adds an image to the generic dialog
`boolean`	`addImage(String path)` Adds an image to the generic dialog
`boolean`	`addImage(URL imgURL)` Adds an image to the generic dialog
`void`	`addImageChoice(String label, String defaultImage)`
`void`	`addStringField(String label, String defaultString, int columns)`
`static ImageIcon`	`createImageIcon(URL imgURL)` Returns an ImageIcon, or null if the path was invalid.
`protected GridBagConstraints`	`getConstraints()`
`ij.ImagePlus`	`getNextImage()`
`void`	`keyPressed(KeyEvent e)`
`void`	`keyReleased(KeyEvent e)`
`void`	`keyTyped(KeyEvent e)`

Methods inherited from class ij.gui.GenericDialog
actionPerformed, addCheckbox, addCheckboxGroup, addCheckboxGroup, addChoice, addDialogListener, addHelp, addImage, addMessage, addMessage, addMessage, addNumericField, addNumericField, addNumericField, addPanel, addPanel, addPreviewCheckbox, addPreviewCheckbox, addRadioButtonGroup, addSlider, addSlider, addStringField, addTextAreas, addToSameRow, adjustmentValueChanged, centerDialog, dispose, enableYesNoCancel, enableYesNoCancel, focusGained, focusLost, getButtons, getCheckboxes, getChoices, getErrorMessage, getInsets, getInstance, getLabel, getMessage, getNextBoolean, getNextChoice, getNextChoiceIndex, getNextNumber, getNextRadioButton, getNextString, getNextText, getNumericFields, getPreviewCheckbox, getRadioButtonGroups, getSliders, getStringFields, getTextArea1, getTextArea2, getValue, hideCancelButton, invalidNumber, isMacro, isPreviewActive, itemStateChanged, paint, parseDouble, previewRunning, repaint, setCancelLabel, setDefaultString, setEchoChar, setFont, setHelpLabel, setInsets, setLocation, setOKLabel, setSmartRecording, setup, showDialog, textValueChanged, wasCanceled, wasOKed, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.awt.Dialog
addNotify, getAccessibleContext, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, paramString, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, remove, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

windowIDs
```
protected int[] windowIDs
```

windowTitles
```
protected String[] windowTitles
```

Constructor Detail

GenericDialogPlus

public GenericDialogPlus(String title)

GenericDialogPlus

public GenericDialogPlus(String title,
                         Frame parent)

Method Detail

addImageChoice

public void addImageChoice(String label,
                           String defaultImage)

Overrides:: addImageChoice in class GenericDialog

getNextImage
```
public ij.ImagePlus getNextImage()
```
Overrides:

getNextImage in class GenericDialog

addStringField

public void addStringField(String label,
                           String defaultString,
                           int columns)

Overrides:: addStringField in class GenericDialog

addDirectoryOrFileField

public void addDirectoryOrFileField(String label,
                                    String defaultPath)

addDirectoryOrFileField

public void addDirectoryOrFileField(String label,
                                    String defaultPath,
                                    int columns)

addDirectoryField

public void addDirectoryField(String label,
                              String defaultPath)

Overrides:: addDirectoryField in class GenericDialog

addDirectoryField

public void addDirectoryField(String label,
                              String defaultPath,
                              int columns)

Overrides:: addDirectoryField in class GenericDialog

addFileField

public void addFileField(String label,
                         String defaultPath)

Overrides:: addFileField in class GenericDialog

addFileField

public void addFileField(String label,
                         String defaultPath,
                         int columns)

Overrides:: addFileField in class GenericDialog

addButton
```
public void addButton(String label,
                      ActionListener listener)
```
Add button to the dialog

Parameters:

label - button label

listener - listener to handle the action when pressing the button

addComponent

public void addComponent(Component component)

addComponent

public void addComponent(Component component,
                         int fill,
                         double weightx)

addImage
```
public boolean addImage(String path)
```
Adds an image to the generic dialog

Parameters:

path - - the path to the image in the jar, e.g. /images/fiji.png (the first / has to be there!)

Returns:

true if the image was found and added, otherwise false

addImage
```
public boolean addImage(URL imgURL)
```
Adds an image to the generic dialog

Parameters:

imgURL - - the URL pointing to the resource

Returns:

true if the image was found and added, otherwise false

addImage
```
public JLabel addImage(ImageIcon image)
```
Adds an image to the generic dialog

Parameters:

image - - the ImageIcon to display

Returns:

label - the JLabel that contains the image for updating: image.setImage(otherImageIcon.getImage()); label.update(label.getGraphics());

createImageIcon
```
public static ImageIcon createImageIcon(URL imgURL)
```
Returns an ImageIcon, or null if the path was invalid.

getConstraints

protected GridBagConstraints getConstraints()

keyPressed
```
public void keyPressed(KeyEvent e)
```
Specified by:

keyPressed in interface KeyListener

Overrides:

keyPressed in class GenericDialog

keyReleased
```
public void keyReleased(KeyEvent e)
```
Specified by:

keyReleased in interface KeyListener

Overrides:

keyReleased in class GenericDialog

keyTyped
```
public void keyTyped(KeyEvent e)
```
Specified by:

keyTyped in interface KeyListener

Overrides:

keyTyped in class GenericDialog

Class GenericDialogPlus

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Dialog

Nested classes/interfaces inherited from class java.awt.Window

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class ij.gui.GenericDialog

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class ij.gui.GenericDialog

Methods inherited from class java.awt.Dialog

Methods inherited from class java.awt.Window

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

windowIDs

windowTitles

Constructor Detail

GenericDialogPlus

GenericDialogPlus

Method Detail

addImageChoice

getNextImage

addStringField

addDirectoryOrFileField

addDirectoryOrFileField

addDirectoryField

addDirectoryField

addFileField

addFileField

addButton

addComponent

addComponent

addImage

addImage

addImage

createImageIcon

getConstraints

keyPressed

keyReleased

keyTyped