public class

SubCategoryAxis

extends CategoryAxis
implements Serializable Cloneable

java.lang.Object
↳	org.jfree.chart.axis.Axis
	↳	org.jfree.chart.axis.CategoryAxis
		↳	org.jfree.chart.axis.SubCategoryAxis

Class Overview

A specialised category axis that can display sub-categories.

Summary

[Expand]

Inherited Constants

From class org.jfree.chart.axis.CategoryAxis

From class org.jfree.chart.axis.Axis

[Expand]

Inherited Fields

From class org.jfree.chart.axis.Axis

Public Constructors
	SubCategoryAxis(String label) Creates a new axis.

Public Methods
void	addSubCategory(Comparable subCategory) Adds a sub-category to the axis and sends an `AxisChangeEvent` to all registered listeners.
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).
boolean	equals(Object obj) Tests the axis for equality with an arbitrary object.
Font	getSubLabelFont() Returns the font used to display the sub-category labels.
Paint	getSubLabelPaint() Returns the paint used to display the sub-category labels.
AxisSpace	reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space) Estimates the space required for the axis, given a specific drawing area.
void	setSubLabelFont(Font font) Sets the font used to display the sub-category labels and sends an `AxisChangeEvent` to all registered listeners.
void	setSubLabelPaint(Paint paint) Sets the paint used to display the sub-category labels and sends an `AxisChangeEvent` to all registered listeners.

Protected Methods
AxisState	drawSubCategoryLabels(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState) Draws the category labels and returns the updated axis state.

[Expand]

Inherited Methods

From class org.jfree.chart.axis.CategoryAxis

From class org.jfree.chart.axis.Axis

void	addChangeListener(AxisChangeListener listener) Registers an object for notification of changes to the axis.
Object	clone() Returns a clone of the axis.
abstract void	configure() Configures the axis to work with the current plot.
void	createAndAddEntity(double cursor, AxisState state, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState) Created an entity for the axis.
abstract 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).
void	drawAxisLine(Graphics2D g2, double cursor, Rectangle2D dataArea, RectangleEdge edge) Draws an axis line at the current cursor position and edge.
AxisState	drawLabel(String label, Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state) Draws the axis label.
boolean	equals(Object obj) Tests this axis for equality with another object.
void	fireChangeEvent() Sends an `AxisChangeEvent` to all registered listeners.
Paint	getAxisLinePaint() Returns the paint used to draw the axis line.
Stroke	getAxisLineStroke() Returns the stroke used to draw the axis line.
double	getFixedDimension() Returns the fixed dimension for the axis.
String	getLabel() Returns the label for the axis.
double	getLabelAngle() Returns the angle of the axis label.
Rectangle2D	getLabelEnclosure(Graphics2D g2, RectangleEdge edge) Returns a rectangle that encloses the axis label.
Font	getLabelFont() Returns the font for the axis label.
RectangleInsets	getLabelInsets() Returns the insets for the label (that is, the amount of blank space that should be left around the label).
Paint	getLabelPaint() Returns the color/shade used to draw the axis label.
float	getMinorTickMarkInsideLength() Returns the inside length of the minor tick marks.
float	getMinorTickMarkOutsideLength() Returns the outside length of the minor tick marks.
Plot	getPlot() Returns the plot that the axis is assigned to.
Font	getTickLabelFont() Returns the font used for the tick labels (if showing).
RectangleInsets	getTickLabelInsets() Returns the insets for the tick labels.
Paint	getTickLabelPaint() Returns the color/shade used for the tick labels.
float	getTickMarkInsideLength() Returns the inside length of the tick marks.
float	getTickMarkOutsideLength() Returns the outside length of the tick marks.
Paint	getTickMarkPaint() Returns the paint used to draw tick marks (if they are showing).
Stroke	getTickMarkStroke() Returns the stroke used to draw tick marks.
boolean	hasListener(EventListener listener) Returns `true` if the specified object is registered with the dataset as a listener.
boolean	isAxisLineVisible() A flag that controls whether or not the axis line is drawn.
boolean	isMinorTickMarksVisible() Returns the flag that indicates whether or not the minor tick marks are showing.
boolean	isTickLabelsVisible() Returns a flag indicating whether or not the tick labels are visible.
boolean	isTickMarksVisible() Returns the flag that indicates whether or not the tick marks are showing.
boolean	isVisible() Returns `true` if the axis is visible, and `false` otherwise.
void	notifyListeners(AxisChangeEvent event) Notifies all registered listeners that the axis has changed.
abstract List	refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge) Calculates the positions of the ticks for the axis, storing the results in the tick list (ready for drawing).
void	removeChangeListener(AxisChangeListener listener) Deregisters an object for notification of changes to the axis.
abstract AxisSpace	reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space) Estimates the space (height or width) required to draw the axis.
void	setAxisLinePaint(Paint paint) Sets the paint used to draw the axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setAxisLineStroke(Stroke stroke) Sets the stroke used to draw the axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setAxisLineVisible(boolean visible) Sets a flag that controls whether or not the axis line is visible and sends an `AxisChangeEvent` to all registered listeners.
void	setFixedDimension(double dimension) Sets the fixed dimension for the axis.
void	setLabel(String label) Sets the label for the axis and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelAngle(double angle) Sets the angle for the label and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelFont(Font font) Sets the font for the axis label and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelInsets(RectangleInsets insets) Sets the insets for the axis label, and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelInsets(RectangleInsets insets, boolean notify) Sets the insets for the axis label, and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelPaint(Paint paint) Sets the paint used to draw the axis label and sends an `AxisChangeEvent` to all registered listeners.
void	setMinorTickMarkInsideLength(float length) Sets the inside length of the minor tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setMinorTickMarkOutsideLength(float length) Sets the outside length of the minor tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setMinorTickMarksVisible(boolean flag) Sets the flag that indicates whether or not the minor tick marks are showing and sends an `AxisChangeEvent` to all registered listeners.
void	setPlot(Plot plot) Sets a reference to the plot that the axis is assigned to.
void	setTickLabelFont(Font font) Sets the font for the tick labels and sends an `AxisChangeEvent` to all registered listeners.
void	setTickLabelInsets(RectangleInsets insets) Sets the insets for the tick labels and sends an `AxisChangeEvent` to all registered listeners.
void	setTickLabelPaint(Paint paint) Sets the paint used to draw tick labels (if they are showing) and sends an `AxisChangeEvent` to all registered listeners.
void	setTickLabelsVisible(boolean flag) Sets the flag that determines whether or not the tick labels are visible and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkInsideLength(float length) Sets the inside length of the tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkOutsideLength(float length) Sets the outside length of the tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkPaint(Paint paint) Sets the paint used to draw tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkStroke(Stroke stroke) Sets the stroke used to draw tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarksVisible(boolean flag) Sets the flag that indicates whether or not the tick marks are showing and sends an `AxisChangeEvent` to all registered listeners.
void	setVisible(boolean flag) Sets a flag that controls whether or not the axis is visible and sends an `AxisChangeEvent` to all registered listeners.

