bdv.tools.bookmarks

Class BookmarkTextOverlayAnimator

java.lang.Object

bdv.tools.bookmarks.BookmarkTextOverlayAnimator

All Implemented Interfaces:

OverlayAnimator

public class BookmarkTextOverlayAnimator
extends Object
implements OverlayAnimator

Draw one line of text in the center or bottom right of the display. Text is fading in and out.

Author:

Tobias Pietzsch

Constructor Summary

Constructors

Constructor and Description
BookmarkTextOverlayAnimator(AbstractViewerPanel viewer)
BookmarkTextOverlayAnimator(AbstractViewerPanel viewer, Font font)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	fadeIn(String message, long fadeInDuration)
void	fadeOut(String message, long fadeOutDuration)
boolean	isComplete() Returns true if the animation is complete and the animator can be removed.
void	paint(Graphics2D g, long time)
boolean	requiresRepaint() Returns true if the animator requires an immediate repaint to continue the animation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkTextOverlayAnimator

public BookmarkTextOverlayAnimator(AbstractViewerPanel viewer)

BookmarkTextOverlayAnimator

public BookmarkTextOverlayAnimator(AbstractViewerPanel viewer,
                                   Font font)

Method Detail

fadeIn

public final void fadeIn(String message,
                         long fadeInDuration)

fadeOut

public final void fadeOut(String message,
                          long fadeOutDuration)

clear

public final void clear()

paint

public void paint(Graphics2D g,
                  long time)

Specified by:

paint in interface OverlayAnimator

isComplete

public boolean isComplete()

Description copied from interface: OverlayAnimator

Returns true if the animation is complete and the animator can be removed.

Specified by:

isComplete in interface OverlayAnimator

Returns:

whether the animation is complete and the animator can be removed.

requiresRepaint

public boolean requiresRepaint()

Description copied from interface: OverlayAnimator

Returns true if the animator requires an immediate repaint to continue the animation.

Specified by:

requiresRepaint in interface OverlayAnimator

Returns:

whetherhe animator requires an immediate repaint.