TransformLink (LOCI Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Runnable, EventListener, TransformListener, Dynamic, Saveable, DisplayListener

Direct Known Subclasses:

StackLink
```
public class TransformLink
extends Object
implements DisplayListener, Dynamic, Runnable, Saveable, TransformListener
```
Represents a link between a data transform and a display that produces a single image.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alive` Whether this link is still active.
`protected boolean`	`burnNow` Whether a full-resolution burn-in should occur immediately.
`protected Thread`	`burnThread` Separate thread for managing full-resolution burn-in.
`protected long`	`burnTime` Next clock time a full-resolution burn-in should occur.
`protected int[]`	`cachedPos` Last cached dimensional position of the link.
`protected boolean`	`clearWhenDone` Whether a TRANSFORM_DONE event should clear the status message.
`protected ColorHandler`	`colorHandler` Associated handler for managing this link's color settings.
`protected VisADException[]`	`cursor` Range values for current cursor location, to be displayed in bottom left corner.
`protected TransformHandler`	`handler` Associated transform handler.
`protected DataReferenceImpl`	`ref` Data reference linking data to the display.
`protected DataRenderer`	`rend` Data renderer for toggling data's visibility and other parameters.
`protected VisADException`	`status` Status message, to be displayed in bottom left corner.
`protected DataTransform`	`trans` Data transform linked to the display.
`protected boolean`	`visible` Whether data transform is visible onscreen.

Constructor Summary

Constructors
Constructor and Description
`TransformLink(TransformHandler h)` Constructs an uninitialized transform link.
`TransformLink(TransformHandler h, DataTransform t)` Creates a link between the given data transform and the specified transform handler's display.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`computeCursor()` Computes range values at the current cursor location.
`protected void`	`computeData(boolean thumbs)` Computes the reference data at the current position, utilizing thumbnails as appropriate.
`void`	`destroy()` Frees resources being consumed by this transform link.
`void`	`discard()` Called when this object is being discarded in favor of another object with a matching state.
`void`	`displayChanged(DisplayEvent e)` Handles VisAD display events.
`protected void`	`doTransform()` Updates displayed data based on current dimensional position.
`protected void`	`doTransform(long delay)` Updates displayed data based on current dimensional position.
`protected void`	`doTransform(long delay, boolean now)` Updates displayed data based on current dimensional position.
`ColorHandler`	`getColorHandler()` Gets the link's color handler.
`TransformHandler`	`getHandler()` Gets the link's transform handler.
`protected Data`	`getImageData(int[] pos)` Gets the transform's data at the given dimensional position.
`DataReferenceImpl`	`getReference()` Gets the link's reference.
`DataRenderer`	`getRenderer()` Gets the link's renderer.
`DataTransform`	`getTransform()` Gets the link's data transform.
`void`	`initState(Dynamic dyn)` Modifies this object's state to match that of the given object.
`boolean`	`isCompatible(Dynamic dyn)` Tests whether the given dynamic object can be used as an argument to initState, for initializing this dynamic object.
`boolean`	`isVisible()` Gets visibility of the transform.
`void`	`link()` Links this transform into the display.
`boolean`	`matches(Dynamic dyn)` Tests whether two dynamic objects are equivalent.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("TransformLink").
`void`	`run()` Executes full-resolution burn-in operations.
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("LinkedData").
`protected void`	`setData(Data d)` Assigns the given data object to the data reference.
`protected void`	`setData(Data d, boolean autoSwitch)` Assigns the given data object to the data reference, switching to the proper types if the flag is set.
`protected void`	`setData(Data d, DataReference dataRef)` Assigns the given data object to the given data reference.
`protected void`	`setData(Data d, DataReference dataRef, boolean autoSwitch)` Assigns the given data object to the given data reference, switching to the proper types if the flag is set.
`void`	`setMessage(String msg)` Sets status messages displayed in display's bottom left-hand corner.
`void`	`setVisible(boolean vis)` Toggles visibility of the transform.
`void`	`transformChanged(TransformEvent e)` Called when a data transform's parameters are updated.
`void`	`unlink()` Unlinks this transform from the display.

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

- Field Detail
  - handler
```
protected TransformHandler handler
```
    Associated transform handler.
  - trans
```
protected DataTransform trans
```
    Data transform linked to the display.
  - colorHandler
```
protected ColorHandler colorHandler
```
    Associated handler for managing this link's color settings.
  - ref
```
protected DataReferenceImpl ref
```
    Data reference linking data to the display.
  - rend
```
protected DataRenderer rend
```
    Data renderer for toggling data's visibility and other parameters.
  - burnThread
```
protected Thread burnThread
```
    Separate thread for managing full-resolution burn-in.
  - burnNow
```
protected boolean burnNow
```
    Whether a full-resolution burn-in should occur immediately.
  - burnTime
```
protected long burnTime
```
    Next clock time a full-resolution burn-in should occur.
  - alive
```
protected boolean alive
```
    Whether this link is still active.
  - status
```
protected VisADException status
```
    Status message, to be displayed in bottom left corner.
  - cursor
```
protected VisADException[] cursor
```
    Range values for current cursor location, to be displayed in bottom left corner.
  - clearWhenDone
```
protected boolean clearWhenDone
```
    Whether a TRANSFORM_DONE event should clear the status message.
  - cachedPos
```
protected int[] cachedPos
```
    Last cached dimensional position of the link.
  - visible
```
protected boolean visible
```
    Whether data transform is visible onscreen.
- Constructor Detail
  - TransformLink
```
public TransformLink(TransformHandler h)
```
    Constructs an uninitialized transform link.
  - TransformLink
```
public TransformLink(TransformHandler h,
                     DataTransform t)
```
    Creates a link between the given data transform and the specified transform handler's display.
- Method Detail
  - getHandler
```
public TransformHandler getHandler()
```
    Gets the link's transform handler.
  - getTransform
```
public DataTransform getTransform()
```
    Gets the link's data transform.
  - getColorHandler
```
public ColorHandler getColorHandler()
```
    Gets the link's color handler.
  - getReference
```
public DataReferenceImpl getReference()
```
    Gets the link's reference.
  - getRenderer
```
public DataRenderer getRenderer()
```
    Gets the link's renderer.
  - link
```
public void link()
```
    Links this transform into the display.
  - unlink
```
public void unlink()
```
    Unlinks this transform from the display.
  - destroy
```
public void destroy()
```
    Frees resources being consumed by this transform link.
  - setVisible
```
public void setVisible(boolean vis)
```
    Toggles visibility of the transform.
  - isVisible
```
public boolean isVisible()
```
    Gets visibility of the transform.
  - setMessage
```
public void setMessage(String msg)
```
    Sets status messages displayed in display's bottom left-hand corner.
  - displayChanged
```
public void displayChanged(DisplayEvent e)
```
    Handles VisAD display events.
    
    Specified by:
    
    displayChanged in interface DisplayListener
  - matches
```
public boolean matches(Dynamic dyn)
```
    Tests whether two dynamic objects are equivalent.
    
    Specified by:
    
    matches in interface Dynamic
  - isCompatible
```
public boolean isCompatible(Dynamic dyn)
```
    Tests whether the given dynamic object can be used as an argument to initState, for initializing this dynamic object.
    
    Specified by:
    
    isCompatible in interface Dynamic
  - initState
```
public void initState(Dynamic dyn)
```
    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.
    
    Specified by:
    
    initState in interface Dynamic
  - discard
```
public void discard()
```
    Called when this object is being discarded in favor of another object with a matching state.
    
    Specified by:
    
    discard in interface Dynamic
  - run
```
public void run()
```
    Executes full-resolution burn-in operations.
    
    Specified by:
    
    run in interface Runnable
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("LinkedData").
    
    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 ("TransformLink").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException
  - transformChanged
```
public void transformChanged(TransformEvent e)
```
    Called when a data transform's parameters are updated.
    
    Specified by:
    
    transformChanged in interface TransformListener
  - doTransform
```
protected void doTransform()
```
    Updates displayed data based on current dimensional position.
  - doTransform
```
protected void doTransform(long delay)
```
    Updates displayed data based on current dimensional position.
  - doTransform
```
protected void doTransform(long delay,
                           boolean now)
```
    Updates displayed data based on current dimensional position.
  - computeData
```
protected void computeData(boolean thumbs)
```
    Computes the reference data at the current position, utilizing thumbnails as appropriate.
  - getImageData
```
protected Data getImageData(int[] pos)
```
    Gets the transform's data at the given dimensional position.
  - setData
```
protected void setData(Data d)
```
    Assigns the given data object to the data reference.
  - setData
```
protected void setData(Data d,
                       boolean autoSwitch)
```
    Assigns the given data object to the data reference, switching to the proper types if the flag is set.
  - setData
```
protected void setData(Data d,
                       DataReference dataRef)
```
    Assigns the given data object to the given data reference.
  - setData
```
protected void setData(Data d,
                       DataReference dataRef,
                       boolean autoSwitch)
```
    Assigns the given data object to the given data reference, switching to the proper types if the flag is set.
  - computeCursor
```
protected void computeCursor()
```
    Computes range values at the current cursor location.

Class TransformLink

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

handler

trans

colorHandler

ref

rend

burnThread

burnNow

burnTime

alive

status

cursor

clearWhenDone

cachedPos

visible

Constructor Detail

TransformLink

TransformLink

Method Detail

getHandler

getTransform

getColorHandler

getReference

getRenderer

link

unlink

destroy

setVisible

isVisible

setMessage

displayChanged

matches

isCompatible

initState

discard

run

saveState

restoreState

transformChanged

doTransform

doTransform

doTransform

computeData

getImageData

setData

setData

setData

setData

computeCursor