org.jfree.chart.axis

Class SymbolAxis

public class SymbolAxis extends NumberAxis implements Serializable

A standard linear value axis that replaces integer values with symbols.
Field Summary
static PaintDEFAULT_GRID_BAND_PAINT
The default grid band paint.
Constructor Summary
SymbolAxis(String label, String[] sv)
Constructs a symbol axis, using default attribute values where necessary.
Method Summary
protected voidautoAdjustRange()
Rescales the axis to ensure that all data is visible.
AxisStatedraw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState)
Draws the axis on a Java 2D graphics device (such as the screen or a printer).
protected voiddrawGridBands(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, List ticks)
Draws the grid bands.
protected voiddrawGridBandsHorizontal(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, boolean firstGridBandIsDark, List ticks)
Draws the grid bands for the axis when it is at the top or bottom of the plot.
protected voiddrawGridBandsVertical(Graphics2D g2, Rectangle2D drawArea, Rectangle2D plotArea, boolean firstGridBandIsDark, List ticks)
Draws the grid bands for the axis when it is at the top or bottom of the plot.
booleanequals(Object obj)
Tests this axis for equality with an arbitrary object.
PaintgetGridBandPaint()
Returns the paint used to color the grid bands.
String[]getSymbols()
Returns an array of the symbols for the axis.
booleanisGridBandsVisible()
Returns true if the grid bands are showing, and false otherwise.
ListrefreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)
Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
protected ListrefreshTicksHorizontal(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
protected ListrefreshTicksVertical(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
protected voidselectAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
This operation is not supported by this axis.
voidsetGridBandPaint(Paint paint)
Sets the grid band paint and sends an AxisChangeEvent to all registered listeners.
voidsetGridBandsVisible(boolean flag)
Sets the visibility of the grid bands and notifies registered listeners that the axis has been modified.
StringvalueToString(double value)
Converts a value to a string, using the list of symbols.

Field Detail

DEFAULT_GRID_BAND_PAINT

public static final Paint DEFAULT_GRID_BAND_PAINT
The default grid band paint.

Constructor Detail

SymbolAxis

public SymbolAxis(String label, String[] sv)
Constructs a symbol axis, using default attribute values where necessary.

Parameters: label the axis label (null permitted). sv the list of symbols to display instead of the numeric values.

Method Detail

autoAdjustRange

protected void autoAdjustRange()
Rescales the axis to ensure that all data is visible.

draw

public AxisState draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState)
Draws the axis on a Java 2D graphics device (such as the screen or a printer).

Parameters: g2 the graphics device (null not permitted). cursor the cursor location. plotArea the area within which the plot and axes should be drawn (null not permitted). dataArea the area within which the data should be drawn (null not permitted). edge the axis location (null not permitted). plotState collects information about the plot (null permitted).

Returns: The axis state (never null).

drawGridBands

protected void drawGridBands(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, List ticks)
Draws the grid bands. Alternate bands are colored using gridBandPaint (DEFAULT_GRID_BAND_PAINT by default).

Parameters: g2 the graphics device. 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). edge the axis location. ticks the ticks.

drawGridBandsHorizontal

protected void drawGridBandsHorizontal(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, boolean firstGridBandIsDark, List ticks)
Draws the grid bands for the axis when it is at the top or bottom of the plot.

Parameters: g2 the graphics device. 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). firstGridBandIsDark True: the first grid band takes the color of gridBandPaint. False: the second grid band takes the color of gridBandPaint. ticks the ticks.

drawGridBandsVertical

protected void drawGridBandsVertical(Graphics2D g2, Rectangle2D drawArea, Rectangle2D plotArea, boolean firstGridBandIsDark, List ticks)
Draws the grid bands for the axis when it is at the top or bottom of the plot.

Parameters: g2 the graphics device. drawArea the area within which the chart should be drawn. plotArea the area within which the plot should be drawn (a subset of the drawArea). firstGridBandIsDark True: the first grid band takes the color of gridBandPaint. False: the second grid band takes the color of gridBandPaint. ticks a list of ticks.

equals

public boolean equals(Object obj)
Tests this axis for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getGridBandPaint

public Paint getGridBandPaint()
Returns the paint used to color the grid bands.

Returns: The grid band paint (never null).

See Also: setGridBandPaint isGridBandsVisible

getSymbols

public String[] getSymbols()
Returns an array of the symbols for the axis.

Returns: The symbols.

isGridBandsVisible

public boolean isGridBandsVisible()
Returns true if the grid bands are showing, and false otherwise.

Returns: true if the grid bands are showing, and false otherwise.

See Also: SymbolAxis

refreshTicks

public List refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)
Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).

Parameters: g2 the graphics device. state the axis state. dataArea the area in which the data should be drawn. edge the location of the axis.

Returns: A list of ticks.

refreshTicksHorizontal

protected List refreshTicksHorizontal(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).

Parameters: g2 the graphics device. dataArea the area in which the data should be drawn. edge the location of the axis.

Returns: The ticks.

refreshTicksVertical

protected List refreshTicksVertical(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).

Parameters: g2 the graphics device. dataArea the area in which the plot should be drawn. edge the location of the axis.

Returns: The ticks.

selectAutoTickUnit

protected void selectAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
This operation is not supported by this axis.

Parameters: g2 the graphics device. dataArea the area in which the plot and axes should be drawn. edge the edge along which the axis is drawn.

setGridBandPaint

public void setGridBandPaint(Paint paint)
Sets the grid band paint and sends an AxisChangeEvent to all registered listeners.

Parameters: paint the paint (null not permitted).

See Also: getGridBandPaint

setGridBandsVisible

public void setGridBandsVisible(boolean flag)
Sets the visibility of the grid bands and notifies registered listeners that the axis has been modified.

Parameters: flag the new setting.

See Also: isGridBandsVisible

valueToString

public String valueToString(double value)
Converts a value to a string, using the list of symbols.

Parameters: value value to convert.

Returns: The symbol.