org.jfree.chart.ui
Class ColorPalette

java.lang.Object
  |
  +--org.jfree.chart.ui.ColorPalette

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GreyPalette, RainbowPalette

public abstract class ColorPalette

extends java.lang.Object

implements java.io.Serializable

Defines palette used in Contour Plots.

Author:

David M. O'Donnell.

See Also:

Serialized Form

Field Summary

protected int[]	b Blue components.
protected int[]	g Green components.
protected boolean	inverse Inverse palette (ie, min and max colors are reversed).
protected static double	log10 Constant for converting loge to log10.
protected boolean	logscale Logscale?
protected double	maxZ The max z-axis value.
protected double	minZ The min z-axis value.
protected java.lang.String	paletteName The palette name.
protected int[]	r Red components.
protected boolean	stepped Controls whether palette colors are stepped (not continuous).
protected double[]	tickValues Tick values are stored for use with stepped palette.

Constructor Summary

ColorPalette()
Default contructor.

Method Summary

java.awt.Paint	getColor(double value) Returns the color associated with a value.
java.awt.Color	getColor(int izV) Returns a color.
java.awt.Color	getColorLinear(double value) Returns Color by mapping a given value to a linear palette.
java.awt.Color	getColorLog(double value) Returns Color by mapping a given value to a common log palette.
double	getMaxZ() Returns the maximum Z value.
double	getMinZ() Returns the minimum Z value.
java.awt.Paint	getPaint(double value) Returns Paint by mapping a given value to a either a linear or common log palette as controlled by the value logscale.
java.lang.String	getPaletteName() Returns the palette name.
double[]	getTickValues() Returns the tick values.
abstract void	initialize() Called to initialize the palette's color indexes
void	invertPalette() Inverts Palette
boolean	isInverse() Returns the inverse flag.
boolean	isLogscale() Returns the log-scale flag.
boolean	isStepped() Returns the 'is-stepped' flag.
void	setInverse(boolean inverse) Sets the inverse flag.
void	setLogscale(boolean logscale) Sets the 'log-scale' flag.
void	setMaxZ(double newMaxZ) Sets the maximum Z value.
void	setMinZ(double newMinZ) Sets the minimum Z value.
void	setPaletteName(java.lang.String paletteName) Sets the palette name.
void	setStepped(boolean stepped) Sets the stepped flag.
void	setTickValues(double[] newTickValues)
void	setTickValues(java.util.List ticks) Store ticks.

Methods inherited from class java.lang.Object

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

Field Detail

minZ

protected double minZ

The min z-axis value.

maxZ

protected double maxZ

The max z-axis value.

r

protected int[] r

Red components.

g

protected int[] g

Green components.

b

protected int[] b

Blue components.

tickValues

protected double[] tickValues

Tick values are stored for use with stepped palette.

logscale

protected boolean logscale

Logscale?

inverse

protected boolean inverse

Inverse palette (ie, min and max colors are reversed).

paletteName

protected java.lang.String paletteName

The palette name.

stepped

protected boolean stepped

Controls whether palette colors are stepped (not continuous).

log10

protected static final double log10

Constant for converting loge to log10.

Constructor Detail

ColorPalette

public ColorPalette()

Default contructor.

Method Detail

getColor

public java.awt.Paint getColor(double value)

Returns the color associated with a value.

Parameters:

value - the value.

Returns:

the color.

getColor

public java.awt.Color getColor(int izV)

Returns a color.

Parameters:

izV - ??.

Returns:

the color.

getColorLinear

public java.awt.Color getColorLinear(double value)

Returns Color by mapping a given value to a linear palette.

Parameters:

value - the value.

Returns:

The color.

getColorLog

public java.awt.Color getColorLog(double value)

Returns Color by mapping a given value to a common log palette.

Parameters:

value - the value.

Returns:

The color.

getMaxZ

public double getMaxZ()

Returns the maximum Z value.

Returns:

the value.

getMinZ

public double getMinZ()

Returns the minimum Z value.

Returns:

the value.

getPaint

public java.awt.Paint getPaint(double value)

Returns Paint by mapping a given value to a either a linear or common log palette as controlled by the value logscale.

Parameters:

value - the value.

Returns:

The paint.

getPaletteName

public java.lang.String getPaletteName()

Returns the palette name.

Returns:

the palette name.

getTickValues

public double[] getTickValues()

Returns the tick values.

Returns:

the tick values.

initialize

public abstract void initialize()

Called to initialize the palette's color indexes

invertPalette

public void invertPalette()

Inverts Palette

isInverse

public boolean isInverse()

Returns the inverse flag.

Returns:

the flag.

isLogscale

public boolean isLogscale()

Returns the log-scale flag.

Returns:

the flag.

isStepped

public boolean isStepped()

Returns the 'is-stepped' flag.

Returns:

the flag.

setInverse

public void setInverse(boolean inverse)

Sets the inverse flag.

Parameters:

inverse - the new value.

setLogscale

public void setLogscale(boolean logscale)

Sets the 'log-scale' flag.

Parameters:

logscale - the new value.

setMaxZ

public void setMaxZ(double newMaxZ)

Sets the maximum Z value.

Parameters:

newMaxZ - the new value.

setMinZ

public void setMinZ(double newMinZ)

Sets the minimum Z value.

Parameters:

newMinZ - the new value.

setPaletteName

public void setPaletteName(java.lang.String paletteName)

Sets the palette name.

Parameters:

paletteName - the name.

setStepped

public void setStepped(boolean stepped)

Sets the stepped flag.

Parameters:

stepped - the flag.

setTickValues

public void setTickValues(double[] newTickValues)

setTickValues

public void setTickValues(java.util.List ticks)

Store ticks. Required when doing stepped axis