TransformHandler (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.view.TransformHandler

All Implemented Interfaces:

Runnable, EventListener, ChangeListener, Saveable

Direct Known Subclasses:

StackHandler
```
public class TransformHandler
extends Object
implements ChangeListener, Runnable, Saveable
```
Provides logic for linking data transforms to a display.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`animating` Flag indicating status of animation.
`protected int`	`animAxis` Dimensional axis to use for animation.
`protected Object`	`animSync` Synchronization object for animation.
`protected Thread`	`animThread` Thread responsible for animation.
`protected long`	`burnDelay` Default burn-in delay in milliseconds.
`protected DataCache`	`cache` Cache of full-resolution data in memory.
`static int`	`DEFAULT_ANIMATION_RATE` Starting FPS for animation.
`static long`	`DEFAULT_BURN_DELAY` Starting burn-in delay in milliseconds.
`protected int`	`fps` Animation rate.
`protected Vector`	`links` Data transform links.
`static long`	`MINIMUM_BURN_DELAY` Minimum amount of time to delay burn-in.
`protected Vector`	`newLinks` List of uninitialized links.
`protected TransformPanel`	`panel` GUI controls for transform handler.
`protected JPanel`	`sliderPanel` Panel containing dimensional slider widgets.
`protected Vector`	`sliders` Dimensional slider widgets for linked transforms.
`protected DisplayWindow`	`window` Associated display window.

Constructor Summary

Constructors
Constructor and Description

TransformHandler(DisplayWindow dw)
Creates a display transform handler.

Constructors
Constructor and Description
`TransformHandler(DisplayWindow dw)` Creates a display transform handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAxis(String axis)` Notifies the transform panel of a new dimensional axis.
`void`	`addTransform(DataTransform trans)` Links the given data transform to the display.
`protected void`	`doCustomMaps()` Adds any required custom mappings to the display.
`protected void`	`doLinks(int startIndex, boolean unlinkFirst)` Links in the transform links, starting at the given index.
`int`	`getAnimationAxis()` Gets the currently assigned animation axis.
`int`	`getAnimationRate()` Gets animation rate.
`int`	`getAxis(DataTransform trans, int axis)` Identifies the dimensional axis of the given transform to which the specified slider axis corresponds, or -1 if none.
`long`	`getBurnDelay()` Gets the delay in milliseconds before full-resolution burn-in occurs.
`DataCache`	`getCache()` Gets cache of full-resolution data in memory.
`TransformLink`	`getLink(DataTransform trans)` Gets the transform link object for the given data transform.
`int`	`getLinkIndex(DataTransform trans)` Gets the transform link index for the given data transform.
`TransformPanel`	`getPanel()` Gets GUI controls for this transform handler.
`int[]`	`getPos(DataTransform trans)` Gets the dimensional position specified by the given transform's slider widgets.
`BioSlideWidget`	`getSlider(int index)` Gets the slider at the given index, or null if no such slider exists.
`JPanel`	`getSliderPanel()` Gets a panel containing sliders widgets for linked transforms.
`int`	`getTransformCount()` Gets number of data transforms linked to the display.
`DataTransform[]`	`getTransforms()` Gets data transforms linked to the display.
`DisplayWindow`	`getWindow()` Gets associated display window.
`boolean`	`hasTransform(DataTransform trans)` Gets whether the given transform is currently linked to the display.
`void`	`initState(TransformHandler handler)` Modifies this object's state to match that of the given object.
`boolean`	`isAnimating()` Gets whether display is currently animating.
`protected void`	`makePanel()` Constructs GUI controls for the transform handler.
`boolean`	`matches(TransformHandler handler)` Tests whether two objects are in equivalent states.
`void`	`moveTransformDown(DataTransform trans)` Moves the given transform down in the Z-order.
`void`	`moveTransformUp(DataTransform trans)` Moves the given transform up in the Z-order.
`protected void`	`rebuild(boolean resetColors)` Rebuilds sliders and display mappings for all linked transforms.
`void`	`removeAllTransforms()` Unlinks all data transforms from the display.
`void`	`removeTransform(DataTransform trans)` Removes the given data transform from the display.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("Display").
`void`	`run()` Animates the display.
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("Display").
`void`	`setAnimating(boolean on)` Toggles animation of the display.
`void`	`setAnimationAxis(int animAxis)` Assigns the given axis as the animation axis.
`void`	`setAnimationRate(int fps)` Sets animation rate.
`void`	`setBurnDelay(long delay)` Sets the delay in milliseconds before full-resolution burn-in occurs.
`protected void`	`startAnimation()` Starts a new thread for animation.
`void`	`stateChanged(ChangeEvent e)` Handles slider updates.

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

- Field Detail
  - DEFAULT_BURN_DELAY
```
public static final long DEFAULT_BURN_DELAY
```
    Starting burn-in delay in milliseconds.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_BURN_DELAY
```
public static final long MINIMUM_BURN_DELAY
```
    Minimum amount of time to delay burn-in.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ANIMATION_RATE
```
public static final int DEFAULT_ANIMATION_RATE
```
    Starting FPS for animation.
    
    See Also:
    
    Constant Field Values
  - window
```
protected DisplayWindow window
```
    Associated display window.
  - panel
```
protected TransformPanel panel
```
    GUI controls for transform handler.
  - cache
```
protected DataCache cache
```
    Cache of full-resolution data in memory.
  - links
```
protected Vector links
```
    Data transform links.
  - sliders
```
protected Vector sliders
```
    Dimensional slider widgets for linked transforms.
  - sliderPanel
```
protected JPanel sliderPanel
```
    Panel containing dimensional slider widgets.
  - burnDelay
```
protected long burnDelay
```
    Default burn-in delay in milliseconds.
  - animating
```
protected boolean animating
```
    Flag indicating status of animation.
  - fps
```
protected int fps
```
    Animation rate.
  - animAxis
```
protected int animAxis
```
    Dimensional axis to use for animation.
  - animThread
```
protected Thread animThread
```
    Thread responsible for animation.
  - animSync
```
protected Object animSync
```
    Synchronization object for animation.
  - newLinks
```
protected Vector newLinks
```
    List of uninitialized links.
- Constructor Detail
  - TransformHandler
```
public TransformHandler(DisplayWindow dw)
```
    Creates a display transform handler.
- Method Detail
  - addTransform
```
public void addTransform(DataTransform trans)
```
    Links the given data transform to the display.
  - removeTransform
```
public void removeTransform(DataTransform trans)
```
    Removes the given data transform from the display.
  - removeAllTransforms
```
public void removeAllTransforms()
```
    Unlinks all data transforms from the display.
  - moveTransformUp
```
public void moveTransformUp(DataTransform trans)
```
    Moves the given transform up in the Z-order.
  - moveTransformDown
```
public void moveTransformDown(DataTransform trans)
```
    Moves the given transform down in the Z-order.
  - hasTransform
```
public boolean hasTransform(DataTransform trans)
```
    Gets whether the given transform is currently linked to the display.
  - getTransforms
```
public DataTransform[] getTransforms()
```
    Gets data transforms linked to the display.
  - getTransformCount
```
public int getTransformCount()
```
    Gets number of data transforms linked to the display.
  - getCache
```
public DataCache getCache()
```
    Gets cache of full-resolution data in memory.
  - getWindow
```
public DisplayWindow getWindow()
```
    Gets associated display window.
  - getPanel
```
public TransformPanel getPanel()
```
    Gets GUI controls for this transform handler.
  - getSliderPanel
```
public JPanel getSliderPanel()
```
    Gets a panel containing sliders widgets for linked transforms.
  - getSlider
```
public BioSlideWidget getSlider(int index)
```
    Gets the slider at the given index, or null if no such slider exists.
  - getPos
```
public int[] getPos(DataTransform trans)
```
    Gets the dimensional position specified by the given transform's slider widgets.
  - setBurnDelay
```
public void setBurnDelay(long delay)
```
    Sets the delay in milliseconds before full-resolution burn-in occurs.
  - getBurnDelay
```
public long getBurnDelay()
```
    Gets the delay in milliseconds before full-resolution burn-in occurs.
  - setAnimating
```
public void setAnimating(boolean on)
```
    Toggles animation of the display.
  - isAnimating
```
public boolean isAnimating()
```
    Gets whether display is currently animating.
  - setAnimationRate
```
public void setAnimationRate(int fps)
```
    Sets animation rate.
  - getAnimationRate
```
public int getAnimationRate()
```
    Gets animation rate.
  - setAnimationAxis
```
public void setAnimationAxis(int animAxis)
```
    Assigns the given axis as the animation axis.
  - getAnimationAxis
```
public int getAnimationAxis()
```
    Gets the currently assigned animation axis.
  - getLink
```
public TransformLink getLink(DataTransform trans)
```
    Gets the transform link object for the given data transform.
  - getLinkIndex
```
public int getLinkIndex(DataTransform trans)
```
    Gets the transform link index for the given data transform.
  - getAxis
```
public int getAxis(DataTransform trans,
                   int axis)
```
    Identifies the dimensional axis of the given transform to which the specified slider axis corresponds, or -1 if none.
  - matches
```
public boolean matches(TransformHandler handler)
```
    Tests whether two objects are in equivalent states.
  - initState
```
public void initState(TransformHandler handler)
```
    Modifies this object's state to match that of the given object. If the argument is null, the object is initialized according to its current state instead.
  - makePanel
```
protected void makePanel()
```
    Constructs GUI controls for the transform handler.
  - addAxis
```
protected void addAxis(String axis)
```
    Notifies the transform panel of a new dimensional axis.
  - doCustomMaps
```
protected void doCustomMaps()
                     throws VisADException,
                            RemoteException
```
    Adds any required custom mappings to the display.
    
    Throws:
    
    VisADException
    
    RemoteException
  - doLinks
```
protected void doLinks(int startIndex,
                       boolean unlinkFirst)
```
    Links in the transform links, starting at the given index.
  - rebuild
```
protected void rebuild(boolean resetColors)
```
    Rebuilds sliders and display mappings for all linked transforms.
  - startAnimation
```
protected void startAnimation()
```
    Starts a new thread for animation.
  - stateChanged
```
public void stateChanged(ChangeEvent e)
```
    Handles slider updates.
    
    Specified by:
    
    stateChanged in interface ChangeListener
  - run
```
public void run()
```
    Animates the display.
    
    Specified by:
    
    run in interface Runnable
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("Display").
    
    Specified by:
    
    saveState in interface Saveable
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("Display").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException

Class TransformHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BURN_DELAY

MINIMUM_BURN_DELAY

DEFAULT_ANIMATION_RATE

window

panel

cache

links

sliders

sliderPanel

burnDelay

animating

fps

animAxis

animThread

animSync

newLinks

Constructor Detail

TransformHandler

Method Detail

addTransform

removeTransform

removeAllTransforms

moveTransformUp

moveTransformDown

hasTransform

getTransforms

getTransformCount

getCache

getWindow

getPanel

getSliderPanel

getSlider

getPos

setBurnDelay

getBurnDelay

setAnimating

isAnimating

setAnimationRate

getAnimationRate

setAnimationAxis

getAnimationAxis

getLink

getLinkIndex

getAxis

matches

initState

makePanel

addAxis

doCustomMaps

doLinks

rebuild

startAnimation

stateChanged

run

saveState

restoreState