IJ1Helper (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - net.imagej.legacy.IJ1Helper

All Implemented Interfaces:

Contextual
```
public class IJ1Helper
extends AbstractContextual
```
A helper class to interact with ImageJ 1.x.
The LegacyService needs to patch ImageJ 1.x's classes before they are loaded. Unfortunately, this is tricky: if the LegacyService already uses those classes, it is a matter of luck whether we can get the patches in before those classes are loaded.

Therefore, we put as much interaction with ImageJ 1.x as possible into this class and keep a reference to it in the LegacyService.

Author:

Johannes Schindelin

Constructor Summary

Constructors
Constructor and Description

IJ1Helper(LegacyService legacyService)

Constructors
Constructor and Description
`IJ1Helper(LegacyService legacyService)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAliases(ScriptService scriptService)` Add name aliases for ImageJ1 classes to the ScriptService.
`void`	`addCommand(String menuPath, String label, String command)`
`void`	`addMenuItems()` Adds legacy-compatible scripts and commands to the ImageJ1 menu structure.
`void`	`appAbout()` Displays the About ImageJ 1.x dialog.
`void`	`appPrefs()` Handles display of the ImageJ 1.x preferences.
`void`	`appQuit()` Handles shutdown of ImageJ 1.x.
`String`	`commandsName()`
`void`	`dispose()` Forcibly shuts down ImageJ1, with no user interaction or opportunity to cancel.
`void`	`finishRecording()` Completes recording of a command.
`static String`	`getAdditionalMacroFunctions()` Gets the result of `Interpreter.getAdditionalFunctions()`.
`ClassLoader`	`getClassLoader()`
`Hashtable<String,String>`	`getCommands()`
`String`	`getDirectory(String title, File file)` Chooses a directory using ImageJ 1.x' directory chooser.
`int[]`	`getIDList()`
`Frame`	`getIJ()`
`ij.ImagePlus`	`getImage(int imageID)`
`int`	`getImageID(Object o)` Gets the ID of the given `ImagePlus` object.
`static Object`	`getInterpreter()` Returns the active macro `Interpreter`.
`static Context`	`getLegacyContext()` Gets the SciJava application context linked to the ImageJ 1.x instance.
`String`	`getMacroParameter(String label)` Gets a macro parameter of type `String`.
`boolean`	`getMacroParameter(String label, boolean defaultValue)` Gets a macro parameter of type boolean.
`double`	`getMacroParameter(String label, double defaultValue)` Gets a macro parameter of type double.
`String`	`getMacroParameter(String label, String defaultValue)` Gets a macro parameter of type `String`.
`MenuBar`	`getMenuBar()`
`String`	`getOptions()` Delegates to ImageJ 1.x' `Macro.getOptions()` function.
`Object`	`getSearchBar()`
`Hashtable<Integer,String>`	`getShortcuts()`
`Panel`	`getStatusBar()`
`static String`	`getTitle(Object o)` Returns `ImagePlus.getTitle()` if the object is an `ImagePlus`, otherwise null.
`Component`	`getToolBar()`
`Object`	`getVariable(Object interpreter, String name)` Gets the value of the specified variable, from the given macro `Interpreter`.
`String[]`	`getVariables(Object interpreter)` Gets the value of the specified variable, from the given macro `Interpreter`.
`String`	`getVersion()` Gets the version of ImageJ 1.x.
`int`	`getX()`
`int`	`getY()`
`void`	`handleException(Throwable e)` Delegate exception handling to ImageJ 1.x.
`boolean`	`hasInstance()`
`void`	`initialize()`
`boolean`	`isDisposing()` Whether we are in the process of forcibly shutting down ImageJ1.
`boolean`	`isImagePlus(Class<?> c)` Returns true if the class is assignable to `ImagePlus`.
`boolean`	`isImagePlus(Object o)` Returns true if the object is an instance of `ImagePlus`.
`boolean`	`isMacintosh()`
`boolean`	`isMacro()` Determines whether we're running inside a macro right now.
`boolean`	`isRMIEnabled()` Determines whether Edit>Options>Misc...>Run single instance listener is set.
`boolean`	`isVisible()`
`boolean`	`isWindowClosed(Frame window)`
`static void`	`openAndAddToRecent(File file)` Opens an image and adds the path to the File>Open Recent menu.
`File`	`openDialog(String title)` Uses ImageJ 1.x' OpenDialog
`File`	`openDialog(String title, File file)` Uses ImageJ 1.x' OpenDialog
`Object`	`openImage(String path)` Opens an image using ImageJ 1.x.
`Object`	`openImage(String path, boolean show)` Opens an image using ImageJ 1.x.
`void`	`openPathDirectly(String path)` Opens a path using ImageJ 1.x, bypassing the (javassisted) IJ utility class.
`boolean`	`quitting()`
`void`	`recordOption(String key, String value)` Records an option in ImageJ 1.x's macro recorder, safely.
`void`	`run(String command)` Evaluates the specified command.
`String`	`runMacro(String macro)` Evaluates the specified macro.
`String`	`runMacroFile(String path, String arg)` Evaluates the specified macro.
`File`	`saveDialog(String title, File file, String extension)` Uses ImageJ 1.x' SaveDialog
`void`	`setCheckNameDuplicates(boolean checkDuplicates)` Sets `WindowManager` `checkForDuplicateName` field.
`void`	`setDebugMode(boolean debug)` Enables or disables ImageJ 1.x' debug mode.
`void`	`setDefaultDirectory(File directory)` Sets OpenDialog's default directory
`void`	`setKeyDown(int keyCode)`
`void`	`setKeyUp(int keyCode)`
`void`	`setLocation(int x, int y)`
`void`	`setOptions(String options)` Delegates to ImageJ 1.x' `Macro.setOptions(String)` function.
`void`	`setProgress(int val, int max)`
`void`	`setStatus(String message)`
`void`	`setVisible(boolean toggle)`
`boolean`	`shiftKeyDown()` Ask ImageJ 1.x whether it thinks whether the Shift key is held down.
`void`	`showMessage(String title, String message)`
`boolean`	`showMessageWithCancel(String title, String message)`
`void`	`startRecording(String command)` Begins recording of a command.
`static void`	`subscribeEvents(Context context)`
`void`	`syncActiveImage(ImageDisplay activeDisplay)`
`void`	`updateRecentMenu(String path)`

Methods inherited from class org.scijava.AbstractContextual
context, getContext

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

Methods inherited from interface org.scijava.Contextual
setContext

- Constructor Detail
  - IJ1Helper
```
public IJ1Helper(LegacyService legacyService)
```
- Method Detail
  - initialize
```
public void initialize()
```
  - dispose
```
public void dispose()
```
    Forcibly shuts down ImageJ1, with no user interaction or opportunity to cancel. If ImageJ1 is not currently initialized, or if ImageJ1 is already in the process of quitting (i.e., ImageJ.quitting() returns true), then this method does nothing.
  - isDisposing
```
public boolean isDisposing()
```
    Whether we are in the process of forcibly shutting down ImageJ1.
  - addAliases
```
public void addAliases(ScriptService scriptService)
```
    Add name aliases for ImageJ1 classes to the ScriptService.
  - isVisible
```
public boolean isVisible()
```
  - isRMIEnabled
```
public boolean isRMIEnabled()
```
    Determines whether Edit>Options>Misc...>Run single instance listener is set.
    
    Returns:
    
    true if Run single instance listener is set
  - setCheckNameDuplicates
```
public void setCheckNameDuplicates(boolean checkDuplicates)
```
    Sets WindowManager checkForDuplicateName field.
  - setVisible
```
public void setVisible(boolean toggle)
```
  - syncActiveImage
```
public void syncActiveImage(ImageDisplay activeDisplay)
```
  - setKeyDown
```
public void setKeyDown(int keyCode)
```
  - setKeyUp
```
public void setKeyUp(int keyCode)
```
  - hasInstance
```
public boolean hasInstance()
```
  - getVersion
```
public String getVersion()
```
    Gets the version of ImageJ 1.x.
  - isMacintosh
```
public boolean isMacintosh()
```
  - setStatus
```
public void setStatus(String message)
```
  - setProgress
```
public void setProgress(int val,
                        int max)
```
  - getToolBar
```
public Component getToolBar()
```
  - getStatusBar
```
public Panel getStatusBar()
```
  - getSearchBar
```
public Object getSearchBar()
```
  - getIJ
```
public Frame getIJ()
```
  - setLocation
```
public void setLocation(int x,
                        int y)
```
  - getX
```
public int getX()
```
  - getY
```
public int getY()
```
  - isWindowClosed
```
public boolean isWindowClosed(Frame window)
```
  - quitting
```
public boolean quitting()
```
  - getIDList
```
public int[] getIDList()
```
  - getImage
```
public ij.ImagePlus getImage(int imageID)
```
  - getTitle
```
public static String getTitle(Object o)
```
    Returns ImagePlus.getTitle() if the object is an ImagePlus, otherwise null.
  - getClassLoader
```
public ClassLoader getClassLoader()
```
  - showMessage
```
public void showMessage(String title,
                        String message)
```
  - showMessageWithCancel
```
public boolean showMessageWithCancel(String title,
                                     String message)
```
  - commandsName
```
public String commandsName()
```
  - updateRecentMenu
```
public void updateRecentMenu(String path)
```
  - openAndAddToRecent
```
public static void openAndAddToRecent(File file)
```
    Opens an image and adds the path to the File>Open Recent menu.
    
    Parameters:
    
    file - the image to open
  - recordOption
```
public void recordOption(String key,
                         String value)
```
    Records an option in ImageJ 1.x's macro recorder, safely.
    Both the key and the value will be escaped to avoid problems. This behavior differs from direct calls to Recorder.recordOption(String, String), which do not escape either string.
    
    Parameters:
    
    key - the name of the option
    
    value - the value of the option
  - startRecording
```
public void startRecording(String command)
```
    Begins recording of a command.
    
    See Also:
    
    Recorder.setCommand(String)
  - finishRecording
```
public void finishRecording()
```
    Completes recording of a command.
    
    See Also:
    
    Recorder.saveCommand()
  - isMacro
```
public boolean isMacro()
```
    Determines whether we're running inside a macro right now.
    
    Returns:
    
    whether we're running a macro right now.
  - getMacroParameter
```
public boolean getMacroParameter(String label,
                                 boolean defaultValue)
```
    Gets a macro parameter of type boolean.
    
    Parameters:
    
    label - the name of the macro parameter
    
    defaultValue - the default value
    
    Returns:
    
    the boolean value
  - getMacroParameter
```
public double getMacroParameter(String label,
                                double defaultValue)
```
    Gets a macro parameter of type double.
    
    Parameters:
    
    label - the name of the macro parameter
    
    defaultValue - the default value
    
    Returns:
    
    the double value
  - getMacroParameter
```
public String getMacroParameter(String label,
                                String defaultValue)
```
    Gets a macro parameter of type String.
    
    Parameters:
    
    label - the name of the macro parameter
    
    defaultValue - the default value
    
    Returns:
    
    the value
  - getMacroParameter
```
public String getMacroParameter(String label)
```
    Gets a macro parameter of type String.
    
    Parameters:
    
    label - the name of the macro parameter
    
    Returns:
    
    the value, null if the parameter was not specified
  - getInterpreter
```
public static Object getInterpreter()
```
    Returns the active macro Interpreter.
  - getAdditionalMacroFunctions
```
public static String getAdditionalMacroFunctions()
```
    Gets the result of Interpreter.getAdditionalFunctions().
  - getVariables
```
public String[] getVariables(Object interpreter)
```
    Gets the value of the specified variable, from the given macro Interpreter.
    
    Parameters:
    
    interpreter - The macro Interpreter to query.
    
    Returns:
    
    The list of variables in key\tvalue form, as given by Interpreter.getVariables().
    
    Throws:
    
    ClassCastException - if the given interpreter is not an Interpreter.
  - getVariable
```
public Object getVariable(Object interpreter,
                          String name)
```
    Gets the value of the specified variable, from the given macro Interpreter.
    
    Parameters:
    
    interpreter - The macro Interpreter to query.
    
    name - The name of the variable to retrieve.
    
    Returns:
    
    The value of the requested variable, as either a String, a Double or null.
    
    Throws:
    
    ClassCastException - if the given interpreter is not an Interpreter.
  - isImagePlus
```
public boolean isImagePlus(Object o)
```
    Returns true if the object is an instance of ImagePlus.
  - isImagePlus
```
public boolean isImagePlus(Class<?> c)
```
    Returns true if the class is assignable to ImagePlus.
  - getImageID
```
public int getImageID(Object o)
```
    Gets the ID of the given ImagePlus object. If the given object is not an ImagePlus, throws IllegalArgumentException.
    
    Parameters:
    
    o - The ImagePlus whose ID is needed.
    
    Returns:
    
    The value of ImagePlus.getID().
    
    Throws:
    
    ClassCastException - if the given object is not an ImagePlus.
    
    See Also:
    
    isImagePlus(Object)
  - getLegacyContext
```
public static Context getLegacyContext()
```
    Gets the SciJava application context linked to the ImageJ 1.x instance.
  - subscribeEvents
```
public static void subscribeEvents(Context context)
```
  - getCommands
```
public Hashtable<String,String> getCommands()
```
  - addCommand
```
public void addCommand(String menuPath,
                       String label,
                       String command)
```
  - getShortcuts
```
public Hashtable<Integer,String> getShortcuts()
```
  - getMenuBar
```
public MenuBar getMenuBar()
```
  - addMenuItems
```
public void addMenuItems()
```
    Adds legacy-compatible scripts and commands to the ImageJ1 menu structure.
  - run
```
public void run(String command)
```
    Evaluates the specified command.
    
    Parameters:
    
    command - the command to execute
  - runMacro
```
public String runMacro(String macro)
```
    Evaluates the specified macro.
    
    Parameters:
    
    macro - the macro to evaluate
    
    Returns:
    
    the return value
  - runMacroFile
```
public String runMacroFile(String path,
                           String arg)
```
    Evaluates the specified macro.
    
    Parameters:
    
    path - the macro file to evaluate
    
    arg - the macro argument
    
    Returns:
    
    the return value
  - openImage
```
public Object openImage(String path)
```
    Opens an image using ImageJ 1.x.
    
    Parameters:
    
    path - the image file to open
    
    Returns:
    
    the image
  - openImage
```
public Object openImage(String path,
                        boolean show)
```
    Opens an image using ImageJ 1.x.
    
    Parameters:
    
    path - the image file to open
    
    Returns:
    
    the image
  - openPathDirectly
```
public void openPathDirectly(String path)
```
    Opens a path using ImageJ 1.x, bypassing the (javassisted) IJ utility class.
    
    Parameters:
    
    path - the image file to open
  - setDebugMode
```
public void setDebugMode(boolean debug)
```
    Enables or disables ImageJ 1.x' debug mode.
    
    Parameters:
    
    debug - whether to show debug messages or not
  - handleException
```
public void handleException(Throwable e)
```
    Delegate exception handling to ImageJ 1.x.
    
    Parameters:
    
    e - the exception to handle
  - shiftKeyDown
```
public boolean shiftKeyDown()
```
    Ask ImageJ 1.x whether it thinks whether the Shift key is held down.
    
    Returns:
    
    whether the Shift key is considered down
  - getOptions
```
public String getOptions()
```
    Delegates to ImageJ 1.x' Macro.getOptions() function.
    
    Returns:
    
    the macro options, or null
  - setOptions
```
public void setOptions(String options)
```
    Delegates to ImageJ 1.x' Macro.setOptions(String) function.
    
    Parameters:
    
    options - the macro options, or null to reset
  - appQuit
```
public void appQuit()
```
    Handles shutdown of ImageJ 1.x.
  - appAbout
```
public void appAbout()
```
    Displays the About ImageJ 1.x dialog.
  - setDefaultDirectory
```
public void setDefaultDirectory(File directory)
```
    Sets OpenDialog's default directory
  - openDialog
```
public File openDialog(String title)
```
    Uses ImageJ 1.x' OpenDialog
  - openDialog
```
public File openDialog(String title,
                       File file)
```
    Uses ImageJ 1.x' OpenDialog
  - saveDialog
```
public File saveDialog(String title,
                       File file,
                       String extension)
```
    Uses ImageJ 1.x' SaveDialog
  - getDirectory
```
public String getDirectory(String title,
                           File file)
```
    Chooses a directory using ImageJ 1.x' directory chooser.
  - appPrefs
```
public void appPrefs()
```
    Handles display of the ImageJ 1.x preferences.

Class IJ1Helper

Constructor Summary

Method Summary

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.Contextual

Constructor Detail

IJ1Helper

Method Detail

initialize

dispose

isDisposing

addAliases

isVisible

isRMIEnabled

setCheckNameDuplicates

setVisible

syncActiveImage

setKeyDown

setKeyUp

hasInstance

getVersion

isMacintosh

setStatus

setProgress

getToolBar

getStatusBar

getSearchBar

getIJ

setLocation

getX

getY

isWindowClosed

quitting

getIDList

getImage

getTitle

getClassLoader

showMessage

showMessageWithCancel

commandsName

updateRecentMenu

openAndAddToRecent

recordOption

startRecording

finishRecording

isMacro

getMacroParameter

getMacroParameter

getMacroParameter

getMacroParameter

getInterpreter

getAdditionalMacroFunctions

getVariables

getVariable

isImagePlus

isImagePlus

getImageID

getLegacyContext

subscribeEvents

getCommands

addCommand

getShortcuts

getMenuBar

addMenuItems

run

runMacro

runMacroFile

openImage

openImage

openPathDirectly

setDebugMode

handleException

shiftKeyDown

getOptions

setOptions

appQuit

appAbout

setDefaultDirectory

openDialog