TextOverlayAnimator (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.viewer.animate.AbstractAnimator
- - bdv.viewer.animate.TextOverlayAnimator

All Implemented Interfaces:

OverlayAnimator
```
public class TextOverlayAnimator
extends AbstractAnimator
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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TextOverlayAnimator.TextPosition

Nested Classes
Modifier and Type	Class and Description
`static class`	`TextOverlayAnimator.TextPosition`

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`fadeInTime`
`protected double`	`fadeOutTime`
`protected Font`	`font`
`protected TextOverlayAnimator.TextPosition`	`position`
`protected String`	`text`

Constructor Summary

Constructors
Constructor and Description
`TextOverlayAnimator(String text, long duration)`
`TextOverlayAnimator(String text, long duration, TextOverlayAnimator.TextPosition position)`
`TextOverlayAnimator(String text, long duration, TextOverlayAnimator.TextPosition position, double fadeInTime, double fadeOutTime)`
`TextOverlayAnimator(String text, long duration, TextOverlayAnimator.TextPosition position, double fadeInTime, double fadeOutTime, Font font)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 bdv.viewer.animate.AbstractAnimator
isComplete, ratioComplete, setTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface bdv.viewer.animate.OverlayAnimator
isComplete

Field Detail

font
```
protected final Font font
```

text
```
protected final String text
```

fadeInTime
```
protected final double fadeInTime
```

fadeOutTime
```
protected final double fadeOutTime
```

position

protected final TextOverlayAnimator.TextPosition position

Constructor Detail

TextOverlayAnimator

public TextOverlayAnimator(String text,
                           long duration)

TextOverlayAnimator

public TextOverlayAnimator(String text,
                           long duration,
                           TextOverlayAnimator.TextPosition position)

TextOverlayAnimator

public TextOverlayAnimator(String text,
                           long duration,
                           TextOverlayAnimator.TextPosition position,
                           double fadeInTime,
                           double fadeOutTime)

TextOverlayAnimator

public TextOverlayAnimator(String text,
                           long duration,
                           TextOverlayAnimator.TextPosition position,
                           double fadeInTime,
                           double fadeOutTime,
                           Font font)

Method Detail
- paint
```
public void paint(Graphics2D g,
                  long time)
```
  Specified by:
  
  paint in interface OverlayAnimator
- 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.

Class TextOverlayAnimator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class bdv.viewer.animate.AbstractAnimator

Methods inherited from class java.lang.Object

Methods inherited from interface bdv.viewer.animate.OverlayAnimator

Field Detail

font

text

fadeInTime

fadeOutTime

position

Constructor Detail

TextOverlayAnimator

TextOverlayAnimator

TextOverlayAnimator

TextOverlayAnimator

Method Detail

paint

requiresRepaint