Constructor Detail

• LegacyService

  public LegacyService()

Method Detail

• log

  public LogService log()

  Gets the LogService associated with this LegacyService.

  Specified by:

  log in interface Logged

  Specified by:

  log in interface RichPlugin

• status

  public StatusService status()

  Gets the StatusService associated with this LegacyService.

• uiService

  public UIService uiService()

• isActive

  public boolean isActive()

  Gets whether this LegacyService is fully operational, linked to the ImageJ 1.x singleton instance. Inactive LegacyServices are dummies, which are not tied to ImageJ 1.x.

  Returns:

  true iff this LegacyService is the active one, tied to the singleton instance of ImageJ 1.x.

• getIJ1Helper

  public IJ1Helper getIJ1Helper()

  Gets the helper class responsible for direct interfacing with ImageJ1. Ideally, all accesses to ij.* classes should be done through this helper class, to avoid class loader woes.

  Returns:

  The IJ1Helper, or null if this LegacyService is inactive (see isActive()).

• getImageMap

  public LegacyImageMap getImageMap()

  Gets the LegacyImageMap associated with this LegacyService.

• runLegacyCommand

  public void runLegacyCommand(String ij1ClassName,
                               String argument)

  Runs a legacy command programmatically.

  Parameters:

  ij1ClassName - The name of the plugin class you want to run e.g. "ij.plugin.Clipboard"

  argument - The argument string to pass to the plugin e.g. "copy"

• runLegacyCompatibleCommand

  public Object runLegacyCompatibleCommand(String key)

  Runs the legacy compatible command with the given identifier.

  Parameters:

  key - The identifier of the command to execute.

  Returns:

  The Future of the command execution; or if the identifier describes a script and the shift key is down, then the TextEditor of the new Script Editor window which was opened.

  See Also:

  Identifiable

• syncActiveImage

  public void syncActiveImage()

  Ensures that the currently active ImagePlus matches the currently active ImageDisplay. Does not perform any harmonization.

• isInitialized

  public boolean isInitialized()

  Returns true if this LegacyService has been initialized already and false if not.

• isSyncEnabled

  public boolean isSyncEnabled()

  States whether ImageJ1 and ImageJ2 data structures should be kept in sync.

  While synchronization is supposed to be as cheap as possible, in practice there are limitations with it currently which impact performance. So such synchronization is off by default. The main consequence is that it becomes harder to "mix and match" ImageJ1 and ImageJ2 APIs: you cannot open an ImagePlus and then reference it later from an ImageJ2 Command as a Dataset unless synchronization is enabled.

• isLegacyMode

  public boolean isLegacyMode()

  States whether we're running in legacy ImageJ 1.x mode.

  To support work flows which are incompatible with ImageJ2, we want to allow users to run in legacy ImageJ 1.x mode, where the ImageJ2 GUI is hidden and the ImageJ 1.x GUI is shown. During this time, no synchronization should take place.

• toggleLegacyMode

  public void toggleLegacyMode(boolean wantIJ1)

  Switches to/from running legacy ImageJ 1.x mode.

• toggleLegacyMode

  public void toggleLegacyMode(boolean wantIJ1,
                               boolean initializing)

• getApp

  public App getApp()

• handleException

  public void handleException(Throwable e)

• initialize

  public void initialize()

  Specified by:

  initialize in interface Initializable

  Specified by:

  initialize in interface Service

• dispose

  public void dispose()

  Specified by:

  dispose in interface Disposable

• getVersion

  public String getVersion()

  Gets the version of ImageJ 1.x being used.

  Specified by:

  getVersion in interface Versioned

• getInstance

  public static LegacyService getInstance()

  Returns the legacy service associated with the ImageJ 1.x instance in the current class loader. This method is invoked by the javassisted methods of ImageJ 1.x.

  Returns:

  the legacy service

• setIJ1Helper

  public void setIJ1Helper(IJ1Helper ij1Helper)

  This is not part of the public API. DO NOT USE!

  This method makes it possible to override the IJ1Helper behavior, to facilitate unit testing.

• setProcessingEvents

  public boolean setProcessingEvents(boolean processing)

  This is not part of the public API. DO NOT USE!

  This method toggles a ThreadLocal flag as to whether or not legacy UI components are in the process of handling StatusEvents.

  Returns:

  the old processing value

• isProcessingEvents

  public boolean isProcessingEvents()

  This is not part of the public API. DO NOT USE!

  ThreadLocal check to see if components are in the middle of processing events.

  Returns:

  True iff this thread is already processing events through the LegacyService.

• getScriptsAndNonLegacyCommands

  public Map<String,ModuleInfo> getScriptsAndNonLegacyCommands()

  This is not part of the public API. DO NOT USE!

  Adds all legacy compatible commands to the ImageJ1 menus. The nested menu structure of each command is preserved.

• openScriptInTextEditor

  public TextEditor openScriptInTextEditor(ScriptInfo script)

• preinit

  @Deprecated
  public static void preinit()

  Deprecated. use LegacyInjector.preinit() instead
  Makes sure that the ImageJ 1.x classes are patched.

  We absolutely require that the LegacyInjector did its job before we use the ImageJ 1.x classes.

  Just loading the LegacyService class is not enough; it will not necessarily get initialized. So we provide this method just to force class initialization (and thereby the LegacyInjector to patch ImageJ 1.x).