Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.axis

Class CategoryAxis

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
CategoryAxis3D, ExtendedCategoryAxis, SubCategoryAxis
public class CategoryAxis
extends Axis
implements Cloneable, Serializable
An axis that displays categories.

Field Summary

static double
DEFAULT_AXIS_MARGIN
The default margin for the axis (used for both lower and upper margins).
static double
DEFAULT_CATEGORY_MARGIN
The default margin between categories (a percentage of the overall axis length).

Fields inherited from class org.jfree.chart.axis.Axis

DEFAULT_AXIS_LABEL_FONT, DEFAULT_AXIS_LABEL_INSETS, DEFAULT_AXIS_LABEL_PAINT, DEFAULT_AXIS_LINE_PAINT, DEFAULT_AXIS_LINE_STROKE, DEFAULT_AXIS_VISIBLE, DEFAULT_TICK_LABELS_VISIBLE, DEFAULT_TICK_LABEL_FONT, DEFAULT_TICK_LABEL_INSETS, DEFAULT_TICK_LABEL_PAINT, DEFAULT_TICK_MARKS_VISIBLE, DEFAULT_TICK_MARK_INSIDE_LENGTH, DEFAULT_TICK_MARK_OUTSIDE_LENGTH, DEFAULT_TICK_MARK_PAINT, DEFAULT_TICK_MARK_STROKE

Constructor Summary

CategoryAxis()
Creates a new category axis with no label.
CategoryAxis(String label)
Constructs a category axis, using default values where necessary.

Method Summary

