AbstractImageDisplayViewer (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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSwingImageDisplayViewer, LegacyImageDisplayViewer
```
public abstract class AbstractImageDisplayViewer
extends AbstractDisplayViewer<DataView>
implements ImageDisplayViewer
```
The AbstractImageDisplayViewer implements the UI-independent elements of an image display viewer. It subscribes to the events of its controlled display and distills these into abstract lifecycle actions.

Author:

Lee Kamentsky, Curtis Rueden

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractImageDisplayViewer.ZoomScaleOption

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractImageDisplayViewer.ZoomScaleOption`

Constructor Summary

Constructors
Constructor and Description

AbstractImageDisplayViewer()

Constructors
Constructor and Description
`AbstractImageDisplayViewer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canView(Display<?> d)`
`protected Dataset`	`getDataset(DataView view)`
`ImageDisplay`	`getDisplay()`
`protected AbstractImageDisplayViewer.ZoomScaleOption`	`getZoomScaleOption()` Implement this in the derived class to get the user's preference for displaying zoom scale (as a fraction or percent)
`protected void`	`onEvent(DatasetRestructuredEvent event)`
`protected void`	`onEvent(DatasetUpdatedEvent event)`
`protected void`	`onEvent(DelayedPositionEvent event)`
`protected void`	`onEvent(DisplayUpdatedEvent event)`
`protected void`	`onEvent(PanZoomEvent event)`
`protected void`	`onEvent(WinActivatedEvent event)`
`protected void`	`updateLabel()` Recalculate the label text and update it on the panel.
`protected void`	`updateTitle()`
`void`	`view(DisplayWindow w, Display<?> d)`

Methods inherited from class org.scijava.ui.viewer.AbstractDisplayViewer
getPanel, 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
capture

Methods inherited from interface org.scijava.ui.viewer.DisplayViewer
dispose, getPanel, 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

- Constructor Detail
  - AbstractImageDisplayViewer
```
public AbstractImageDisplayViewer()
```
- Method Detail
  - getDisplay
```
public ImageDisplay getDisplay()
```
    Specified by:
    
    getDisplay in interface ImageDisplayViewer
    
    Specified by:
    
    getDisplay in interface DisplayViewer<DataView>
    
    Overrides:
    
    getDisplay in class AbstractDisplayViewer<DataView>
  - canView
```
public boolean canView(Display<?> d)
```
    Specified by:
    
    canView in interface DisplayViewer<DataView>
  - view
```
public void view(DisplayWindow w,
                 Display<?> d)
```
    Specified by:
    
    view in interface DisplayViewer<DataView>
    
    Overrides:
    
    view in class AbstractDisplayViewer<DataView>
  - getDataset
```
protected Dataset getDataset(DataView view)
```
  - updateLabel
```
protected void updateLabel()
```
    Recalculate the label text and update it on the panel.
  - getZoomScaleOption
```
protected AbstractImageDisplayViewer.ZoomScaleOption getZoomScaleOption()
```
    Implement this in the derived class to get the user's preference for displaying zoom scale (as a fraction or percent)
    
    Returns:
    
    AbstractImageDisplayViewer.ZoomScaleOption.OPTIONS_PERCENT_SCALE or AbstractImageDisplayViewer.ZoomScaleOption.OPTIONS_FRACTIONAL_SCALE
  - updateTitle
```
protected void updateTitle()
```
    Overrides:
    
    updateTitle in class AbstractDisplayViewer<DataView>
  - onEvent
```
protected void onEvent(WinActivatedEvent event)
```
  - onEvent
```
protected void onEvent(PanZoomEvent event)
```
  - onEvent
```
protected void onEvent(DatasetRestructuredEvent event)
```
  - onEvent
```
protected void onEvent(DelayedPositionEvent event)
```
  - onEvent
```
protected void onEvent(DatasetUpdatedEvent event)
```
  - onEvent
```
protected void onEvent(DisplayUpdatedEvent event)
```
    Overrides:
    
    onEvent in class AbstractDisplayViewer<DataView>

Class AbstractImageDisplayViewer

Nested Class Summary

Constructor Summary

Method Summary

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

Constructor Detail

AbstractImageDisplayViewer

Method Detail

getDisplay

canView

view

getDataset

updateLabel

getZoomScaleOption

updateTitle

onEvent

onEvent

onEvent

onEvent

onEvent

onEvent