HeadlessGenericDialog (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.patcher.HeadlessGenericDialog

```
public class HeadlessGenericDialog
extends Object
```
Rump implementation of a pseudo dialog intended to stand in for the GenericDialog in headless mode. This class is inserted as the superclass to GenericDialog, cutting off its AWT inheritance. Then the methods of this class are given precedence, effectively reverse-overriding its subclass.
The guidelines for whether or not an GenericDialog method should be overridden by this class or not are:
- If the method is not public, it does not need to be overridden.
- If the method is inherited from an AWT superclass it will automatically be converted to a stub and does not need to be overridden.
- If the method is explicitly stubified by LegacyHeadless, it does not need to be overridden.
- If the method is public but can still function as normal while headless, it does not need to be overridden.
All other public methods should be overridden.
Author:

Johannes Schindelin

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Boolean>`	`checkboxes`
`protected int`	`checkboxIndex`
`protected int`	`choiceIndex`
`protected List<Integer>`	`choiceIndices`
`protected List<String>`	`choices`
`protected List<File>`	`directories`
`protected String`	`errorMessage`
`protected List<File>`	`files`
`protected boolean`	`invalidNumber`
`protected DialogListener`	`listener`
`protected int`	`numberfieldIndex`
`protected List<Double>`	`numbers`
`protected int`	`radioButtonIndex`
`protected List<String>`	`radioButtons`
`protected int`	`stringfieldIndex`
`protected List<String>`	`strings`
`protected String`	`textArea1`
`protected String`	`textArea2`
`protected int`	`textAreaIndex`

Constructor Summary

Constructors
Constructor and Description

HeadlessGenericDialog()

Constructors
Constructor and Description
`HeadlessGenericDialog()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accessTextFields()`
`void`	`addCheckbox(String label, boolean defaultValue)`
`void`	`addCheckboxGroup(int rows, int columns, String[] labels, boolean[] defaultValues)`
`void`	`addCheckboxGroup(int rows, int columns, String[] labels, boolean[] defaultValues, String[] headings)`
`void`	`addChoice(String label, String[] items, String defaultItem)`
`void`	`addDialogListener(DialogListener dl)`
`void`	`addDirectoryField(String label, String defaultPath)`
`void`	`addDirectoryField(String label, String defaultPath, int columns)`
`void`	`addFileField(String label, String defaultPath)`
`void`	`addFileField(String label, String defaultPath, int columns)`
`void`	`addHelp(String url)`
`void`	`addImage(ij.ImagePlus image)`
`void`	`addImageChoice(String label, String defaultImage)`
`void`	`addMessage(String text)`
`void`	`addMessage(String text, Font font)`
`void`	`addMessage(String text, Font font, Color color)`
`void`	`addNumericField(String label, double defaultValue)`
`void`	`addNumericField(String label, double defaultValue, int digits)`
`void`	`addNumericField(String label, double defaultValue, int digits, int columns, String units)`
`void`	`addPanel(Panel panel)`
`void`	`addPanel(Panel panel, int contraints, Insets insets)`
`void`	`addPreviewCheckbox(ij.plugin.filter.PlugInFilterRunner pfr)`
`void`	`addPreviewCheckbox(ij.plugin.filter.PlugInFilterRunner pfr, String label)`
`void`	`addRadioButtonGroup(String label, String[] items, int rows, int columns, String defaultItem)` Adds a radio button group.
`void`	`addSlider(String label, double minValue, double maxValue, double defaultValue)`
`void`	`addSlider(String label, double minValue, double maxValue, double defaultValue, double stepSize)`
`void`	`addStringField(String label, String defaultText)`
`void`	`addStringField(String label, String defaultText, int columns)`
`void`	`addTextAreas(String text1, String text2, int rows, int columns)`
`void`	`centerDialog(boolean b)`
`void`	`dispose()`
`void`	`enableYesNoCancel()`
`void`	`enableYesNoCancel(String yesLabel, String noLabel)`
`void`	`finalizeRecording()`
`void`	`focusGained(FocusEvent e)`
`void`	`focusLost(FocusEvent e)`
`Button[]`	`getButtons()`
`Vector<?>`	`getCheckboxes()`
`Vector<?>`	`getChoices()`
`String`	`getErrorMessage()`
`Insets`	`getInsets()`
`Component`	`getMessage()`
`boolean`	`getNextBoolean()`
`String`	`getNextChoice()`
`int`	`getNextChoiceIndex()`
`ij.ImagePlus`	`getNextImage()`
`double`	`getNextNumber()`
`String`	`getNextRadioButton()` Returns the selected item in the next radio button group.
`String`	`getNextString()` Returns the contents of the next text field.
`String`	`getNextText()`
`Vector<?>`	`getNumericFields()`
`Checkbox`	`getPreviewCheckbox()`
`Vector<String>`	`getRadioButtonGroups()`
`Vector<?>`	`getSliders()`
`Vector<?>`	`getStringFields()`
`TextArea`	`getTextArea1()`
`TextArea`	`getTextArea2()`
`void`	`hideCancelButton()`
`boolean`	`invalidNumber()`
`boolean`	`isPreviewActive()`
`void`	`previewRunning(boolean isRunning)`
`void`	`setDefaultString(int index, String str)`
`void`	`setEchoChar(char echoChar)`
`void`	`setHelpLabel(String label)`
`void`	`setInsets(int top, int left, int bottom)`
`void`	`setLocation(int x, int y)`
`void`	`setOKLabel(String label)`
`void`	`setSmartRecording(boolean smartRecording)`
`protected void`	`setup()`
`void`	`show()`
`void`	`showDialog()`
`void`	`showHelp()`
`boolean`	`wasCanceled()`
`boolean`	`wasOKed()`

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

Field Detail

numbers
```
protected List<Double> numbers
```

strings
```
protected List<String> strings
```

checkboxes
```
protected List<Boolean> checkboxes
```

choices
```
protected List<String> choices
```

choiceIndices
```
protected List<Integer> choiceIndices
```

textArea1
```
protected String textArea1
```

textArea2
```
protected String textArea2
```

radioButtons
```
protected List<String> radioButtons
```

files
```
protected List<File> files
```

directories
```
protected List<File> directories
```

numberfieldIndex
```
protected int numberfieldIndex
```

stringfieldIndex
```
protected int stringfieldIndex
```

checkboxIndex
```
protected int checkboxIndex
```

choiceIndex
```
protected int choiceIndex
```

textAreaIndex
```
protected int textAreaIndex
```

radioButtonIndex
```
protected int radioButtonIndex
```

invalidNumber
```
protected boolean invalidNumber
```

errorMessage
```
protected String errorMessage
```

listener
```
protected DialogListener listener
```

Constructor Detail
- HeadlessGenericDialog
```
public HeadlessGenericDialog()
```

Method Detail

addCheckbox

public void addCheckbox(String label,
                        boolean defaultValue)

addCheckboxGroup

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

addCheckboxGroup

public void addCheckboxGroup(int rows,
                             int columns,
                             String[] labels,
                             boolean[] defaultValues,
                             String[] headings)

addChoice

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

addNumericField

public void addNumericField(String label,
                            double defaultValue)

addNumericField

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

addNumericField

public void addNumericField(String label,
                            double defaultValue,
                            int digits,
                            int columns,
                            String units)

addSlider

public void addSlider(String label,
                      double minValue,
                      double maxValue,
                      double defaultValue)

addSlider

public void addSlider(String label,
                      double minValue,
                      double maxValue,
                      double defaultValue,
                      double stepSize)

addStringField

public void addStringField(String label,
                           String defaultText)

addStringField

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

addTextAreas

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

getNextBoolean
```
public boolean getNextBoolean()
```

getNextChoice
```
public String getNextChoice()
```

getNextChoiceIndex
```
public int getNextChoiceIndex()
```

getNextNumber
```
public double getNextNumber()
```

getNextString
```
public String getNextString()
```
Returns the contents of the next text field.

getNextText
```
public String getNextText()
```

addRadioButtonGroup

public void addRadioButtonGroup(String label,
                                String[] items,
                                int rows,
                                int columns,
                                String defaultItem)

Adds a radio button group.

getRadioButtonGroups

public Vector<String> getRadioButtonGroups()

getNextRadioButton
```
public String getNextRadioButton()
```
Returns the selected item in the next radio button group.

invalidNumber
```
public boolean invalidNumber()
```

showDialog
```
public void showDialog()
```

wasCanceled
```
public boolean wasCanceled()
```

wasOKed
```
public boolean wasOKed()
```

dispose
```
public void dispose()
```

addDialogListener

public void addDialogListener(DialogListener dl)

addHelp
```
public void addHelp(String url)
```

addImage

public void addImage(ij.ImagePlus image)

addMessage
```
public void addMessage(String text)
```

addMessage

public void addMessage(String text,
                       Font font)

addMessage

public void addMessage(String text,
                       Font font,
                       Color color)

addPanel
```
public void addPanel(Panel panel)
```

addPanel

public void addPanel(Panel panel,
                     int contraints,
                     Insets insets)

addPreviewCheckbox

public void addPreviewCheckbox(ij.plugin.filter.PlugInFilterRunner pfr)

addPreviewCheckbox

public void addPreviewCheckbox(ij.plugin.filter.PlugInFilterRunner pfr,
                               String label)

centerDialog
```
public void centerDialog(boolean b)
```

setSmartRecording

public void setSmartRecording(boolean smartRecording)

enableYesNoCancel
```
public void enableYesNoCancel()
```

enableYesNoCancel

public void enableYesNoCancel(String yesLabel,
                              String noLabel)

finalizeRecording
```
public void finalizeRecording()
```

focusGained

public void focusGained(FocusEvent e)

focusLost
```
public void focusLost(FocusEvent e)
```

addFileField

public void addFileField(String label,
                         String defaultPath)

addFileField

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

addDirectoryField

public void addDirectoryField(String label,
                              String defaultPath)

addDirectoryField

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

addImageChoice

public void addImageChoice(String label,
                           String defaultImage)

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

getButtons
```
public Button[] getButtons()
```

getCheckboxes
```
public Vector<?> getCheckboxes()
```

getChoices
```
public Vector<?> getChoices()
```

getErrorMessage
```
public String getErrorMessage()
```

getInsets
```
public Insets getInsets()
```

getMessage
```
public Component getMessage()
```

getNumericFields
```
public Vector<?> getNumericFields()
```

getPreviewCheckbox
```
public Checkbox getPreviewCheckbox()
```

getSliders
```
public Vector<?> getSliders()
```

getStringFields
```
public Vector<?> getStringFields()
```

getTextArea1
```
public TextArea getTextArea1()
```

getTextArea2
```
public TextArea getTextArea2()
```

hideCancelButton
```
public void hideCancelButton()
```

previewRunning

public void previewRunning(boolean isRunning)

setEchoChar

public void setEchoChar(char echoChar)

setHelpLabel

public void setHelpLabel(String label)

setInsets

public void setInsets(int top,
                      int left,
                      int bottom)

setOKLabel
```
public void setOKLabel(String label)
```

setup
```
protected void setup()
```

accessTextFields
```
public void accessTextFields()
```

show
```
public void show()
```

showHelp
```
public void showHelp()
```

setLocation

public void setLocation(int x,
                        int y)

setDefaultString

public void setDefaultString(int index,
                             String str)

isPreviewActive
```
public boolean isPreviewActive()
```

Class HeadlessGenericDialog

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numbers

strings

checkboxes

choices

choiceIndices

textArea1

textArea2

radioButtons

files

directories

numberfieldIndex

stringfieldIndex

checkboxIndex

choiceIndex

textAreaIndex

radioButtonIndex

invalidNumber

errorMessage

listener

Constructor Detail

HeadlessGenericDialog

Method Detail

addCheckbox

addCheckboxGroup

addCheckboxGroup

addChoice

addNumericField

addNumericField

addNumericField

addSlider

addSlider

addStringField

addStringField

addTextAreas

getNextBoolean

getNextChoice

getNextChoiceIndex

getNextNumber

getNextString

getNextText

addRadioButtonGroup

getRadioButtonGroups

getNextRadioButton

invalidNumber

showDialog

wasCanceled

wasOKed

dispose

addDialogListener

addHelp

addImage

addMessage

addMessage

addMessage

addPanel

addPanel

addPreviewCheckbox

addPreviewCheckbox

centerDialog

setSmartRecording

enableYesNoCancel

enableYesNoCancel

finalizeRecording

focusGained

focusLost

addFileField

addFileField

addDirectoryField

addDirectoryField

addImageChoice

getNextImage

getButtons

getCheckboxes

getChoices