From class java.lang.Object

Public Constructors

public SubCategoryAxis (String label)

Creates a new axis.

Parameters

label	the axis label.

Public Methods

public void addSubCategory (Comparable subCategory)

Adds a sub-category to the axis and sends an AxisChangeEvent to all registered listeners.

Parameters

subCategory	the sub-category (`null` not permitted).

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 axis should be drawn (`null` not permitted).
dataArea	the area within which the plot is being drawn (`null` not permitted).
edge	the location of the axis (`null` not permitted).
plotState	collects information about the plot (`null` permitted).

Returns

The axis state (never null).

public boolean equals (Object obj)

Tests the axis for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

public Font getSubLabelFont ()

Returns the font used to display the sub-category labels.

Returns

The font (never null).

public Paint getSubLabelPaint ()

Returns the paint used to display the sub-category labels.

Returns

The paint (never null).

public AxisSpace reserveSpace (Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space)

Estimates the space required for the axis, given a specific drawing area.

Parameters

g2	the graphics device (used to obtain font information).
plot	the plot that the axis belongs to.
plotArea	the area within which the axis should be drawn.
edge	the axis location (top or bottom).
space	the space already reserved.

Returns

The space required to draw the axis.

public void setSubLabelFont (Font font)

Sets the font used to display the sub-category labels and sends an AxisChangeEvent to all registered listeners.

Parameters

font	the font (`null` not permitted).

public void setSubLabelPaint (Paint paint)

Sets the paint used to display the sub-category labels and sends an AxisChangeEvent to all registered listeners.

Parameters

paint	the paint (`null` not permitted).

Protected Methods

protected AxisState drawSubCategoryLabels (Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)

Draws the category labels and returns the updated axis state.

Parameters

g2	the graphics device (`null` not permitted).
plotArea	the plot area (`null` not permitted).
dataArea	the area inside the axes (`null` not permitted).
edge	the axis location (`null` not permitted).
state	the axis state (`null` not permitted).
plotState	collects information about the plot (`null` permitted).

Returns

The updated axis state (never null).

Interfaces

Classes

SubCategoryAxis

Class Overview

Summary

Public Constructors

public SubCategoryAxis (String label)

Parameters

Public Methods

public void addSubCategory (Comparable subCategory)

Parameters

public AxisState draw (Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState)

Parameters

Returns

public boolean equals (Object obj)

Parameters

Returns

public Font getSubLabelFont ()

Returns

See Also

public Paint getSubLabelPaint ()

Returns

See Also

public AxisSpace reserveSpace (Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space)

Parameters

Returns

public void setSubLabelFont (Font font)

Parameters

See Also

public void setSubLabelPaint (Paint paint)

Parameters

See Also

Protected Methods

protected AxisState drawSubCategoryLabels (Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)

Parameters

Returns