org.micromanager.quickaccess

Class QuickAccessPlugin

java.lang.Object

org.micromanager.quickaccess.QuickAccessPlugin

All Implemented Interfaces:

MMGenericPlugin, MMPlugin, org.scijava.plugin.SciJavaPlugin

Direct Known Subclasses:

SimpleButtonPlugin, ToggleButtonPlugin, WidgetPlugin

public abstract class QuickAccessPlugin
extends java.lang.Object
implements MMPlugin

QuickAccessPlugins are used for controls that can show up in the Quick- Access Window, which shows frequently-used controls.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CELL_HEIGHT The height of a single cell in the Quick-Access Window.
static int	CELL_WIDTH The width of a single cell in the Quick-Access Window.

Constructor Summary

Constructors

Constructor and Description
QuickAccessPlugin()

Method Summary

Modifier and Type	Method and Description
abstract javax.swing.ImageIcon	getIcon() Provide an icon to use to represent this plugin when configuring the Quick-Access Window.
static java.awt.Dimension	getPaddedCellSize() Provides a dimension that mostly fills 1 cell in the Quick-Access Window.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.micromanager.MMPlugin

getCopyright, getHelpText, getName, getVersion, setContext

Field Detail

CELL_WIDTH

public static final int CELL_WIDTH

The width of a single cell in the Quick-Access Window.

See Also:

Constant Field Values

CELL_HEIGHT

public static final int CELL_HEIGHT

The height of a single cell in the Quick-Access Window.

See Also:

Constant Field Values

Constructor Detail

QuickAccessPlugin

public QuickAccessPlugin()

Method Detail

getPaddedCellSize

public static java.awt.Dimension getPaddedCellSize()

Provides a dimension that mostly fills 1 cell in the Quick-Access Window. This dimension should be used by any "simple" controls (like buttons) to preserve visual uniformity.

getIcon

public abstract javax.swing.ImageIcon getIcon()

Provide an icon to use to represent this plugin when configuring the Quick-Access Window. May be null, in which case a rendering of the plugin's controls will be used instead. Note that if you want to use a null icon here, then your plugin *must* create some kind of sensible control even when there is no configuration (for WidgetPlugins), as the icon of the control in the configuration mode is derived from a non-configured control.