net.imagej.patcher.HeadlessGenericDialog Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ij1-patcher Show documentation
Show all versions of ij1-patcher Show documentation
A runtime patcher to introduce extension points into the original ImageJ (1.x). This project offers extension points for use with ImageJ2 and it also offers limited support for headless operations.
/*
* #%L
* ImageJ software for multidimensional image processing and analysis.
* %%
* Copyright (C) 2009 - 2016 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package net.imagej.patcher;
import ij.ImagePlus;
import ij.Macro;
import ij.gui.DialogListener;
import ij.plugin.filter.PlugInFilterRunner;
import java.awt.Button;
import java.awt.Checkbox;
import java.awt.Color;
import java.awt.Component;
import java.awt.Font;
import java.awt.Insets;
import java.awt.Panel;
import java.awt.TextArea;
import java.awt.event.FocusEvent;
import java.util.ArrayList;
import java.util.List;
import java.util.Vector;
/**
* Rump implementation of a pseudo dialog intended to stand in for the
* {@link ij.gui.GenericDialog} in headless mode. This class is inserted as the
* superclass to {@code 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 {@link ij.gui.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 {@link 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
*/
@SuppressWarnings("unused")
public class HeadlessGenericDialog {
protected List numbers;
protected List strings;
protected List checkboxes;
protected List choices;
protected List choiceIndices;
protected String textArea1, textArea2;
protected List radioButtons;
protected int numberfieldIndex = 0, stringfieldIndex = 0, checkboxIndex = 0, choiceIndex = 0, textAreaIndex = 0, radioButtonIndex = 0;
protected boolean invalidNumber;
protected String errorMessage;
protected DialogListener listener;
public HeadlessGenericDialog() {
if (Macro.getOptions() == null)
throw new RuntimeException("Cannot instantiate headless dialog except in macro mode");
numbers = new ArrayList();
strings = new ArrayList();
checkboxes = new ArrayList();
choices = new ArrayList();
choiceIndices = new ArrayList();
radioButtons = new ArrayList();
}
public void addCheckbox(String label, boolean defaultValue) {
checkboxes.add(getMacroParameter(label, defaultValue));
}
public void addCheckboxGroup(int rows, int columns, String[] labels, boolean[] defaultValues) {
for (int i = 0; i < labels.length; i++)
addCheckbox(labels[i], defaultValues[i]);
}
public void addCheckboxGroup(int rows, int columns, String[] labels, boolean[] defaultValues, String[] headings) {
addCheckboxGroup(rows, columns, labels, defaultValues);
}
public void addChoice(String label, String[] items, String defaultItem) {
String item = getMacroParameter(label, defaultItem);
int index = 0;
for (int i = 0; i < items.length; i++)
if (items[i].equals(item)) {
index = i;
break;
}
choiceIndices.add(index);
choices.add(items[index]);
}
public void addNumericField(String label, double defaultValue, int digits) {
numbers.add(getMacroParameter(label, defaultValue));
}
public void addNumericField(String label, double defaultValue, int digits, int columns, String units) {
addNumericField(label, defaultValue, digits);
}
public void addSlider(String label, double minValue, double maxValue, double defaultValue) {
numbers.add(getMacroParameter(label, defaultValue));
}
public void addSlider(String label, double minValue, double maxValue, double defaultValue, double stepSize) {
addSlider(label, minValue, maxValue, defaultValue);
}
public void addStringField(String label, String defaultText) {
strings.add(getMacroParameter(label, defaultText));
}
public void addStringField(String label, String defaultText, int columns) {
addStringField(label, defaultText);
}
public void addTextAreas(String text1, String text2, int rows, int columns) {
textArea1 = text1;
textArea2 = text2;
}
public boolean getNextBoolean() {
return checkboxes.get(checkboxIndex++);
}
public String getNextChoice() {
return choices.get(choiceIndex++);
}
public int getNextChoiceIndex() {
return choiceIndices.get(choiceIndex++);
}
public double getNextNumber() {
return numbers.get(numberfieldIndex++);
}
/** Returns the contents of the next text field. */
public String getNextString() {
return strings.get(stringfieldIndex++);
}
public String getNextText() {
switch (textAreaIndex++) {
case 0:
return textArea1;
case 1:
return textArea2;
}
return null;
}
/** Adds a radio button group. */
public void addRadioButtonGroup(String label, String[] items, int rows, int columns, String defaultItem) {
radioButtons.add(getMacroParameter(label, defaultItem));
}
public Vector getRadioButtonGroups() {
return new Vector(radioButtons);
}
/** Returns the selected item in the next radio button group. */
public String getNextRadioButton() {
return radioButtons.get(radioButtonIndex++);
}
public boolean invalidNumber() {
boolean wasInvalid = invalidNumber;
invalidNumber = false;
return wasInvalid;
}
public void showDialog() {
if (Macro.getOptions() == null)
throw new RuntimeException("Cannot run dialog headlessly");
resetCounters();
// NB: ImageJ 1.x has logic to call the first DialogListener at least once,
// in case the plugin _only_ updates its values via the dialogItemChanged
// method. See the bottom of the ij.gui.GenericDialog#showDialog() method.
if (listener != null) {
// NB: Thanks to Javassist, this class _will_ be a GenericDialog object.
listener.dialogItemChanged((ij.gui.GenericDialog) (Object) this, null);
resetCounters();
}
}
/**
* Resets the counters before reading the dialog parameters.
*/
private void resetCounters() {
numberfieldIndex = 0;
stringfieldIndex = 0;
checkboxIndex = 0;
choiceIndex = 0;
textAreaIndex = 0;
}
public boolean wasCanceled() {
return false;
}
public boolean wasOKed() {
return true;
}
public void dispose() {}
public void addDialogListener(DialogListener dl) {
if (listener != null) return;
// NB: Save the first DialogListener, for access during showDialog().
listener = dl;
}
public void addHelp(String url) {}
public void addImage(ImagePlus image) {}
public void addMessage(String text) {}
public void addMessage(String text, Font font) {}
public void addMessage(String text, Font font, Color color) {}
public void addPanel(Panel panel) {}
public void addPanel(Panel panel, int contraints, Insets insets) {}
public void addPreviewCheckbox(PlugInFilterRunner pfr) {}
public void addPreviewCheckbox(PlugInFilterRunner pfr, String label) {}
public void centerDialog(boolean b) {}
public void setSmartRecording(boolean smartRecording) {}
public void enableYesNoCancel() {}
public void enableYesNoCancel(String yesLabel, String noLabel) {}
public void focusGained(FocusEvent e) {}
public void focusLost(FocusEvent e) {}
public Button[] getButtons() { return null; }
public Vector getCheckboxes() { return null; }
public Vector getChoices() { return null; }
public String getErrorMessage() { return errorMessage; }
public Insets getInsets() { return null; }
public Component getMessage() { return null; }
public Vector getNumericFields() { return null; }
public Checkbox getPreviewCheckbox() { return null; }
public Vector getSliders() { return null; }
public Vector getStringFields() { return null; }
public TextArea getTextArea1() { return null; }
public TextArea getTextArea2() { return null; }
public void hideCancelButton() {}
public void previewRunning(boolean isRunning) {}
public void setEchoChar(char echoChar) {}
public void setHelpLabel(String label) {}
public void setInsets(int top, int left, int bottom) {}
public void setOKLabel(String label) {}
protected void setup() {}
public void accessTextFields() {}
public void showHelp() {}
public void setLocation(int x, int y) {}
public void setDefaultString(int index, String str) {}
public boolean isPreviewActive() { return false; }
/**
* Gets a macro parameter of type boolean.
*
* @param label
* the name of the macro parameter
* @param defaultValue
* the default value
* @return the boolean value
*/
private static boolean getMacroParameter(String label, boolean defaultValue) {
return findBooleanMacroParameter(label);
}
/**
* Looks whether a boolean was specified in the macro parameters.
*
* @param labelString
* the label to look for
* @return whether the label was found
*/
private static boolean findBooleanMacroParameter(final String labelString) {
final String optionsString = Macro.getOptions();
if (optionsString == null) {
return false;
}
final char[] options = optionsString.toCharArray();
final char[] label = Macro.trimKey(labelString).toCharArray();
for (int i = 0; i < options.length; i++) {
boolean match = true;
// match at start or after space
for (char c : label) {
if (c != options[i]) {
match = false;
break;
}
i++;
}
if (match && (i >= options.length || options[i] == ' ')) {
return true;
}
// look for next space
while (i < options.length && options[i] != ' ') {
// skip literal
if (options[i] == '[') {
while (i < options.length && options[i] != ']') {
i++;
}
}
i++;
}
}
return false;
}
/**
* Gets a macro parameter of type double.
*
* @param label
* the name of the macro parameter
* @param defaultValue
* the default value
* @return the double value
*/
private static double getMacroParameter(String label, double defaultValue) {
String value = Macro.getValue(Macro.getOptions(), label, null);
return value != null ? Double.parseDouble(value) : defaultValue;
}
/**
* Gets a macro parameter of type {@link String}.
*
* @param label
* the name of the macro parameter
* @param defaultValue
* the default value
* @return the value
*/
private static String getMacroParameter(String label, String defaultValue) {
return Macro.getValue(Macro.getOptions(), label, defaultValue);
}
}