OverlayFigureView (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - net.imagej.ui.swing.viewer.image.OverlayFigureView

All Implemented Interfaces:

FigureView, Contextual
```
public class OverlayFigureView
extends AbstractContextual
implements FigureView
```
A figure view that links an ImageJ OverlayView to a JHotDraw Figure.

Author:

Curtis Rueden, Lee Kamentsky

Constructor Summary

Constructors
Constructor and Description
`OverlayFigureView(SwingImageDisplayViewer displayViewer, OverlayView overlayView)` Constructor to use to discover the figure to use for an overlay
`OverlayFigureView(SwingImageDisplayViewer displayViewer, OverlayView overlayView, Figure figure)` Constructor to use if the figure already exists, for instance if it was created using the CreationTool

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Removes the figure from the scene.
`DataView`	`getDataView()` Gets the linked ImageJ data view.
`Figure`	`getFigure()` Gets the linked JHotDraw figure.
`void`	`update()` Updates the figure to match the linked data view.

Methods inherited from class org.scijava.AbstractContextual
context, getContext

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

Methods inherited from interface org.scijava.Contextual
setContext

- Constructor Detail
  - OverlayFigureView
```
public OverlayFigureView(SwingImageDisplayViewer displayViewer,
                         OverlayView overlayView)
```
    Constructor to use to discover the figure to use for an overlay
    
    Parameters:
    
    displayViewer - - hook to this display viewer
    
    overlayView - - represent this overlay
  - OverlayFigureView
```
public OverlayFigureView(SwingImageDisplayViewer displayViewer,
                         OverlayView overlayView,
                         Figure figure)
```
    Constructor to use if the figure already exists, for instance if it was created using the CreationTool
    
    Parameters:
    
    displayViewer - - hook to this display viewer
    
    overlayView - - represent this overlay
    
    figure - - draw using this figure
- Method Detail
  - update
```
public void update()
```
    Description copied from interface: FigureView
    
    Updates the figure to match the linked data view.
    
    Specified by:
    
    update in interface FigureView
  - getFigure
```
public Figure getFigure()
```
    Description copied from interface: FigureView
    
    Gets the linked JHotDraw figure.
    
    Specified by:
    
    getFigure in interface FigureView
  - dispose
```
public void dispose()
```
    Description copied from interface: FigureView
    
    Removes the figure from the scene.
    
    Specified by:
    
    dispose in interface FigureView
  - getDataView
```
public DataView getDataView()
```
    Description copied from interface: FigureView
    
    Gets the linked ImageJ data view.
    
    Specified by:
    
    getDataView in interface FigureView

Class OverlayFigureView

Constructor Summary

Method Summary

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.Contextual

Constructor Detail

OverlayFigureView

OverlayFigureView

Method Detail

update

getFigure

dispose

getDataView