AbstractAnnotation (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.util.gui.AbstractAnnotation

All Implemented Interfaces:

OverlayedImageCanvas.Overlay
```
public abstract class AbstractAnnotation
extends Object
implements OverlayedImageCanvas.Overlay
```
Abstract class dedicated to draw overlayed annotations on a OverlayedImageCanvas.
This simple class offer facilities to specify the Color, Composite and Stroke that will be used to draw the annotation. There is a simple method to implement: draw(Graphics2D), that receive a Graphics2D that will paint the annotation in image coordinates, so that the annotation "follows" the image when its display canvas is panned or zoomed in/out.

Author:

Jean-Yves Tinevez - Sep 2010

See Also:

OverlayedImageCanvas, OverlayedImageCanvas.Overlay

Field Summary

Fields
Modifier and Type Field and Description

protected Color color

protected Composite composite

protected Stroke stroke

Fields
Modifier and Type	Field and Description
`protected Color`	`color`
`protected Composite`	`composite`
`protected Stroke`	`stroke`

Constructor Summary

Constructors
Constructor and Description

AbstractAnnotation()

Constructors
Constructor and Description
`AbstractAnnotation()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`draw(Graphics2D g2d)` Draw this annotation on the `OverlayedImageCanvas`.
`void`	`paint(Graphics g, int x, int y, double magnification)` Paint this overlay on the given graphic device.
`void`	`setColor(Color color)`
`void`	`setComposite(Composite composite)` Set the composite that will be used to paint this overlay.
`void`	`setStroke(Stroke stroke)`

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

- Field Detail
  - composite
```
protected Composite composite
```
  - color
```
protected Color color
```
  - stroke
```
protected Stroke stroke
```
- Constructor Detail
  - AbstractAnnotation
```
public AbstractAnnotation()
```
- Method Detail
  - paint
```
public void paint(Graphics g,
                  int x,
                  int y,
                  double magnification)
```
    Description copied from interface: OverlayedImageCanvas.Overlay
    
    Paint this overlay on the given graphic device.
    
    Specified by:
    
    paint in interface OverlayedImageCanvas.Overlay
    
    Parameters:
    
    g - the graphic device provided by the OverlayedImageCanvas
    
    x - the top-left corner x-coordinate of the image rectangle currently displayed in the OverlayedImageCanvas
    
    y - the top-left corner y-coordinate
    
    magnification - the OverlayedImageCanvas current magnification
  - setComposite
```
public void setComposite(Composite composite)
```
    Description copied from interface: OverlayedImageCanvas.Overlay
    
    Set the composite that will be used to paint this overlay.
    
    Specified by:
    
    setComposite in interface OverlayedImageCanvas.Overlay
  - setColor
```
public void setColor(Color color)
```
  - setStroke
```
public void setStroke(Stroke stroke)
```
  - draw
```
public abstract void draw(Graphics2D g2d)
```
    Draw this annotation on the OverlayedImageCanvas.
    The Graphics2D received in argument is transformed so that drawing is made in image coordinates (taking into account image magnification and panning), and its color, stroke and composite are set with the fields of this annotation. When this method returns, the graphic device has its original settings restored.
    
    Parameters:
    
    g2d - the transformed graphic device to draw with

Class AbstractAnnotation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

composite

color

stroke

Constructor Detail

AbstractAnnotation

Method Detail

paint

setComposite

setColor

setStroke

draw