Interface MenuPlugin

All Superinterfaces:

MMGenericPlugin, MMPlugin, org.scijava.plugin.SciJavaPlugin

public interface MenuPlugin
extends MMPlugin

A MenuPlugin is a plugin that should appear under the "Plugins" menu. Note that certain types of plugins automatically appear in certain contexts, and do not need to implement this interface: - ProcessorPlugins are managed via the "On-The-Fly Image Processing" menu item in the Plugins menu, which opens the Image Processing Pipeline window. - All OverlayPlugins appear in the Inspector frame's "Overlays" section. Currently, adding plugins to menus other than the Plugins menu is not supported.

Method Summary

Modifier and Type	Method	Description
String	getSubMenu()	Indicate which sub-menu of the Plugins menu this plugin should appear in.
void	onPluginSelected()	This method will be called when the plugin is selected from the PluginsMenu.

Methods inherited from interface MMPlugin

getCopyright, getHelpText, getName, getVersion, setContext

Method Details

getSubMenu

String getSubMenu()

Indicate which sub-menu of the Plugins menu this plugin should appear in. If that sub-menu does not exist, it will be created. If an empty string is returned, then the plugin will be inserted directly into the Plugins menu, instead of into a sub-menu.

Returns:

Sub-menu of the Plugins menu hosting this entry

onPluginSelected

void onPluginSelected()

This method will be called when the plugin is selected from the PluginsMenu.