org.micromanager.display.overlay

Class AbstractOverlay

java.lang.Object

org.micromanager.display.overlay.AbstractOverlay

All Implemented Interfaces:

Overlay

public abstract class AbstractOverlay
extends java.lang.Object
implements Overlay

Abstract implementation of Overlay.

Custom overlays should extend this class.

Constructor Summary

Constructors

Constructor and Description
AbstractOverlay()

Method Summary

Modifier and Type	Method and Description
void	addOverlayListener(OverlayListener listener) Add a listener.
protected void	fireOverlayConfigurationChanged() Call this method to notify the system that the overlay has changed.
protected void	fireOverlayTitleChanged() Call this method to notify the system that the overlay title has changed.
PropertyMap	getConfiguration() Return the user-customizable settings for this overlay.
javax.swing.JComponent	getConfigurationComponent() Return the configuration UI component for this overlay.
boolean	isVisible() Return whether this overlay is shown.
void	paintOverlay(java.awt.Graphics2D graphicsContext, java.awt.Rectangle screenRect, DisplaySettings displaySettings, java.util.List<Image> images, Image primaryImage, java.awt.geom.Rectangle2D.Float imageViewPort) Paint the overlay to the given graphics context.
void	removeOverlayListener(OverlayListener listener) Remove a listener.
void	setConfiguration(PropertyMap config) Configure the overlay with the given parameters.
void	setVisible(boolean visible) Show or hide this overlay.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.micromanager.display.overlay.Overlay

getTitle

Constructor Detail

AbstractOverlay

public AbstractOverlay()

Method Detail

paintOverlay

public void paintOverlay(java.awt.Graphics2D graphicsContext,
                         java.awt.Rectangle screenRect,
                         DisplaySettings displaySettings,
                         java.util.List<Image> images,
                         Image primaryImage,
                         java.awt.geom.Rectangle2D.Float imageViewPort)

Paint the overlay to the given graphics context.

This default implementation draws nothing. Override to draw the overlay graphics.

Specified by:

paintOverlay in interface Overlay

Parameters:

graphicsContext - the graphics context to paint with

screenRect - the screen region displaying part or all of the image, in the graphics context's coordinates

displaySettings - the current display settings of the display window

images - the images on which the overlay is to be drawn (multiple images if in composite color mode)

primaryImage - the currently selected image (if in composite color mode) or the single displayed image (otherwise)

imageViewPort - the visible region of the image, in image coordinates

getConfigurationComponent

public javax.swing.JComponent getConfigurationComponent()

Return the configuration UI component for this overlay.

The component should work well when laid out with a fixed width and height, determined based on its minimum and maximum sizes. The width of the component may be changed in response to layout changes, but the component must not actively resize itself. It is recommended that the preferred width be no more than 480 pixels.

This method should return the same object every time it is called, throughout the lifetime of this Overlay instance. If the overlay does not require any user configuration, null may be returned.

Important: The Overlay must not create any UI objects unless this method is called, and still support all other methods. This is to support headless use of overlays.

This default implementation returns null. Override to provide a user interface.

Specified by:

getConfigurationComponent in interface Overlay

Returns:

the configuration UI component, or null

getConfiguration

public PropertyMap getConfiguration()

Return the user-customizable settings for this overlay.

The configuration should contain all parameters needed to reproduce the same overlay on another display window.

This default implementation returns an empty property map. Override to implement custom settings.

Specified by:

getConfiguration in interface Overlay

Returns:

a property map containing current parameters of the overlay

setConfiguration

public void setConfiguration(PropertyMap config)

Configure the overlay with the given parameters.

This default implementation does nothing. Override to implement custom settings.

Specified by:

setConfiguration in interface Overlay

Parameters:

config - a property map previously returned by getConfiguration of an overlay of the same class.

isVisible

public final boolean isVisible()

Return whether this overlay is shown.

Note: AbstractOverlay implements this method.

This implementation takes care of visibility management.

Specified by:

isVisible in interface Overlay

Returns:

true if overlay is visible

setVisible

public final void setVisible(boolean visible)

Show or hide this overlay.

Note: AbstractOverlay implements this method.

This implementation takes care of visibility management.

Specified by:

setVisible in interface Overlay

Parameters:

visible - whether to show the overlay

addOverlayListener

public final void addOverlayListener(OverlayListener listener)

Add a listener.

Note: AbstractOverlay implements this method.

This implementation takes care of managing listeners.

Specified by:

addOverlayListener in interface Overlay

Parameters:

listener - the listener to add

See Also:

fireOverlayConfigurationChanged()

removeOverlayListener

public final void removeOverlayListener(OverlayListener listener)

Remove a listener.

Note: AbstractOverlay implements this method.

This implementation takes care of managing listeners.

Specified by:

removeOverlayListener in interface Overlay

Parameters:

listener - the listener to remove

See Also:

fireOverlayConfigurationChanged()

fireOverlayTitleChanged

protected final void fireOverlayTitleChanged()

Call this method to notify the system that the overlay title has changed.

If the overlay has a fixed title, this method need not ever be called.

See Also:

OverlayListener.overlayTitleChanged(org.micromanager.display.overlay.Overlay)

fireOverlayConfigurationChanged

protected final void fireOverlayConfigurationChanged()

Call this method to notify the system that the overlay has changed.

This only needs to be called when the overlay needs a repaint due to its configuration changing. The case when the displayed image has changed is automatically handled by the system.

See Also:

OverlayListener.overlayConfigurationChanged(org.micromanager.display.overlay.Overlay)