org.jfree.chart.axis
public class CategoryAxis extends Axis implements Cloneable, Serializable
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). |
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 dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)
Draws the category labels and returns the updated axis state.
|
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.
|
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 | getCategorySeriesMiddle(Comparable category, Comparable seriesKey, CategoryDataset dataset, double itemMargin, Rectangle2D area, RectangleEdge edge)
Returns the middle coordinate (in Java2D space) for a series within a
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.
|
Parameters: label the axis label (null
permitted).
Parameters: category the category (null
tooltip the tooltip text ( not permitted).
null
permitted).
See Also: removeCategoryLabelToolTip
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.
Parameters: categoryCount the number of categories. area the area within which the categories will be drawn. edge the axis location.
Returns: The category size.
Parameters: block the text block. position the label position. g2 the graphics device.
Returns: The height.
Parameters: block the text block. position the position. g2 the graphics device.
Returns: The width.
See Also: CategoryAxis removeCategoryLabelToolTip
Returns: A clone.
Throws: CloneNotSupportedException if some component of the axis does not support cloning.
Parameters: category the category. width the available width. edge the edge on which the axis appears. g2 the graphics device.
Returns: A label.
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
).
Deprecated: Use CategoryAxis.
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
).
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
).
Parameters: obj the object (null
permitted).
Returns: A boolean.
Parameters: category the category. categoryCount the number of categories. area the data area. edge the axis location.
Returns: The coordinate.
See Also: CategoryAxis CategoryAxis
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.
Returns: The offset (in Java2D units).
See Also: CategoryAxis
Returns: The positions (never null
).
See Also: setCategoryLabelPositions
Parameters: category the category (null
not permitted).
Returns: The tool tip text (possibly null
).
See Also: CategoryAxis removeCategoryLabelToolTip
Returns: The margin.
See Also: CategoryAxis
Parameters: category the category. categoryCount the number of categories. area the data area. edge the axis location.
Returns: The coordinate.
See Also: CategoryAxis CategoryAxis
Parameters: category the category (null
not permitted). seriesKey the series key (null
not permitted). dataset the dataset (null
not permitted). itemMargin the item margin (0.0 <= itemMargin < 1.0); area the area (null
not permitted). edge the edge (null
not permitted).
Returns: The coordinate in Java2D space.
Since: 1.0.7
Parameters: category the category. categoryCount the number of categories. area the data area. edge the axis location.
Returns: The coordinate.
See Also: CategoryAxis CategoryAxis
Returns: The margin.
See Also: getUpperMargin CategoryAxis
Returns: The maximum number of lines.
See Also: CategoryAxis
Returns: The ratio.
See Also: CategoryAxis
Parameters: category the category (null
not permitted).
Returns: The font (never null
).
See Also: CategoryAxis
Parameters: category the category (null
not permitted).
Returns: The paint (never null
).
See Also: CategoryAxis
Returns: The margin.
See Also: getLowerMargin CategoryAxis
Returns: A hash code.
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.
Parameters: category the category (null
not permitted).
See Also: CategoryAxis clearCategoryLabelToolTips
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.
Parameters: offset the offset (in Java2D units).
See Also: getCategoryLabelPositionOffset
Parameters: positions the positions (null
not permitted).
See Also: getCategoryLabelPositions
Parameters: margin the margin as a percentage of the axis length (for example, 0.05 is five percent).
See Also: getCategoryMargin
Parameters: margin the margin as a percentage of the axis length (for example, 0.05 is five percent).
See Also: getLowerMargin
Parameters: lines the maximum number of lines.
See Also: getMaximumCategoryLabelLines
Parameters: ratio the ratio.
See Also: getMaximumCategoryLabelWidthRatio
Parameters: category the category (null
not permitted). font the font (null
permitted).
See Also: getTickLabelFont
Parameters: category the category (null
not permitted). paint the paint (null
permitted).
See Also: getTickLabelPaint
Parameters: margin the margin as a percentage of the axis length (for example, 0.05 is five percent).
See Also: getUpperMargin