DefaultJHotDrawAdapter (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - net.imagej.ui.swing.overlay.AbstractJHotDrawAdapter<Overlay,ImageFigure>
    - - net.imagej.ui.swing.overlay.DefaultJHotDrawAdapter

All Implemented Interfaces:

Comparable<Prioritized>, ImageJPlugin, JHotDrawAdapter<ImageFigure>, Contextual, Identifiable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Versioned
```
public class DefaultJHotDrawAdapter
extends AbstractJHotDrawAdapter<Overlay,ImageFigure>
```
The default adapter handles any kind of overlay. It uses the fill color and alpha of the overlay to draw the mask and leaves the rest of the figure transparent.

Author:

Lee Kamentsky

Field Summary

Fields
Modifier and Type Field and Description

static double PRIORITY
- Fields inherited from class net.imagej.ui.swing.overlay.AbstractJHotDrawAdapter
  DASH_LINE_STYLE, DOT_DASH_LINE_STYLE, DOT_LINE_STYLE, SOLID_LINE_STYLE

Fields
Modifier and Type	Field and Description
`static double`	`PRIORITY`

Constructor Summary

Constructors
Constructor and Description

DefaultJHotDrawAdapter()

Constructors
Constructor and Description
`DefaultJHotDrawAdapter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Figure`	`createDefaultFigure()` Creates a default figure of the type handled by this adapter.
`Overlay`	`createNewOverlay()` Creates a new overlay.
`JHotDrawTool`	`getCreationTool(ImageDisplay display)`
`boolean`	`supports(Overlay overlay, Figure figure)` Determines whether the adapter can handle a particular overlay, or overlay / figure combination.
`boolean`	`supports(Tool tool)` Determines whether the adapter is designed to work with the given tool.
`Shape`	`toShape(ImageFigure figure)` Converts a figure into an AWT Shape.
`void`	`updateFigure(OverlayView overlay, ImageFigure figure)` Update the appearance of the figure to match the overlay

Methods inherited from class net.imagej.ui.swing.overlay.AbstractJHotDrawAdapter
initDefaultSettings, mouseDown, mouseDrag, report, updateOverlay

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

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

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

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

- Field Detail
  - PRIORITY
```
public static final double PRIORITY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultJHotDrawAdapter
```
public DefaultJHotDrawAdapter()
```
- Method Detail
  - supports
```
public boolean supports(Tool tool)
```
    Description copied from interface: JHotDrawAdapter
    
    Determines whether the adapter is designed to work with the given tool.
    
    Parameters:
    
    tool - The tool in question.
    
    Returns:
    
    True iff the adapter is compatible with the given tool.
  - supports
```
public boolean supports(Overlay overlay,
                        Figure figure)
```
    Description copied from interface: JHotDrawAdapter
    
    Determines whether the adapter can handle a particular overlay, or overlay / figure combination.
    
    Parameters:
    
    overlay - - an overlay that might be editable
    
    figure - - a figure that will be either updated by the overlay or will update the overlay. The figure can be null: this indicates that the adapter is capable of creating the figure associated with the overlay/
  - createNewOverlay
```
public Overlay createNewOverlay()
```
    Description copied from interface: JHotDrawAdapter
    
    Creates a new overlay.
    
    Returns:
    
    an Overlay of the associated type in the default initial state
  - createDefaultFigure
```
public Figure createDefaultFigure()
```
    Description copied from interface: JHotDrawAdapter
    
    Creates a default figure of the type handled by this adapter.
  - updateFigure
```
public void updateFigure(OverlayView overlay,
                         ImageFigure figure)
```
    Description copied from interface: JHotDrawAdapter
    
    Update the appearance of the figure to match the overlay
    
    Specified by:
    
    updateFigure in interface JHotDrawAdapter<ImageFigure>
    
    Overrides:
    
    updateFigure in class AbstractJHotDrawAdapter<Overlay,ImageFigure>
    
    Parameters:
    
    overlay - view of the overlay to be represented by the figure
    
    figure - the figure that is to be made to look like the overlay
  - getCreationTool
```
public JHotDrawTool getCreationTool(ImageDisplay display)
```
  - toShape
```
public Shape toShape(ImageFigure figure)
```
    Description copied from class: AbstractJHotDrawAdapter
    
    Converts a figure into an AWT Shape.
    
    Specified by:
    
    toShape in class AbstractJHotDrawAdapter<Overlay,ImageFigure>

Class DefaultJHotDrawAdapter

Field Summary

Fields inherited from class net.imagej.ui.swing.overlay.AbstractJHotDrawAdapter

Constructor Summary

Method Summary

Methods inherited from class net.imagej.ui.swing.overlay.AbstractJHotDrawAdapter

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.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

Field Detail

PRIORITY

Constructor Detail

DefaultJHotDrawAdapter

Method Detail

supports

supports

createNewOverlay

createDefaultFigure

updateFigure

getCreationTool

toShape