Difference between revisions of "User input"

(Add Learn sidebar)
(Add a screenshot of each technique in action)
 
Line 3: Line 3:
 
== Script Parameters ==
 
== Script Parameters ==
  
[[Script parameters]] are a fast, succinct option to make a GUI in ImageJ and beyond. Scripts written using the <code>#@</code> parameter syntax can also be consumed by other tools in the [[SciJava]] ecosystem, including [[KNIME]], [[OMERO]] and others. They are independent of user interface, meaning alternative GUIs coded in other frameworks—such as [[ImageJFX]] coded using JavaFX—can also present a GUI for your plugin/script that matches the application.
+
[[File:Script-parameters.png|400px|left]] [[Script parameters]] are a fast, succinct option to make a GUI in ImageJ and beyond. Scripts written using the <code>#@</code> parameter syntax can also be consumed by other tools in the [[SciJava]] ecosystem, including [[KNIME]], [[OMERO]] and others. They are independent of user interface, meaning alternative GUIs coded in other frameworks—such as [[ImageJFX]] coded using JavaFX—can also present a GUI for your plugin/script that matches the application.
  
 
Each parameter (integer, string input, etc.) corresponds to a user interface element, and is created by using a generic notation in the form <code>#@ ParameterType variableName</code> that is put at the top of the script.
 
Each parameter (integer, string input, etc.) corresponds to a user interface element, and is created by using a generic notation in the form <code>#@ ParameterType variableName</code> that is put at the top of the script.
Line 13: Line 13:
 
== GenericDialog ==
 
== GenericDialog ==
  
The [[generic dialog|GenericDialog]] class—part of [[ImageJ1]]—offers more flexibility than the [[script parameters]], including custom layout and buttons, but requires more coding—e.g., successive calls to the plugin do not automatically remember previously entered values. Plugins coded using <code>GenericDialog</code> are also not automatically usable in other [[SciJava]] tools such as [[KNIME]] or [[ImageJFX]].
+
[[File:Multi-column-dialog.png|300px|left]] The [[generic dialog|GenericDialog]] class—part of [[ImageJ1]]—offers more flexibility than the [[script parameters]], including custom layout and buttons, but requires more coding—e.g., successive calls to the plugin do not automatically remember previously entered values. Plugins coded using <code>GenericDialog</code> are also not automatically usable in other [[SciJava]] tools such as [[KNIME]] or [[ImageJFX]].
  
 
See the [[generic dialog]] page for further details.
 
See the [[generic dialog]] page for further details.

Latest revision as of 17:21, 6 June 2019

Learn
Topics
Introduction
Getting Started
User Guides
Tutorials
Tips and Tricks
Presentations
Plugins
Techniques
All Techniques
Colocalization
Deconvolution
Registration
Segmentation
Stitching
Tracking
Visualization
Scripting
Overview
User input
Basics of script writing
Batch processing
Script Editor
Auto Imports
Templates
Running headlessly
Comparisons
Toolbox
Multithreading in Clojure
Multithreading in JavaScript
Chess in Jython
Languages
BeanShell
Groovy
ImageJ Macro
JavaScript
Lisp (Clojure)
MATLAB
Python (Jython)
R (Renjin)
Ruby (JRuby)
Scala

Even though one could use any Java library to present a graphical user interface (GUI) for a script or plugin, there are mostly 2 recommended ways to collect input from the user in ImageJ. Both methods can be used with all available scripting languages, including the ImageJ macro language.

Script Parameters

Script-parameters.png
Script parameters are a fast, succinct option to make a GUI in ImageJ and beyond. Scripts written using the #@ parameter syntax can also be consumed by other tools in the SciJava ecosystem, including KNIME, OMERO and others. They are independent of user interface, meaning alternative GUIs coded in other frameworks—such as ImageJFX coded using JavaFX—can also present a GUI for your plugin/script that matches the application.

Each parameter (integer, string input, etc.) corresponds to a user interface element, and is created by using a generic notation in the form #@ ParameterType variableName that is put at the top of the script.

There are as many notations/lines as there are items to put in the GUI, and the items are rendered vertically in the resulting interface, in the order of appearance in the code.

See the script parameters page for further details.

GenericDialog

Multi-column-dialog.png
The GenericDialog class—part of ImageJ1—offers more flexibility than the script parameters, including custom layout and buttons, but requires more coding—e.g., successive calls to the plugin do not automatically remember previously entered values. Plugins coded using GenericDialog are also not automatically usable in other SciJava tools such as KNIME or ImageJFX.

See the generic dialog page for further details.