AbstractSwingImageDisplayViewer (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.ui.viewer.AbstractDisplayViewer<DataView>
    - - net.imagej.ui.viewer.image.AbstractImageDisplayViewer
      - net.imagej.ui.swing.viewer.image.AbstractSwingImageDisplayViewer

All Implemented Interfaces:

Comparable<Prioritized>, SwingImageDisplayViewer, ImageDisplayViewer, Contextual, Disposable, Identifiable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, DisplayViewer<DataView>, Versioned

Direct Known Subclasses:

SwingMdiImageDisplayViewer, SwingSdiImageDisplayViewer
```
public abstract class AbstractSwingImageDisplayViewer
extends AbstractImageDisplayViewer
implements SwingImageDisplayViewer
```
A Swing image display viewer, which displays 2D planes in grayscale or composite color. Intended to be subclassed by a concrete implementation that provides a DisplayWindow in which the display should be housed.

Author:

Curtis Rueden, Lee Kamentsky, Grant Harris, Barry DeZonia

Nested Class Summary
- Nested classes/interfaces inherited from class net.imagej.ui.viewer.image.AbstractImageDisplayViewer
  AbstractImageDisplayViewer.ZoomScaleOption

Field Summary

Fields
Modifier and Type Field and Description

protected AWTInputEventDispatcher dispatcher

Fields
Modifier and Type	Field and Description
`protected AWTInputEventDispatcher`	`dispatcher`

Constructor Summary

Constructors
Constructor and Description

AbstractSwingImageDisplayViewer()

Constructors
Constructor and Description
`AbstractSwingImageDisplayViewer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Dataset`	`capture()`
`void`	`dispose()` NB: a reference to the imgCanvas is held, ultimately, by a finalizable parent of a javax.swing.JViewport.
`JHotDrawImageCanvas`	`getCanvas()` Gets the JHotDraw canvas used by the viewer.
`SwingImageDisplayPanel`	`getPanel()`
`protected void`	`onEvent(OptionsEvent e)`
`void`	`view(DisplayWindow w, Display<?> d)`

Methods inherited from class net.imagej.ui.viewer.image.AbstractImageDisplayViewer
canView, getDataset, getDisplay, getZoomScaleOption, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, updateLabel, updateTitle

Methods inherited from class org.scijava.ui.viewer.AbstractDisplayViewer
getWindow, onEvent, setPanel

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 net.imagej.ui.viewer.image.ImageDisplayViewer
getDisplay

Methods inherited from interface org.scijava.ui.viewer.DisplayViewer
canView, getWindow, isCompatible, onDisplayActivatedEvent, onDisplayDeletedEvent, onDisplayUpdatedEvent, setPanel, view

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
  - dispatcher
```
protected AWTInputEventDispatcher dispatcher
```
- Constructor Detail
  - AbstractSwingImageDisplayViewer
```
public AbstractSwingImageDisplayViewer()
```
- Method Detail
  - getCanvas
```
public JHotDrawImageCanvas getCanvas()
```
    Description copied from interface: SwingImageDisplayViewer
    
    Gets the JHotDraw canvas used by the viewer.
    
    Specified by:
    
    getCanvas in interface SwingImageDisplayViewer
  - view
```
public void view(DisplayWindow w,
                 Display<?> d)
```
    Specified by:
    
    view in interface DisplayViewer<DataView>
    
    Overrides:
    
    view in class AbstractImageDisplayViewer
  - getPanel
```
public SwingImageDisplayPanel getPanel()
```
    Specified by:
    
    getPanel in interface SwingImageDisplayViewer
    
    Specified by:
    
    getPanel in interface DisplayViewer<DataView>
    
    Overrides:
    
    getPanel in class AbstractDisplayViewer<DataView>
  - capture
```
public Dataset capture()
```
    Specified by:
    
    capture in interface ImageDisplayViewer
  - dispose
```
public void dispose()
```
    NB: a reference to the imgCanvas is held, ultimately, by a finalizable parent of a javax.swing.JViewport. This means that the entire resource stack is held until finalize executes. This can be troublesome when resources held by the imgCanvas themselves react to finalization or reference queueing (e.g. of PhantomReferences). At the point dispose is called, we know we're trying to release resources associated with this object, so it makes sense to do as much as we can up front. By clearing the imgCanvas, we break the strong reference link from Finalizer to the imgCanvas's resources, allowing them to be garbage collected, etc... and working around the limitation of swing classes overriding finalize.
    
    Specified by:
    
    dispose in interface Disposable
    
    Specified by:
    
    dispose in interface DisplayViewer<DataView>
  - onEvent
```
protected void onEvent(OptionsEvent e)
```

Class AbstractSwingImageDisplayViewer

Nested Class Summary

Nested classes/interfaces inherited from class net.imagej.ui.viewer.image.AbstractImageDisplayViewer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.imagej.ui.viewer.image.AbstractImageDisplayViewer

Methods inherited from class org.scijava.ui.viewer.AbstractDisplayViewer

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 net.imagej.ui.viewer.image.ImageDisplayViewer

Methods inherited from interface org.scijava.ui.viewer.DisplayViewer

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

dispatcher

Constructor Detail

AbstractSwingImageDisplayViewer

Method Detail

getCanvas

view

getPanel

capture

dispose

onEvent