org.jfree.chart.axis

Class ColorBar

Implemented Interfaces:
Cloneable, Serializable

public class ColorBar
extends java.lang.Object
implements Cloneable, Serializable

A color bar.

Field Summary

static int
DEFAULT_COLORBAR_THICKNESS
The default color bar thickness.
static double
DEFAULT_COLORBAR_THICKNESS_PERCENT
The default color bar thickness percentage.
static int
DEFAULT_OUTERGAP
The default outer gap.

Constructor Summary

ColorBar(String label)
Constructs a horizontal colorbar axis, using default values where necessary.

Method Summary

void
autoAdjustRange()
Rescales the axis to ensure that all data are visible.
Object
clone()
Returns a clone of the object.
void
configure(ContourPlot plot)
Configures the color bar.
double
draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, Rectangle2D reservedArea, RectangleEdge edge)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).
void
drawColorBar(Graphics2D g2, Rectangle2D colorBarArea, RectangleEdge edge)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).
boolean
equals(Object obj)
Tests this object for equality with another.
ValueAxis
getAxis()
Returns the axis.
ColorPalette
getColorPalette()
Returns the color palette.
Paint
getPaint(double value)
Returns the Paint associated with a value.
int
hashCode()
Returns a hash code for this object.
AxisSpace
reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisSpace space)
Reserves the space required to draw the color bar.
void
setAxis(ValueAxis axis)
Sets the axis.
void
setColorPalette(ColorPalette palette)
Sets the color palette.
void
setMaximumValue(double value)
Sets the maximum value.
void
setMinimumValue(double value)
Sets the minimum value.

Field Details

DEFAULT_COLORBAR_THICKNESS

public static final int DEFAULT_COLORBAR_THICKNESS
The default color bar thickness.
Field Value:
0

DEFAULT_COLORBAR_THICKNESS_PERCENT

public static final double DEFAULT_COLORBAR_THICKNESS_PERCENT
The default color bar thickness percentage.
Field Value:
0.0

DEFAULT_OUTERGAP

public static final int DEFAULT_OUTERGAP
The default outer gap.
Field Value:
2

Constructor Details

ColorBar

public ColorBar(String label)
Constructs a horizontal colorbar axis, using default values where necessary.
Parameters:
label - the axis label.

Method Details

autoAdjustRange

public void autoAdjustRange()
Rescales the axis to ensure that all data are visible.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the object.
Returns:
A clone.

configure

public void configure(ContourPlot plot)
Configures the color bar.
Parameters:
plot - the plot.

draw

public double draw(Graphics2D g2,
                   double cursor,
                   Rectangle2D plotArea,
                   Rectangle2D dataArea,
                   Rectangle2D reservedArea,
                   RectangleEdge edge)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).
Parameters:
g2 - the graphics device.
cursor - the cursor.
plotArea - the area within which the chart should be drawn.
dataArea - the area within which the plot should be drawn (a subset of the drawArea).
reservedArea - the reserved area.
edge - the color bar location.
Returns:
The new cursor location.

drawColorBar

public void drawColorBar(Graphics2D g2,
                         Rectangle2D colorBarArea,
                         RectangleEdge edge)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).
Parameters:
g2 - the graphics device.
colorBarArea - the area within which the axis should be drawn.
edge - the location.

equals

public boolean equals(Object obj)
Tests this object for equality with another.
Parameters:
obj - the object to test against.
Returns:
A boolean.

getAxis

public ValueAxis getAxis()
Returns the axis.
Returns:
The axis.

getColorPalette

public ColorPalette getColorPalette()
Returns the color palette.
Returns:
The color palette.

getPaint

public Paint getPaint(double value)
Returns the Paint associated with a value.
Parameters:
value - the value.
Returns:
The paint.

hashCode

public int hashCode()
Returns a hash code for this object.
Returns:
A hash code.

reserveSpace

public AxisSpace reserveSpace(Graphics2D g2,
                              Plot plot,
                              Rectangle2D plotArea,
                              Rectangle2D dataArea,
                              RectangleEdge edge,
                              AxisSpace space)
Reserves the space required to draw the color bar.
Parameters:
g2 - the graphics device.
plot - the plot that the axis belongs to.
plotArea - the area within which the plot should be drawn.
dataArea - the data area.
edge - the axis location.
space - the space already reserved.
Returns:
The space required to draw the axis in the specified plot area.

setAxis

public void setAxis(ValueAxis axis)
Sets the axis.
Parameters:
axis - the axis.

setColorPalette

public void setColorPalette(ColorPalette palette)
Sets the color palette.
Parameters:
palette - the new palette.

setMaximumValue

public void setMaximumValue(double value)
Sets the maximum value.
Parameters:
value - the maximum value.

setMinimumValue

public void setMinimumValue(double value)
Sets the minimum value.
Parameters:
value - the minimum value.