MessageOverlayAnimator (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.viewer.animate.MessageOverlayAnimator

All Implemented Interfaces:

OverlayAnimator
```
public class MessageOverlayAnimator
extends Object
implements OverlayAnimator
```
Draw lines of text in the lower right corner of the display. Messages are fading in a specified time. If several messages are drawn at the same time, old messages scroll up.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class MessageOverlayAnimator.TextAnimator

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`MessageOverlayAnimator.TextAnimator`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`duration`
`protected double`	`fadeInTime`
`protected double`	`fadeOutTime`
`protected Font`	`font`
`protected List<MessageOverlayAnimator.TextAnimator>`	`texts`

Constructor Summary

Constructors
Constructor and Description
`MessageOverlayAnimator(long duration)`
`MessageOverlayAnimator(long duration, double fadeInTime, double fadeOutTime)`
`MessageOverlayAnimator(long duration, double fadeInTime, double fadeOutTime, Font font)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(String text)`
`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

Field Detail

font
```
protected final Font font
```

duration
```
protected final long duration
```

fadeInTime
```
protected final double fadeInTime
```

fadeOutTime
```
protected final double fadeOutTime
```

texts

protected final List<MessageOverlayAnimator.TextAnimator> texts

Constructor Detail

MessageOverlayAnimator

public MessageOverlayAnimator(long duration)

MessageOverlayAnimator

public MessageOverlayAnimator(long duration,
                              double fadeInTime,
                              double fadeOutTime)

MessageOverlayAnimator

public MessageOverlayAnimator(long duration,
                              double fadeInTime,
                              double fadeOutTime,
                              Font font)

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

Class MessageOverlayAnimator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

font

duration

fadeInTime

fadeOutTime

texts

Constructor Detail

MessageOverlayAnimator

MessageOverlayAnimator

MessageOverlayAnimator

Method Detail

add

isComplete

requiresRepaint

paint