Constructor Detail

• LegacyHooks

  public LegacyHooks()

  Deprecated. 

Method Detail

• isLegacyMode

  public boolean isLegacyMode()

  Deprecated. 
  Determines whether the image windows should be displayed or not.

  Returns:

  false if ImageJ 1.x should be prevented from opening image windows.

• getContext

  public Object getContext()

  Deprecated. 
  Return the current context, if any.

  For ImageJ2-specific hooks, the returned object will be the current SciJava context, or null if the context is not yet initialized.

  Returns:

  the context, or null

• quit

  public boolean quit()

  Deprecated. 
  Disposes and prepares for quitting.

  Returns:

  whether ImageJ 1.x should be allowed to call System.exit()

• installed

  public void installed()

  Deprecated. 
  Runs when the hooks are installed into an existing legacy environment.

• dispose

  public void dispose()

  Deprecated. 
  Disposes of the hooks.

  This method is called when ImageJ 1.x is quitting or when new hooks are installed.

• interceptRunPlugIn

  public Object interceptRunPlugIn(String className,
                                   String arg)

  Deprecated. 
  Intercepts the call to IJ.runPlugIn(String, String).

  Parameters:

  className - the class name

  arg - the argument passed to the runPlugIn method

  Returns:

  the object to return, or null to let ImageJ 1.x handle the call

• showProgress

  public void showProgress(double progress)

  Deprecated. 
  Updates the progress bar, where 0 <= progress <= 1.0.

  Parameters:

  progress - between 0.0 and 1.0

• showProgress

  public void showProgress(int currentIndex,
                           int finalIndex)

  Deprecated. 
  Updates the progress bar, where the length of the bar is set to ( currentValue + 1) / finalValue of the maximum bar length. The bar is erased if currentValue >= finalValue.

  Parameters:

  currentIndex - the step that was just started

  finalIndex - the final step.

• showStatus

  public void showStatus(String status)

  Deprecated. 
  Shows a status message.

  Parameters:

  status - the message

• log

  public void log(String message)

  Deprecated. 
  Logs a message.

  Parameters:

  message - the message

• registerImage

  public void registerImage(Object image)

  Deprecated. 
  Registers an image (possibly not seen before).

  Parameters:

  image - the new image

• unregisterImage

  public void unregisterImage(Object image)

  Deprecated. 
  Releases an image.

  Parameters:

  image - the image

• debug

  public void debug(String string)

  Deprecated. 
  Logs a debug message (to be shown only in debug mode).

  Parameters:

  string - the debug message

• error

  public void error(Throwable t)

  Deprecated. 
  Shows an exception.

  Parameters:

  t - the exception

• getAppName

  public String getAppName()

  Deprecated. 
  Returns the name to use in place of "ImageJ".

  Returns:

  the application name

• getIconURL

  public URL getIconURL()

  Deprecated. 
  Returns the icon to use in place of the ImageJ microscope.

  Returns:

  the URL to the icon to use, or null

• openInEditor

  public boolean openInEditor(String path)

  Deprecated. 
  Extension point to override ImageJ 1.x' editor.

  Parameters:

  path - the path to the file to open

  Returns:

  true if the hook opened a different editor

• createInEditor

  public boolean createInEditor(String fileName,
                                String content)

  Deprecated. 
  Extension point to override ImageJ 1.x' editor.

  Parameters:

  fileName - the name of the new file

  content - the initial content

  Returns:

  true if the hook opened a different editor

• enableIJ1PluginDirs

  protected void enableIJ1PluginDirs(boolean enable)

  Deprecated. 

• addPluginClasspath

  protected void addPluginClasspath(File file)

  Deprecated. 

• handleExtraPluginJars

  public List<File> handleExtraPluginJars()

  Deprecated. 
  Extension point to add to ImageJ 1.x' PluginClassLoader's class path.

  Returns:

  a list of class path elements to add

• runAfterRefreshMenus

  public void runAfterRefreshMenus()

  Deprecated. 
  Extension point to run after Help>Refresh Menus

• handleNoSuchMethodError

  public boolean handleNoSuchMethodError(NoSuchMethodError e)

  Deprecated. 
  Extension point to enhance ImageJ 1.x' error reporting upon NoSuchMethodError.

  Parameters:

  e - the exception to handle

  Returns:

  true if the error was handled by the legacy hook

• newPluginClassLoader

  public void newPluginClassLoader(ClassLoader loader)

  Deprecated. 
  Extension point to run after a new PluginClassLoader was initialized.

  Parameters:

  loader - the PluginClassLoader instance

• addPluginDirectory

  public String[] addPluginDirectory(File directory,
                                     String[] names)

  Deprecated. 
  Extension point to modify the order in which .jar files are added to the PluginClassLoader.

  There is a problem which only strikes large distributions of ImageJ such as Fiji: some .jar files try to be helpful and bundle classes which are actually not theirs, causing problems when newer versions of those .jar files which they shadow are present in the plugins/ or jars/ directory but are not respected by the class loader.

  The default hook of this extension point therefore hard-codes a few file names of known offenders (which we politely will call fat .jar files normally) and just pushes them back to the end of the list.

  Parameters:

  directory - the directory which ImageJ 1.x looked at

  names - the list of file names in the order ImageJ 1.x discovered them

  Returns:

  the ordered, filtered and/or augmented list

• initialized

  public void initialized()

  Deprecated. 
  First extension point to run just after ImageJ 1.x spun up.

• autoGenerateConfigFile

  public InputStream autoGenerateConfigFile(File directory)

  Deprecated. 

• autoGenerateConfigFile

  protected StringBuilder autoGenerateConfigFile(File topLevelDirectory,
                                                 File directory,
                                                 String menuPath,
                                                 String packageName,
                                                 StringBuilder builder)

  Deprecated. 

• addMenuItem

  public void addMenuItem(String menuPath,
                          String command)

  Deprecated. 
  Callback for ImageJ 1.x' menu parsing machinery.

  This method is called whenever ImageJ 1.x adds a command to the menu structure.

  Parameters:

  menuPath - the menu path of the menu item, or null when reinitializing

  command - the command associated with the menu item, or null when reinitializing

• getMenuStructure

  public Map<String,String> getMenuStructure()

  Deprecated. 
  Returns ImageJ 1.x' menu structure as a map.

  Returns:

  the menu structure

• interceptOpen

  public Object interceptOpen(String path,
                              int planeIndex,
                              boolean display)

  Deprecated. 
  Optionally override opening resources via legacy hooks.

  This is intended as a "HandleExtraFileTypesPlus".

  Parameters:

  path - the path to the resource to open, or null if a dialog needs to be shown

  planeIndex - If applicable - the index of plane to open or -1 for all planes

  display - if true, the opened object should be displayed before returning

  Returns:

  The opened object, or null to let ImageJ 1.x open the path.