void
addCategoryLabelToolTip(Comparable category, String tooltip)
Adds a tooltip to the specified category and sends an AxisChangeEvent to all registered listeners.
protected double
calculateCategoryGapSize(int categoryCount, Rectangle2D area, RectangleEdge edge)
Calculates the size (width or height, depending on the location of the axis) of a category gap.
protected double
calculateCategorySize(int categoryCount, Rectangle2D area, RectangleEdge edge)
Calculates the size (width or height, depending on the location of the axis) of a category.
protected double
calculateTextBlockHeight(TextBlock block, CategoryLabelPosition position, Graphics2D g2)
A utility method for determining the height of a text block.
protected double
calculateTextBlockWidth(TextBlock block, CategoryLabelPosition position, Graphics2D g2)
A utility method for determining the width of a text block.
void
clearCategoryLabelToolTips()
Clears the category label tooltips and sends an AxisChangeEvent to all registered listeners.
Object
clone()
Creates a clone of the axis.
void
configure()
Configures the axis against the current plot.
protected TextBlock
createLabel(Comparable category, float width, RectangleEdge edge, Graphics2D g2)
Creates a label.
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).
protected AxisState
drawCategoryLabels(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)
Draws the category labels and returns the updated axis state.
protected AxisState
drawCategoryLabels(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)
Deprecated. Use drawCategoryLabels(Graphics2D,Rectangle2D,Rectangle2D,RectangleEdge,AxisState,PlotRenderingInfo).
boolean
equals(Object obj)
Tests this axis for equality with an arbitrary object.
double
getCategoryEnd(int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the end coordinate for the specified category.
double
getCategoryJava2DCoordinate(CategoryAnchor anchor, int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the Java 2D coordinate for a category.
int
getCategoryLabelPositionOffset()
Returns the offset between the axis and the category labels (before label positioning is taken into account).
CategoryLabelPositions
getCategoryLabelPositions()
Returns the category label position specification (this contains label positioning info for all four possible axis locations).
String
getCategoryLabelToolTip(Comparable category)
Returns the tool tip text for the label belonging to the specified category.
double
getCategoryMargin()
Returns the category margin.
double
getCategoryMiddle(int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the middle coordinate for the specified category.
double
getCategoryStart(int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the starting coordinate for the specified category.
double
getLowerMargin()
Returns the lower margin for the axis.
int
getMaximumCategoryLabelLines()
Returns the maximum number of lines to use for each category label.
float
getMaximumCategoryLabelWidthRatio()
Returns the category label width ratio.
Font
getTickLabelFont(Comparable category)
Returns the font for the tick label for the given category.
Paint
getTickLabelPaint(Comparable category)
Returns the paint for the tick label for the given category.
double
getUpperMargin()
Returns the upper margin for the axis.
int
hashCode()
Returns a hash code for this object.
List
refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)
Creates a temporary list of ticks that can be used when drawing the axis.
void
removeCategoryLabelToolTip(Comparable category)
Removes the tooltip for the specified category and sends an AxisChangeEvent to all registered listeners.
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
setCategoryLabelPositionOffset(int offset)
Sets the offset between the axis and the category labels (before label positioning is taken into account).
void
setCategoryLabelPositions(CategoryLabelPositions positions)
Sets the category label position specification for the axis and sends an AxisChangeEvent to all registered listeners.
void
setCategoryMargin(double margin)
Sets the category margin and sends an AxisChangeEvent to all registered listeners.
void
setLowerMargin(double margin)
Sets the lower margin for the axis and sends an AxisChangeEvent to all registered listeners.
void
setMaximumCategoryLabelLines(int lines)
Sets the maximum number of lines to use for each category label and sends an AxisChangeEvent to all registered listeners.
void
setMaximumCategoryLabelWidthRatio(float ratio)
Sets the maximum category label width ratio and sends an AxisChangeEvent to all registered listeners.
void
setTickLabelFont(Comparable category, Font font)
Sets the font for the tick label for the specified category and sends an AxisChangeEvent to all registered listeners.
void
setTickLabelPaint(Comparable category, Paint paint)
Sets the paint for the tick label for the specified category and sends an AxisChangeEvent to all registered listeners.
void
setUpperMargin(double margin)
Sets the upper margin for the axis and sends an AxisChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.axis.Axis

addChangeListener, clone, configure, draw, drawAxisLine, drawLabel, equals, getAxisLinePaint, getAxisLineStroke, getFixedDimension, getLabel, getLabelAngle, getLabelEnclosure, getLabelFont, getLabelInsets, getLabelPaint, getPlot, getTickLabelFont, getTickLabelInsets, getTickLabelPaint, getTickMarkInsideLength, getTickMarkOutsideLength, getTickMarkPaint, getTickMarkStroke, hasListener, isAxisLineVisible, isTickLabelsVisible, isTickMarksVisible, isVisible, notifyListeners, refreshTicks, removeChangeListener, reserveSpace, setAxisLinePaint, setAxisLineStroke, setAxisLineVisible, setFixedDimension, setLabel, setLabelAngle, setLabelFont, setLabelInsets, setLabelPaint, setPlot, setTickLabelFont, setTickLabelInsets, setTickLabelPaint, setTickLabelsVisible, setTickMarkInsideLength, setTickMarkOutsideLength, setTickMarkPaint, setTickMarkStroke, setTickMarksVisible, setVisible

Field Details

DEFAULT_AXIS_MARGIN

public static final double DEFAULT_AXIS_MARGIN
The default margin for the axis (used for both lower and upper margins).
Field Value:
0.0

DEFAULT_CATEGORY_MARGIN

public static final double DEFAULT_CATEGORY_MARGIN
The default margin between categories (a percentage of the overall axis length).
Field Value:
0.0

Constructor Details

CategoryAxis

public CategoryAxis()
Creates a new category axis with no label.

CategoryAxis

public CategoryAxis(String label)
Constructs a category axis, using default values where necessary.
Parameters:
label - the axis label (null permitted).

Method Details

addCategoryLabelToolTip

public void addCategoryLabelToolTip(Comparable category,
                                    String tooltip)
Adds a tooltip to the specified category and sends an AxisChangeEvent to all registered listeners.
Parameters:
category - the category (null not permitted).
tooltip - the tooltip text (null permitted).
See Also:
removeCategoryLabelToolTip(Comparable)

calculateCategoryGapSize

protected double calculateCategoryGapSize(int categoryCount,
                                          Rectangle2D area,
                                          RectangleEdge edge)
Calculates the size (width or height, depending on the location of the axis) of a category gap.
Parameters:
categoryCount - the number of categories.
area - the area within which the categories will be drawn.
edge - the axis location.
Returns:
The category gap width.

calculateCategorySize

protected double calculateCategorySize(int categoryCount,
                                       Rectangle2D area,
                                       RectangleEdge edge)
Calculates the size (width or height, depending on the location of the axis) of a category.
Parameters:
categoryCount - the number of categories.
area - the area within which the categories will be drawn.
edge - the axis location.
Returns:
The category size.

calculateTextBlockHeight

protected double calculateTextBlockHeight(TextBlock block,
                                          CategoryLabelPosition position,
                                          Graphics2D g2)
A utility method for determining the height of a text block.
Parameters:
block - the text block.
position - the label position.
g2 - the graphics device.
Returns:
The height.

calculateTextBlockWidth

protected double calculateTextBlockWidth(TextBlock block,
                                         CategoryLabelPosition position,
                                         Graphics2D g2)
A utility method for determining the width of a text block.
Parameters:
block - the text block.
position - the position.
g2 - the graphics device.
Returns:
The width.

clearCategoryLabelToolTips

public void clearCategoryLabelToolTips()
Clears the category label tooltips and sends an AxisChangeEvent to all registered listeners.
See Also:
addCategoryLabelToolTip(Comparable,String), removeCategoryLabelToolTip(Comparable)

clone

public Object clone()
            throws CloneNotSupportedException
Creates a clone of the axis.
Overrides:
clone in interface Axis
Returns:
A clone.

configure

public void configure()
Configures the axis against the current plot.
Overrides:
configure in interface Axis

createLabel

protected TextBlock createLabel(Comparable category,
                                float width,
                                RectangleEdge edge,
                                Graphics2D g2)
Creates a label.
Parameters:
category - the category.
width - the available width.
edge - the edge on which the axis appears.
g2 - the graphics device.
Returns:
A label.

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).
Overrides:
draw in interface Axis
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).

drawCategoryLabels

protected AxisState drawCategoryLabels(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).

drawCategoryLabels

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

Deprecated. Use drawCategoryLabels(Graphics2D,Rectangle2D,Rectangle2D,RectangleEdge,AxisState,PlotRenderingInfo).

Draws the category labels and returns the updated axis state.
Parameters:
g2 - the graphics device (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).

equals

public boolean equals(Object obj)
Tests this axis for equality with an arbitrary object.
Overrides:
equals in interface Axis
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getCategoryEnd

public double getCategoryEnd(int category,
                             int categoryCount,
                             Rectangle2D area,
                             RectangleEdge edge)
Returns the end coordinate for the specified category.
Parameters:
category - the category.
categoryCount - the number of categories.
area - the data area.
edge - the axis location.
Returns:
The coordinate.
See Also:
getCategoryStart(int,int,Rectangle2D,RectangleEdge), getCategoryMiddle(int,int,Rectangle2D,RectangleEdge)

getCategoryJava2DCoordinate

public double getCategoryJava2DCoordinate(CategoryAnchor anchor,
                                          int category,
                                          int categoryCount,
                                          Rectangle2D area,
                                          RectangleEdge edge)
Returns the Java 2D coordinate for a category.
Parameters:
anchor - the anchor point.
category - the category index.
categoryCount - the category count.
area - the data area.
edge - the location of the axis.
Returns:
The coordinate.

getCategoryLabelPositionOffset

public int getCategoryLabelPositionOffset()
Returns the offset between the axis and the category labels (before label positioning is taken into account).
Returns:
The offset (in Java2D units).
See Also:
setCategoryLabelPositionOffset(int)

getCategoryLabelPositions

public CategoryLabelPositions getCategoryLabelPositions()
Returns the category label position specification (this contains label positioning info for all four possible axis locations).
Returns:
The positions (never null).
See Also:
setCategoryLabelPositions(CategoryLabelPositions)

getCategoryLabelToolTip

public String getCategoryLabelToolTip(Comparable category)
Returns the tool tip text for the label belonging to the specified category.
Parameters:
category - the category (null not permitted).
Returns:
The tool tip text (possibly null).
See Also:
addCategoryLabelToolTip(Comparable,String), removeCategoryLabelToolTip(Comparable)

getCategoryMargin

public double getCategoryMargin()
Returns the category margin.
Returns:
The margin.
See Also:
setCategoryMargin(double)

getCategoryMiddle

public double getCategoryMiddle(int category,
                                int categoryCount,
                                Rectangle2D area,
                                RectangleEdge edge)
Returns the middle coordinate for the specified category.
Parameters:
category - the category.
categoryCount - the number of categories.
area - the data area.
edge - the axis location.
Returns:
The coordinate.
See Also:
getCategoryStart(int,int,Rectangle2D,RectangleEdge), getCategoryEnd(int,int,Rectangle2D,RectangleEdge)

getCategoryStart

public double getCategoryStart(int category,
                               int categoryCount,
                               Rectangle2D area,
                               RectangleEdge edge)
Returns the starting coordinate for the specified category.
Parameters:
category - the category.
categoryCount - the number of categories.
area - the data area.
edge - the axis location.
Returns:
The coordinate.
See Also:
getCategoryMiddle(int,int,Rectangle2D,RectangleEdge), getCategoryEnd(int,int,Rectangle2D,RectangleEdge)

getLowerMargin

public double getLowerMargin()
Returns the lower margin for the axis.
Returns:
The margin.
See Also:
getUpperMargin(), setLowerMargin(double)

getMaximumCategoryLabelLines

public int getMaximumCategoryLabelLines()
Returns the maximum number of lines to use for each category label.
Returns:
The maximum number of lines.
See Also:
setMaximumCategoryLabelLines(int)

getMaximumCategoryLabelWidthRatio

public float getMaximumCategoryLabelWidthRatio()
Returns the category label width ratio.
Returns:
The ratio.
See Also:
setMaximumCategoryLabelWidthRatio(float)

getTickLabelFont

public Font getTickLabelFont(Comparable category)
Returns the font for the tick label for the given category.
Parameters:
category - the category (null not permitted).
Returns:
The font (never null).
See Also:
setTickLabelFont(Comparable,Font)

getTickLabelPaint

public Paint getTickLabelPaint(Comparable category)
Returns the paint for the tick label for the given category.
Parameters:
category - the category (null not permitted).
Returns:
The paint (never null).
See Also:
setTickLabelPaint(Paint)

getUpperMargin

public double getUpperMargin()
Returns the upper margin for the axis.
Returns:
The margin.
See Also:
getLowerMargin(), setUpperMargin(double)

hashCode

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

refreshTicks

public List refreshTicks(Graphics2D g2,
                         AxisState state,
                         Rectangle2D dataArea,
                         RectangleEdge edge)
Creates a temporary list of ticks that can be used when drawing the axis.
Overrides:
refreshTicks in interface Axis
Parameters:
g2 - the graphics device (used to get font measurements).
state - the axis state.
dataArea - the area inside the axes.
edge - the location of the axis.
Returns:
A list of ticks.

removeCategoryLabelToolTip

public void removeCategoryLabelToolTip(Comparable category)
Removes the tooltip for the specified category and sends an AxisChangeEvent to all registered listeners.
Parameters:
category - the category (null not permitted).
See Also:
addCategoryLabelToolTip(Comparable,String), clearCategoryLabelToolTips()

reserveSpace

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.
Overrides:
reserveSpace in interface Axis
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.

setCategoryLabelPositionOffset

public void setCategoryLabelPositionOffset(int offset)
Sets the offset between the axis and the category labels (before label positioning is taken into account).
Parameters:
offset - the offset (in Java2D units).
See Also:
getCategoryLabelPositionOffset()

setCategoryLabelPositions

public void setCategoryLabelPositions(CategoryLabelPositions positions)
Sets the category label position specification for the axis and sends an AxisChangeEvent to all registered listeners.
Parameters:
positions - the positions (null not permitted).
See Also:
getCategoryLabelPositions()

setCategoryMargin

public void setCategoryMargin(double margin)
Sets the category margin and sends an AxisChangeEvent to all registered listeners. The overall category margin is distributed over N-1 gaps, where N is the number of categories on the axis.
Parameters:
margin - the margin as a percentage of the axis length (for example, 0.05 is five percent).
See Also:
getCategoryMargin()

setLowerMargin

public void setLowerMargin(double margin)
Sets the lower margin for the axis and sends an AxisChangeEvent to all registered listeners.
Parameters:
margin - the margin as a percentage of the axis length (for example, 0.05 is five percent).
See Also:
getLowerMargin()

setMaximumCategoryLabelLines

public void setMaximumCategoryLabelLines(int lines)
Sets the maximum number of lines to use for each category label and sends an AxisChangeEvent to all registered listeners.
Parameters:
lines - the maximum number of lines.
See Also:
getMaximumCategoryLabelLines()

setMaximumCategoryLabelWidthRatio

public void setMaximumCategoryLabelWidthRatio(float ratio)
Sets the maximum category label width ratio and sends an AxisChangeEvent to all registered listeners.
Parameters:
ratio - the ratio.
See Also:
getMaximumCategoryLabelWidthRatio()

setTickLabelFont

public void setTickLabelFont(Comparable category,
                             Font font)
Sets the font for the tick label for the specified category and sends an AxisChangeEvent to all registered listeners.
Parameters:
category - the category (null not permitted).
font - the font (null permitted).
See Also:
getTickLabelFont(Comparable)

setTickLabelPaint

public void setTickLabelPaint(Comparable category,
                              Paint paint)
Sets the paint for the tick label for the specified category and sends an AxisChangeEvent to all registered listeners.
Parameters:
category - the category (null not permitted).
paint - the paint (null permitted).
See Also:
getTickLabelPaint(Comparable)

setUpperMargin

public void setUpperMargin(double margin)
Sets the upper margin for the axis and sends an AxisChangeEvent to all registered listeners.
Parameters:
margin - the margin as a percentage of the axis length (for example, 0.05 is five percent).
See Also:
getUpperMargin()

Overview Package Class Use Source Tree Index Deprecated About