public abstract class

ColorPalette

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.plot.ColorPalette
Known Direct Subclasses

This class is deprecated.
This class is no longer supported (as of version 1.0.4). If you are creating contour plots, please try to use XYPlot and XYBlockRenderer.

Class Overview

Defines palette used by ContourPlot.

Summary

Fields
protected int[] b Blue components.
protected int[] g Green components.
protected boolean inverse Inverse palette (ie, min and max colors are reversed).
protected static final 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 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.
Public Constructors
ColorPalette()
Default contructor.
Public Methods
Object clone()
Returns a clone of the palette.
boolean equals(Object o)
Tests an object for equality with this instance.
Paint getColor(double value)
Returns the color associated with a value.
Color getColor(int izV)
Returns a color.
Color getColorLinear(double value)
Returns Color by mapping a given value to a linear palette.
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.
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.
String getPaletteName()
Returns the palette name.
double[] getTickValues()
Returns the tick values.
int hashCode()
Returns a hash code.
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(String paletteName)
Sets the palette name.
void setStepped(boolean stepped)
Sets the stepped flag.
void setTickValues(double[] newTickValues)
Sets the tick values.
void setTickValues(List ticks)
Store ticks.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected int[] b

Blue components.

protected int[] g

Green components.

protected boolean inverse

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

protected static final 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 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.

Public Constructors

public ColorPalette ()

Default contructor.

Public Methods

public Object clone ()

Returns a clone of the palette.

Returns
  • A clone.
Throws
CloneNotSupportedException never.

public boolean equals (Object o)

Tests an object for equality with this instance.

Parameters
o the object to test.
Returns
  • A boolean.

public Paint getColor (double value)

Returns the color associated with a value.

Parameters
value the value.
Returns
  • The color.

public Color getColor (int izV)

Returns a color.

Parameters
izV the index into the palette (zero based).
Returns
  • The color.

public Color getColorLinear (double value)

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

Parameters
value the value.
Returns
  • The color.

public Color getColorLog (double value)

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

Parameters
value the value.
Returns
  • The color.

public double getMaxZ ()

Returns the maximum Z value.

Returns
  • The value.

public double getMinZ ()

Returns the minimum Z value.

Returns
  • The value.

public 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.

public String getPaletteName ()

Returns the palette name.

Returns
  • The palette name.

public double[] getTickValues ()

Returns the tick values.

Returns
  • The tick values.

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public abstract void initialize ()

Called to initialize the palette's color indexes

public void invertPalette ()

Inverts Palette

public boolean isInverse ()

Returns the inverse flag.

Returns
  • The flag.

public boolean isLogscale ()

Returns the log-scale flag.

Returns
  • The flag.

public boolean isStepped ()

Returns the 'is-stepped' flag.

Returns
  • The flag.

public void setInverse (boolean inverse)

Sets the inverse flag.

Parameters
inverse the new value.

public void setLogscale (boolean logscale)

Sets the 'log-scale' flag.

Parameters
logscale the new value.

public void setMaxZ (double newMaxZ)

Sets the maximum Z value.

Parameters
newMaxZ the new value.

public void setMinZ (double newMinZ)

Sets the minimum Z value.

Parameters
newMinZ the new value.

public void setPaletteName (String paletteName)

Sets the palette name.

Parameters
paletteName the name.

public void setStepped (boolean stepped)

Sets the stepped flag.

Parameters
stepped the flag.

public void setTickValues (double[] newTickValues)

Sets the tick values.

Parameters
newTickValues the tick values.

public void setTickValues (List ticks)

Store ticks. Required when doing stepped axis

Parameters
ticks the ticks.