public class

ColorBar

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.axis.ColorBar

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

A color bar.

Summary

Constants
int DEFAULT_COLORBAR_THICKNESS The default color bar thickness.
double DEFAULT_COLORBAR_THICKNESS_PERCENT The default color bar thickness percentage.
int DEFAULT_OUTERGAP The default outer gap.
Public Constructors
ColorBar(String label)
Constructs a horizontal colorbar axis, using default values where necessary.
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int DEFAULT_COLORBAR_THICKNESS

The default color bar thickness.

Constant Value: 0 (0x00000000)

public static final double DEFAULT_COLORBAR_THICKNESS_PERCENT

The default color bar thickness percentage.

Constant Value: 0.1

public static final int DEFAULT_OUTERGAP

The default outer gap.

Constant Value: 2 (0x00000002)

Public Constructors

public ColorBar (String label)

Constructs a horizontal colorbar axis, using default values where necessary.

Parameters
label the axis label.

Public Methods

public void autoAdjustRange ()

Rescales the axis to ensure that all data are visible.

public Object clone ()

Returns a clone of the object.

Returns
  • A clone.
Throws
CloneNotSupportedException if some component of the color bar does not support cloning.

public void configure (ContourPlot plot)

Configures the color bar.

Parameters
plot the plot.

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.

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.

public boolean equals (Object obj)

Tests this object for equality with another.

Parameters
obj the object to test against.
Returns
  • A boolean.

public ValueAxis getAxis ()

Returns the axis.

Returns
  • The axis.

public ColorPalette getColorPalette ()

Returns the color palette.

Returns
  • The color palette.

public Paint getPaint (double value)

Returns the Paint associated with a value.

Parameters
value the value.
Returns
  • The paint.

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.

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.

public void setAxis (ValueAxis axis)

Sets the axis.

Parameters
axis the axis.

public void setColorPalette (ColorPalette palette)

Sets the color palette.

Parameters
palette the new palette.

public void setMaximumValue (double value)

Sets the maximum value.

Parameters
value the maximum value.

public void setMinimumValue (double value)

Sets the minimum value.

Parameters
value the minimum value.