ColorHandler (LOCI Javadocs 0-SNAPSHOT API)

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

```
public class ColorHandler
extends Object
```
Provides logic for controlling a TransformLink's color settings.

Field Summary

Fields
Modifier and Type	Field and Description
`protected RealType`	`blue` Red, green and blue components of images.
`protected int`	`brightness` Brightness and contrast of images.
`protected int`	`colorModel` Color model (RGB_MODEL, HSV_MODEL or COMPOSITE_MODEL).
`protected ColorPane`	`colorPane` Dialog pane for adjusting color settings.
`protected float[][][]`	`colorTables` Color tables.
`protected int`	`contrast` Brightness and contrast of images.
`protected boolean[]`	`fixed` Flags indicating color ranges should not be auto-scaled.
`protected RealType`	`green` Red, green and blue components of images.
`protected double[]`	`hi` Minimum and maximum color range values.
`protected TransformLink`	`link` Associated link between data object and display.
`protected double[]`	`lo` Minimum and maximum color range values.
`protected static int`	`NORMAL_BRIGHTNESS` Starting brightness value.
`protected static int`	`NORMAL_CONTRAST` Starting contrast value.
`protected static int`	`NORMAL_OPACITY` Starting opacity value.
`protected int`	`opacityModel` Transparency model (CONSTANT_ALPHA or CURVED_ALPHA).
`protected int`	`opacityValue` Opacity value.
`protected RealType`	`red` Red, green and blue components of images.

Constructor Summary

Constructors
Constructor and Description

ColorHandler(TransformLink link)
Creates a color handler for the given transform link.

Constructors
Constructor and Description
`ColorHandler(TransformLink link)` Creates a color handler for the given transform link.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RealType`	`getBlue()` Gets RealType mapped to blue.
`int`	`getBrightness()` Gets brightness value.
`int`	`getColorModel()` Gets color model (RGB_MODEL, HSV_MODEL or COMPOSITE_MODEL).
`ColorPane`	`getColorPane()` Gets GUI control pane for this color handler.
`int`	`getContrast()` Gets contrast value.
`boolean[]`	`getFixed()` Gets whether each color mapping has a fixed range.
`RealType`	`getGreen()` Gets RealType mapped to green.
`double[]`	`getHi()` Gets color mapping maximums.
`TransformLink`	`getLink()` Gets associated transform link.
`double[]`	`getLo()` Gets color mapping minimums.
`ScalarMap[]`	`getMaps()` Gets color mappings for this color handler's transform link.
`int`	`getOpacityModel()` Gets opacity model (CONSTANT_ALPHA or CURVED_ALPHA).
`int`	`getOpacityValue()` Gets opacity value.
`RealType`	`getRed()` Gets RealType mapped to red.
`float[][][]`	`getTables()` Gets current color tables.
`DisplayWindow`	`getWindow()` Gets the VisBio display window affected by this color handler.
`void`	`initColors(boolean reset)` Applies color settings to the latest linked data object.
`void`	`initState(ColorHandler handler)` Modifies this object's state to match that of the given object.
`boolean`	`matches(ColorHandler handler)` Tests whether two objects are in equivalent states.
`void`	`reAutoScale()` Recomputes autoscaled color range bounds.
`void`	`refreshPreviewData()` Refreshes preview data from the transform link.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("TransformLink").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("TransformLink").
`void`	`setColors(int brightness, int contrast, int colorModel, RealType red, RealType green, RealType blue, boolean compute)` Updates color settings to those given.
`void`	`setOpacity(int opacityValue, int opacityModel, boolean compute)` Sets opacity.
`void`	`setRanges(double[] lo, double[] hi, boolean[] fixed)` Updates map ranges to those given.
`void`	`setTables(float[][][] tables)` Updates color tables to those given.
`void`	`showColorDialog()` Displays the color dialog pane onscreen and alters the color scheme as requested.

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

- Field Detail
  - NORMAL_BRIGHTNESS
```
protected static final int NORMAL_BRIGHTNESS
```
    Starting brightness value.
    
    See Also:
    
    Constant Field Values
  - NORMAL_CONTRAST
```
protected static final int NORMAL_CONTRAST
```
    Starting contrast value.
    
    See Also:
    
    Constant Field Values
  - NORMAL_OPACITY
```
protected static final int NORMAL_OPACITY
```
    Starting opacity value.
    
    See Also:
    
    Constant Field Values
  - link
```
protected TransformLink link
```
    Associated link between data object and display.
  - colorPane
```
protected ColorPane colorPane
```
    Dialog pane for adjusting color settings.
  - brightness
```
protected int brightness
```
    Brightness and contrast of images.
  - contrast
```
protected int contrast
```
    Brightness and contrast of images.
  - opacityValue
```
protected int opacityValue
```
    Opacity value.
  - opacityModel
```
protected int opacityModel
```
    Transparency model (CONSTANT_ALPHA or CURVED_ALPHA).
  - colorModel
```
protected int colorModel
```
    Color model (RGB_MODEL, HSV_MODEL or COMPOSITE_MODEL).
  - red
```
protected RealType red
```
    Red, green and blue components of images.
  - green
```
protected RealType green
```
    Red, green and blue components of images.
  - blue
```
protected RealType blue
```
    Red, green and blue components of images.
  - lo
```
protected double[] lo
```
    Minimum and maximum color range values.
  - hi
```
protected double[] hi
```
    Minimum and maximum color range values.
  - fixed
```
protected boolean[] fixed
```
    Flags indicating color ranges should not be auto-scaled.
  - colorTables
```
protected float[][][] colorTables
```
    Color tables.
- Constructor Detail
  - ColorHandler
```
public ColorHandler(TransformLink link)
```
    Creates a color handler for the given transform link.
- Method Detail
  - getLink
```
public TransformLink getLink()
```
    Gets associated transform link.
  - getColorPane
```
public ColorPane getColorPane()
```
    Gets GUI control pane for this color handler.
  - getWindow
```
public DisplayWindow getWindow()
```
    Gets the VisBio display window affected by this color handler.
  - getMaps
```
public ScalarMap[] getMaps()
```
    Gets color mappings for this color handler's transform link.
  - initColors
```
public void initColors(boolean reset)
```
    Applies color settings to the latest linked data object. If the reset flag is set, guesses at good initial color mappings.
  - refreshPreviewData
```
public void refreshPreviewData()
```
    Refreshes preview data from the transform link.
  - showColorDialog
```
public void showColorDialog()
```
    Displays the color dialog pane onscreen and alters the color scheme as requested.
  - setColors
```
public void setColors(int brightness,
                      int contrast,
                      int colorModel,
                      RealType red,
                      RealType green,
                      RealType blue,
                      boolean compute)
