ThumbnailHandler (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.data.ThumbnailHandler

All Implemented Interfaces:

Runnable, TransformListener

Direct Known Subclasses:

SamplingThumbHandler
```
public class ThumbnailHandler
extends Object
implements Runnable, TransformListener
```
Provides logic for handling data transform thumbnails.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ThumbnailCache`	`cache` Thumbnail disk cache for faster thumbnail retrieval.
`protected int`	`count` Number of thumbnails that have been generated.
`protected DataTransform`	`data` Data transform on which this thumbnail handler operates.
`protected boolean`	`global` Flag indicating cache string ids are for use in default, global cache.
`protected Thread`	`loader` Background thumbnail generation thread.
`protected boolean`	`on` Flag indicating background thumbnail generation is enabled.
`protected int[]`	`resolution` Resolution of each thumbnail dimension.
`protected FlatField[]`	`thumbs` Thumbnail data computed from data transform.
`protected TaskManager`	`tm` Task manager used for reporting background thumbnail generation progress.

Constructor Summary

Constructors
Constructor and Description

ThumbnailHandler(DataTransform data, String filename)
Creates a thumbnail handler.

Constructors
Constructor and Description
`ThumbnailHandler(DataTransform data, String filename)` Creates a thumbnail handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears thumbnails from memory, restarting background generation if auto-generation is enabled.
`protected FlatField`	`computeThumb(int[] pos)` Computes a thumbnail for the given dimensional position.
`ThumbnailCache`	`getCache()` Gets the associated thumbnail disk cache object.
`FlatField`	`getThumb(int[] pos)` Gets the thumbnail at the given dimensional position.
`protected void`	`loadThumb(int i)` Computes the ith thumbnail.
`FlatField`	`makeThumb(Data d)` Creates an image thumbnail from the given data.
`void`	`run()` Loads all thumbnails in the background.
`void`	`setResolution(int[] res)` Sets resolution of computed thumbnails.
`void`	`setTaskManager(TaskManager tm)` Sets the task manager to use for reporting thumbnail generation progress.
`void`	`setThumb(int[] pos, FlatField thumb)` Sets the thumbnail at the given dimensional position.
`void`	`toggleGeneration(boolean on)` Starts or stops background thumbnail generation.
`void`	`transformChanged(TransformEvent e)` Handles data transform parameter changes.

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

- Field Detail
  - data
```
protected DataTransform data
```
    Data transform on which this thumbnail handler operates.
  - resolution
```
protected int[] resolution
```
    Resolution of each thumbnail dimension.
  - thumbs
```
protected FlatField[] thumbs
```
    Thumbnail data computed from data transform.
  - cache
```
protected ThumbnailCache cache
```
    Thumbnail disk cache for faster thumbnail retrieval.
  - global
```
protected boolean global
```
    Flag indicating cache string ids are for use in default, global cache.
  - tm
```
protected TaskManager tm
```
    Task manager used for reporting background thumbnail generation progress.
  - loader
```
protected Thread loader
```
    Background thumbnail generation thread.
  - count
```
protected int count
```
    Number of thumbnails that have been generated.
  - on
```
protected boolean on
```
    Flag indicating background thumbnail generation is enabled.
- Constructor Detail
  - ThumbnailHandler
```
public ThumbnailHandler(DataTransform data,
                        String filename)
```
    Creates a thumbnail handler.
- Method Detail
  - getThumb
```
public FlatField getThumb(int[] pos)
```
    Gets the thumbnail at the given dimensional position.
  - setThumb
```
public void setThumb(int[] pos,
                     FlatField thumb)
```
    Sets the thumbnail at the given dimensional position.
  - setResolution
```
public void setResolution(int[] res)
```
    Sets resolution of computed thumbnails.
  - makeThumb
```
public FlatField makeThumb(Data d)
```
    Creates an image thumbnail from the given data.
  - toggleGeneration
```
public void toggleGeneration(boolean on)
```
    Starts or stops background thumbnail generation.
  - clear
```
public void clear()
```
    Clears thumbnails from memory, restarting background generation if auto-generation is enabled.
  - setTaskManager
```
public void setTaskManager(TaskManager tm)
```
    Sets the task manager to use for reporting thumbnail generation progress.
  - getCache
```
public ThumbnailCache getCache()
```
    Gets the associated thumbnail disk cache object.
  - loadThumb
```
protected void loadThumb(int i)
```
    Computes the ith thumbnail.
  - computeThumb
```
protected FlatField computeThumb(int[] pos)
```
    Computes a thumbnail for the given dimensional position. Subclasses may override this method to provide custom or more efficient thumbnail creation behavior.
  - run
```
public void run()
```
    Loads all thumbnails in the background.
    
    Specified by:
    
    run in interface Runnable
  - transformChanged
```
public void transformChanged(TransformEvent e)
```
    Handles data transform parameter changes.
    
    Specified by:
    
    transformChanged in interface TransformListener

Class ThumbnailHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

data

resolution

thumbs

cache

global

tm

loader

count

on

Constructor Detail

ThumbnailHandler

Method Detail

getThumb

setThumb

setResolution

makeThumb

toggleGeneration

clear

setTaskManager

getCache

loadThumb

computeThumb

run

transformChanged