DefaultLegacyHooks (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.patcher.LegacyHooks
- - net.imagej.legacy.DefaultLegacyHooks

```
public class DefaultLegacyHooks
extends LegacyHooks
```
The LegacyHooks encapsulating an active LegacyService for use within the patched ImageJ 1.x.

Author:

Johannes Schindelin

Nested Class Summary
- Nested classes/interfaces inherited from class net.imagej.patcher.LegacyHooks
  LegacyHooks.FatJarNameComparator

Constructor Summary

Constructors
Constructor and Description

DefaultLegacyHooks(LegacyService legacyService)

DefaultLegacyHooks(LegacyService legacyService, IJ1Helper helper)

Constructors
Constructor and Description
`DefaultLegacyHooks(LegacyService legacyService)`
`DefaultLegacyHooks(LegacyService legacyService, IJ1Helper helper)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMenuItem(String menuPath, String command)` Callback for ImageJ 1.x' menu parsing machinery.
`boolean`	`createInEditor(String title, String content)` Creates the given file in the registered legacy editor, if any.
`void`	`debug(String string)` Logs a debug message (to be shown only in debug mode).
`void`	`dispose()` Disposes of the hooks.
`boolean`	`disposing()` Allows interception of ImageJ 1.x's disposal routine while quitting.
`void`	`error(Throwable t)` Shows an exception.
`String`	`getAppName()` Returns the application name for use with ImageJ 1.x.
`String`	`getAppVersion()` Returns the application version to display in the ImageJ 1.x status bar.
`Object`	`getContext()` Returns the current context, if any.
`URL`	`getIconURL()` Returns the icon for use with ImageJ 1.x.
`Iterable<Thread>`	`getThreadAncestors()` Iterates through the current thread's ancestors.
`void`	`installed()` Runs when the hooks are installed into an existing legacy environment.
`boolean`	`interceptCloseAllWindows()` Allows closing additional windows at the end of `WindowManager.closeAllWindows()`.
`Object`	`interceptDragAndDropFile(File f)` Optionally override opening drag-and-dropped files via legacy hooks.
`Object`	`interceptFileOpen(String path)` Optionally override opening resources via legacy hooks.
`void`	`interceptImageWindowClose(Object window)` Hook to ensure `ImageWindow`s are fully cleaned up when they are closed.
`boolean`	`interceptKeyPressed(KeyEvent e)` Intercepts keyboard events sent to ImageJ 1.x.
`Object`	`interceptOpen(String path, int planeIndex, boolean display)` Optionally override opening resources via legacy hooks.
`Object`	`interceptOpenImage(String path, int planeIndex)` Optionally override opening images via legacy hooks.
`Object`	`interceptOpenRecent(String path)` Optionally override opening recent images via legacy hooks.
`Object`	`interceptRunPlugIn(String className, String arg)` Intercepts the call to `IJ.runPlugIn(String, String)`.
`boolean`	`isLegacyMode()` Determines whether the image windows should be displayed or not.
`void`	`log(String message)` Logs a message.
`boolean`	`openInEditor(String path)` Opens the given path in the registered legacy editor, if any.
`void`	`registerImage(Object o)` Registers an image (possibly not seen before).
`void`	`runAfterRefreshMenus()` Extension point to run after Help>Refresh Menus
`void`	`unregisterImage(Object o)` Releases an image.

Methods inherited from class net.imagej.patcher.LegacyHooks
addPluginClasspath, addPluginDirectory, autoGenerateConfigFile, autoGenerateConfigFile, enableIJ1PluginDirs, getClasspathElements, getMenuStructure, handleExtraPluginJars, handleNoSuchMethodError, initialized, newPluginClassLoader, quit, showProgress, showProgress, showStatus

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

- Constructor Detail
  - DefaultLegacyHooks
```
public DefaultLegacyHooks(LegacyService legacyService)
```
  - DefaultLegacyHooks
```
public DefaultLegacyHooks(LegacyService legacyService,
                          IJ1Helper helper)
```
- Method Detail
  - isLegacyMode
```
public boolean isLegacyMode()
```
    Description copied from class: LegacyHooks
    
    Determines whether the image windows should be displayed or not.
    
    Overrides:
    
    isLegacyMode in class LegacyHooks
    
    Returns:
    
    false if ImageJ 1.x should be prevented from opening image windows.
  - getContext
```
public Object getContext()
```
    Description copied from class: LegacyHooks
    
    Returns 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.
    
    Overrides:
    
    getContext in class LegacyHooks
    
    Returns:
    
    the context, or null
  - installed
```
public void installed()
```
    Description copied from class: LegacyHooks
    
    Runs when the hooks are installed into an existing legacy environment.
    
    Overrides:
    
    installed in class LegacyHooks
  - dispose
```
public void dispose()
```
    Description copied from class: LegacyHooks
    
    Disposes of the hooks.
    This method is called when ImageJ 1.x is quitting or when new hooks are installed.
    
    Overrides:
    
    dispose in class LegacyHooks
  - interceptRunPlugIn
```
public Object interceptRunPlugIn(String className,
                                 String arg)
```
    Description copied from class: LegacyHooks
    
    Intercepts the call to IJ.runPlugIn(String, String).
    
    Overrides:
    
    interceptRunPlugIn in class LegacyHooks
    
    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
  - registerImage
```
public void registerImage(Object o)
```
    Description copied from class: LegacyHooks
    
    Registers an image (possibly not seen before).
    
    Overrides:
    
    registerImage in class LegacyHooks
    
    Parameters:
    
    o - the new image
  - unregisterImage
```
public void unregisterImage(Object o)
```
    Description copied from class: LegacyHooks
    
    Releases an image.
    
    Overrides:
    
    unregisterImage in class LegacyHooks
    
    Parameters:
    
    o - the image
  - debug
```
public void debug(String string)
```
    Description copied from class: LegacyHooks
    
    Logs a debug message (to be shown only in debug mode).
    
    Overrides:
    
    debug in class LegacyHooks
    
    Parameters:
    
    string - the debug message
  - error
```
public void error(Throwable t)
```
    Description copied from class: LegacyHooks
    
    Shows an exception.
    
    Overrides:
    
    error in class LegacyHooks
    
    Parameters:
    
    t - the exception
  - log
```
public void log(String message)
```
    Description copied from class: LegacyHooks
    
    Logs a message.
    
    Overrides:
    
    log in class LegacyHooks
    
    Parameters:
    
    message - the message
  - getAppName
```
public String getAppName()
```
    Returns the application name for use with ImageJ 1.x.
    
    Overrides:
    
    getAppName in class LegacyHooks
    
    Returns:
    
    the application name
  - getAppVersion
```
public String getAppVersion()
```
    Returns the application version to display in the ImageJ 1.x status bar.
    
    Overrides:
    
    getAppVersion in class LegacyHooks
    
    Returns:
    
    the application version
  - getIconURL
```
public URL getIconURL()
```
    Returns the icon for use with ImageJ 1.x.
    
    Overrides:
    
    getIconURL in class LegacyHooks
    
    Returns:
    
    the application name
  - runAfterRefreshMenus
```
public void runAfterRefreshMenus()
```
    Description copied from class: LegacyHooks
    
    Extension point to run after Help>Refresh Menus
    
    Overrides:
    
    runAfterRefreshMenus in class LegacyHooks
  - openInEditor
```
public boolean openInEditor(String path)
```
    Opens the given path in the registered legacy editor, if any.
    
    Overrides:
    
    openInEditor in class LegacyHooks
    
    Parameters:
    
    path - the path of the file to open
    
    Returns:
    
    whether the file was opened successfully
  - createInEditor
```
public boolean createInEditor(String title,
                              String content)
```
    Creates the given file in the registered legacy editor, if any.
    
    Overrides:
    
    createInEditor in class LegacyHooks
    
    Parameters:
    
    title - the title of the file to create
    
    content - the text of the file to be created
    
    Returns:
    
    whether the fule was opened successfully
  - addMenuItem
```
public void addMenuItem(String menuPath,
                        String command)
```
    Description copied from class: LegacyHooks
    
    Callback for ImageJ 1.x' menu parsing machinery.
    This method is called whenever ImageJ 1.x adds a command to the menu structure.
    
    Overrides:
    
    addMenuItem in class LegacyHooks
    
    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
  - interceptOpen
```
public Object interceptOpen(String path,
                            int planeIndex,
                            boolean display)
```
    Description copied from class: LegacyHooks
    
    Optionally override opening resources via legacy hooks.
    This is intended as a "HandleExtraFileTypesPlus".
    
    Overrides:
    
    interceptOpen in class LegacyHooks
    
    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.
  - interceptFileOpen
```
public Object interceptFileOpen(String path)
```
    Description copied from class: LegacyHooks
    
    Optionally override opening resources via legacy hooks.
    This is intended as a "HandleExtraFileTypesPlus".
    
    Overrides:
    
    interceptFileOpen in class LegacyHooks
    
    Parameters:
    
    path - the path to the resource to open, or null if a dialog needs to be shown
    
    Returns:
    
    The opened object, or null to let ImageJ 1.x open the resource.
  - interceptOpenImage
```
public Object interceptOpenImage(String path,
                                 int planeIndex)
```
    Description copied from class: LegacyHooks
    
    Optionally override opening images via legacy hooks.
    This is intended as a "HandleExtraFileTypesPlus".
    
    Overrides:
    
    interceptOpenImage in class LegacyHooks
    
    Parameters:
    
    path - the path to the image 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
    
    Returns:
    
    The opened image, or null to let ImageJ 1.x open the image.
  - interceptOpenRecent
```
public Object interceptOpenRecent(String path)
```
    Description copied from class: LegacyHooks
    
    Optionally override opening recent images via legacy hooks.
    
    Overrides:
    
    interceptOpenRecent in class LegacyHooks
    
    Parameters:
    
    path - the path to the recent image to open
    
    Returns:
    
    The opened object, or null to let ImageJ 1.x open the image.
  - interceptDragAndDropFile
```
public Object interceptDragAndDropFile(File f)
```
    Description copied from class: LegacyHooks
    
    Optionally override opening drag-and-dropped files via legacy hooks.
    
    Overrides:
    
    interceptDragAndDropFile in class LegacyHooks
    
    Parameters:
    
    f - the file that was dragged onto the IJ UI
    
    Returns:
    
    The opened object, or null to let ImageJ 1.x open the file as normal.
  - interceptKeyPressed
```
public boolean interceptKeyPressed(KeyEvent e)
```
    Description copied from class: LegacyHooks
    
    Intercepts keyboard events sent to ImageJ 1.x.
    
    Overrides:
    
    interceptKeyPressed in class LegacyHooks
    
    Parameters:
    
    e - the keyboard event
    
    Returns:
    
    whether the event was intercepted
  - getThreadAncestors
```
public Iterable<Thread> getThreadAncestors()
```
    Description copied from class: LegacyHooks
    
    Iterates through the current thread's ancestors.
    ImageJ 1.x' macro options are thread-local. Unfortunately, this does not take into account thread relationships e.g. when threads are spawned in parallel.
    
    By overriding this method, legacy hooks can force ImageJ 1.x to look harder for macro options.
    
    Overrides:
    
    getThreadAncestors in class LegacyHooks
    
    Returns:
    
    the ancestor(s) of the current thread, or null
  - interceptCloseAllWindows
```
public boolean interceptCloseAllWindows()
```
    Description copied from class: LegacyHooks
    
    Allows closing additional windows at the end of WindowManager.closeAllWindows().
    When returning false, ImageJ 1.x will be disallowed from quitting.
    
    Overrides:
    
    interceptCloseAllWindows in class LegacyHooks
    
    Returns:
    
    whether it is okay to quit
  - interceptImageWindowClose
```
public void interceptImageWindowClose(Object window)
```
    Description copied from class: LegacyHooks
    
    Hook to ensure ImageWindows are fully cleaned up when they are closed.
    
    Overrides:
    
    interceptImageWindowClose in class LegacyHooks
  - disposing
```
public boolean disposing()
```
    Description copied from class: LegacyHooks
    
    Allows interception of ImageJ 1.x's disposal routine while quitting.
    This method is called after it has been confirmed that quitting should proceed. That is, the user OKed all the windows being closed, etc. This method provides one final chance to cancel the quit operation by returning false; otherwise, it performs any needed disposal and cleanup.
    
    Overrides:
    
    disposing in class LegacyHooks
    
    Returns:
    
    whether ImageJ 1.x should proceed in quitting
    
    See Also:
    
    which is where ImageJ 1.x actually quits

Class DefaultLegacyHooks

Nested Class Summary

Nested classes/interfaces inherited from class net.imagej.patcher.LegacyHooks

Constructor Summary

Method Summary

Methods inherited from class net.imagej.patcher.LegacyHooks

Methods inherited from class java.lang.Object

Constructor Detail

DefaultLegacyHooks

DefaultLegacyHooks

Method Detail

isLegacyMode

getContext

installed

dispose

interceptRunPlugIn

registerImage

unregisterImage

debug

error

log

getAppName

getAppVersion

getIconURL

runAfterRefreshMenus

openInEditor

createInEditor

addMenuItem

interceptOpen

interceptFileOpen

interceptOpenImage

interceptOpenRecent

interceptDragAndDropFile

interceptKeyPressed

getThreadAncestors

interceptCloseAllWindows

interceptImageWindowClose

disposing