```
    Updates color settings to those given.
  - setOpacity
```
public void setOpacity(int opacityValue,
                       int opacityModel,
                       boolean compute)
```
    Sets opacity.
    
    Parameters:
    
    opacityValue - How opaque data should be, ranging from 0 - 256
    
    opacityModel - ColorUtil.CONSTANT_ALPHA or ColorUtil.CURVED_ALPHA
    
    compute - Whether to actually update the data
  - setRanges
```
public void setRanges(double[] lo,
                      double[] hi,
                      boolean[] fixed)
```
    Updates map ranges to those given.
  - setTables
```
public void setTables(float[][][] tables)
```
    Updates color tables to those given.
  - reAutoScale
```
public void reAutoScale()
```
    Recomputes autoscaled color range bounds.
  - getBrightness
```
public int getBrightness()
```
    Gets brightness value.
  - getContrast
```
public int getContrast()
```
    Gets contrast value.
  - getOpacityValue
```
public int getOpacityValue()
```
    Gets opacity value.
  - getOpacityModel
```
public int getOpacityModel()
```
    Gets opacity model (CONSTANT_ALPHA or CURVED_ALPHA).
  - getColorModel
```
public int getColorModel()
```
    Gets color model (RGB_MODEL, HSV_MODEL or COMPOSITE_MODEL).
  - getRed
```
public RealType getRed()
```
    Gets RealType mapped to red.
  - getGreen
```
public RealType getGreen()
```
    Gets RealType mapped to green.
  - getBlue
```
public RealType getBlue()
```
    Gets RealType mapped to blue.
  - getLo
```
public double[] getLo()
```
    Gets color mapping minimums.
  - getHi
```
public double[] getHi()
```
    Gets color mapping maximums.
  - getFixed
```
public boolean[] getFixed()
```
    Gets whether each color mapping has a fixed range.
  - getTables
```
public float[][][] getTables()
```
    Gets current color tables.
  - matches
```
public boolean matches(ColorHandler handler)
```
    Tests whether two objects are in equivalent states.
  - initState
```
public void initState(ColorHandler 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.
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("TransformLink").
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("TransformLink").
    
    Throws:
    
    SaveException

Class ColorHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NORMAL_BRIGHTNESS

NORMAL_CONTRAST

NORMAL_OPACITY

link

colorPane

brightness

contrast

opacityValue

opacityModel

colorModel

red

green

blue

lo

hi

fixed

colorTables

Constructor Detail

ColorHandler

Method Detail

getLink

getColorPane

getWindow

getMaps

initColors

refreshPreviewData

showColorDialog

setColors

setOpacity

setRanges

setTables

reAutoScale

getBrightness

getContrast

getOpacityValue

getOpacityModel

getColorModel

getRed

getGreen

getBlue

getLo

getHi

getFixed

getTables

matches

initState

saveState

restoreState