org.micromanager.display

Interface DisplayGearMenuPlugin

All Superinterfaces:

MMGenericPlugin, MMPlugin, org.scijava.plugin.SciJavaPlugin

public interface DisplayGearMenuPlugin
extends MMPlugin

DisplayGearMenuPlugins add items to be shown in the "gear menu" shown in each DisplayWindow.

Method Summary

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

Methods inherited from interface org.micromanager.MMPlugin

getCopyright, getHelpText, getName, getVersion, setContext

Method Detail

getSubMenu

java.lang.String getSubMenu()

Indicate which sub-menu of the gear 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 gear menu, instead of into a sub-menu.

Returns:

Sub-menu of the gear menu hosting this entry, or empty string.

onPluginSelected

void onPluginSelected(DisplayWindow display)

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

Parameters:

display - The display whose gear menu was interacted with.