JHotDrawService (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.service.AbstractService
    - - net.imagej.ui.swing.overlay.JHotDrawService

All Implemented Interfaces:

Comparable<Prioritized>, ImageJService, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Service, Versioned
```
public class JHotDrawService
extends AbstractService
implements ImageJService
```
The JHotDraw service manages the bidirectional linkage between ImageJ Overlays and JHotDraw Figures.

Author:

Lee Kamentsky, Curtis Rueden

Constructor Summary

Constructors
Constructor and Description

JHotDrawService()

Constructors
Constructor and Description
`JHotDrawService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JHotDrawAdapter<?>`	`getAdapter(Overlay overlay)` Gets the first available adapter for the given overlay.
`JHotDrawAdapter<?>`	`getAdapter(Overlay overlay, Figure figure)` Gets the first available adapter for the given overlay.
`JHotDrawAdapter<?>`	`getAdapter(Tool tool)` Gets the adapter associated with the given tool.
`ArrayList<JHotDrawAdapter<?>>`	`getAdapters(Overlay overlay)` Gets all adapters capable of handling a given overlay.
`ArrayList<JHotDrawAdapter<?>>`	`getAdapters(Overlay overlay, Figure figure)` Gets all adapters capable of handling a given overlay/figure combination.
`Collection<JHotDrawAdapter<?>>`	`getAllAdapters()` Gets all of the discovered adapters.
`<F extends Figure> void`	`linkOverlay(F figure, JHotDrawAdapter<F> adapter, ImageDisplay display)` Links a new `Overlay` and `OverlayView`, created by the given `JHotDrawAdapter`, to the specified JHotDraw `Figure` of a particular `ImageDisplay`.

Methods inherited from class org.scijava.service.AbstractService
getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context

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

Methods inherited from interface org.scijava.service.Service
initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

Methods inherited from interface org.scijava.Disposable
dispose

- Constructor Detail
  - JHotDrawService
```
public JHotDrawService()
```
- Method Detail
  - getAdapter
```
public JHotDrawAdapter<?> getAdapter(Tool tool)
```
    Gets the adapter associated with the given tool.
    
    Parameters:
    
    tool - The tool for which a compatible adapter is needed.
    
    Returns:
    
    the highest-priority adapter that supports the tool
  - getAdapter
```
public JHotDrawAdapter<?> getAdapter(Overlay overlay)
```
    Gets the first available adapter for the given overlay.
    
    Parameters:
    
    overlay - the overlay to adapt
    
    Returns:
    
    the highest-priority adapter that supports the overlay
  - getAdapter
```
public JHotDrawAdapter<?> getAdapter(Overlay overlay,
                                     Figure figure)
```
    Gets the first available adapter for the given overlay.
    
    Parameters:
    
    overlay - the overlay to adapt
    
    figure - the figure to be associated with the overlay
    
    Returns:
    
    the highest-priority adapter that supports the overlay adapted to the figure
  - getAdapters
```
public ArrayList<JHotDrawAdapter<?>> getAdapters(Overlay overlay)
```
    Gets all adapters capable of handling a given overlay.
    
    Parameters:
    
    overlay - the overlay to adapt
    
    Returns:
    
    a collection of all adapters capable of handling the overlay
  - getAdapters
```
public ArrayList<JHotDrawAdapter<?>> getAdapters(Overlay overlay,
                                                 Figure figure)
```
    Gets all adapters capable of handling a given overlay/figure combination.
    
    Parameters:
    
    overlay - the overlay to adapt
    
    figure - the figure to be associated with the overlay
    
    Returns:
    
    collection of valid adapters
  - getAllAdapters
```
public Collection<JHotDrawAdapter<?>> getAllAdapters()
```
    Gets all of the discovered adapters.
  - linkOverlay
```
public <F extends Figure> void linkOverlay(F figure,
                                           JHotDrawAdapter<F> adapter,
                                           ImageDisplay display)
```
    Links a new Overlay and OverlayView, created by the given JHotDrawAdapter, to the specified JHotDraw Figure of a particular ImageDisplay.

Class JHotDrawService

Constructor Summary

Method Summary

Methods inherited from class org.scijava.service.AbstractService

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Disposable

Constructor Detail

JHotDrawService

Method Detail

getAdapter

getAdapter

getAdapter

getAdapters

getAdapters

getAllAdapters

linkOverlay