net.sf.jtreemap.swing.provider

Class HSBTreeMapColorProvider

java.lang.Object

net.sf.jtreemap.swing.provider.ColorProvider

net.sf.jtreemap.swing.provider.HSBTreeMapColorProvider

All Implemented Interfaces:

Serializable

public class HSBTreeMapColorProvider
extends ColorProvider

An HSB color space color provider for JTreeMap. Uses a specified function to map the values onto the HSB color space. The default is a linear function, but in my experience one of the logarithmic ones works best for this color space.

Author:

Andy Adamczak

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HSBTreeMapColorProvider.ColorDistributionTypes

Constructor Summary

Constructors

Constructor and Description
HSBTreeMapColorProvider(JTreeMap treeMap, Color color)
HSBTreeMapColorProvider(JTreeMap treeMap, Color positiveColor, Color negativeColor)
HSBTreeMapColorProvider(JTreeMap treeMap, float hue, float saturation)
HSBTreeMapColorProvider(JTreeMap treeMap, float positiveHue, float positiveSaturation, float negativeHue, float negativeSaturation)
HSBTreeMapColorProvider(JTreeMap treeMap, HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution, Color color)
HSBTreeMapColorProvider(JTreeMap treeMap, HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution, Color positiveColor, Color negativeColor)
HSBTreeMapColorProvider(JTreeMap treeMap, HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution, float hue, float saturation)
HSBTreeMapColorProvider(JTreeMap treeMap, HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution, float positiveHue, float positiveSaturation, float negativeHue, float negativeSaturation)

Method Summary

Modifier and Type	Method and Description
void	adjustColor(Color color)
void	adjustColor(Color positiveColor, Color negativeColor)
void	adjustColor(float hue, float saturation)
void	adjustColor(float posHue, float posSaturation, float negHue, float negSaturation)
Color	getColor(Value value) get the associated color to the value.
JPanel	getLegendPanel() get a legend JPanel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               Color color)

Parameters:

treeMap -

color -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution,
                               Color color)

Parameters:

treeMap -

colorDistribution -

color -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               Color positiveColor,
                               Color negativeColor)

Parameters:

treeMap -

positiveColor -

negativeColor -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution,
                               Color positiveColor,
                               Color negativeColor)

Parameters:

treeMap -

colorDistribution -

positiveColor -

negativeColor -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               float hue,
                               float saturation)

Parameters:

treeMap -

hue -

saturation -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution,
                               float hue,
                               float saturation)

Parameters:

treeMap -

colorDistribution -

hue -

saturation -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               float positiveHue,
                               float positiveSaturation,
                               float negativeHue,
                               float negativeSaturation)

Parameters:

treeMap -

positiveHue -

positiveSaturation -

negativeHue -

negativeSaturation -

HSBTreeMapColorProvider

public HSBTreeMapColorProvider(JTreeMap treeMap,
                               HSBTreeMapColorProvider.ColorDistributionTypes colorDistribution,
                               float positiveHue,
                               float positiveSaturation,
                               float negativeHue,
                               float negativeSaturation)

Parameters:

treeMap -

colorDistribution -

positiveHue -

positiveSaturation -

negativeHue -

negativeSaturation -

Method Detail

getLegendPanel

public JPanel getLegendPanel()

Description copied from class: ColorProvider

get a legend JPanel.

Specified by:

getLegendPanel in class ColorProvider

Returns:

a legend JPanel

adjustColor

public void adjustColor(Color color)

Parameters:

color -

adjustColor

public void adjustColor(Color positiveColor,
                        Color negativeColor)

Parameters:

positiveColor -

negativeColor -

adjustColor

public void adjustColor(float hue,
                        float saturation)

Parameters:

hue -

saturation -

adjustColor

public void adjustColor(float posHue,
                        float posSaturation,
                        float negHue,
                        float negSaturation)

Parameters:

posHue -

posSaturation -

negHue -

negSaturation -

getColor

public Color getColor(Value value)

Description copied from class: ColorProvider

get the associated color to the value.

Specified by:

getColor in class ColorProvider

Parameters:

value - double value

Returns:

the associated color to the value