Interface MMPlugin

All Superinterfaces:
MMGenericPlugin, org.scijava.plugin.SciJavaPlugin
All Known Subinterfaces:
AutofocusPlugin, DataViewerGearMenuPlugin, DisplayGearMenuPlugin, IntroPlugin, MenuPlugin, ProcessorPlugin, TiledDataOpenerPlugin
All Known Implementing Classes:
QuickAccessPlugin, SimpleButtonPlugin, ToggleButtonPlugin, WidgetPlugin
public interface MMPlugin extends MMGenericPlugin
This interface is the base interface for all Micro-Manager plugins. In practice, you will not use this interface directly, rather using one of the sub-interfaces, to wit: - org.micromanager.MenuPlugin, for plugins that should appear in the Plugins menu. - org.micromanager.AutofocusPlugin, for plugins that are used to perform autofocus actions. - org.micromanager.data.ProcessorPlugin, for processing images as they are collected. - org.micromanager.display.OverlayPlugin, for drawing on top of image windows.

To cause your plugin to be loaded when the program runs, you need to do the following: - Create a class that implements one of the interfaces listed above and the org.scijava.plugin.SciJavaPlugin interface (which is an empty interface). - Annotate that class with the org.scijava.plugin.Plugin annotation, with the type parameter of that annotation being the type of the interface your plugin implements. - Place your plugin's jar file in the mmplugins directory of your ImageJ installation.

The annotated plugin class should look something like this (assuming you want a MenuPlugin; replace with a different type as appropriate):

import org.micromanager.MenuPlugin;
import org.scijava.plugin.Plugin;
import org.scijava.plugin.SciJavaPlugin
@Plugin(type = MenuPlugin.class)
public class MyPlugin implements MenuPlugin, SciJavaPlugin {
   // ...plugin contents go here...
}

Note that all plugins must have a default (no-argument) constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCopyright()
    Provide a copyright string.
    String
    getHelpText()
    Provide a longer string describing the purpose of the plugin.
    String
    getName()
    Provide a short string identifying the plugin.
    String
    getVersion()
    Provide a version string.
    void
    setContext(Studio studio)
    Receive the Studio object needed to make API calls.

  • Method Details

    • setContext

      void setContext(Studio studio)
      Receive the Studio object needed to make API calls.
      Parameters:
      studio - instance of the Micro-Manager Studio object

    • getName

      String getName()
      Provide a short string identifying the plugin.
      Returns:
      String identifying this plugin

    • getHelpText

      String getHelpText()
      Provide a longer string describing the purpose of the plugin.
      Returns:
      String describing this purpose of this plugin

    • getVersion

      String getVersion()
      Provide a version string.
      Returns:
      Version String

    • getCopyright

      String getCopyright()
      Provide a copyright string.
      Returns:
      copyright information