|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.chart.axis.Axis
org.jfree.chart.axis.CategoryAxis
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). |
protected static LogContext |
logger
Access to logging facilities. |
Constructor Summary | |
CategoryAxis()
Creates a new category axis with no label. |
|
CategoryAxis(java.lang.String label)
Constructs a category axis, using default values where necessary. |
Method Summary | |
void |
addCategoryLabelToolTip(java.lang.Comparable category,
java.lang.String tooltip)
Adds a tooltip to the specified category and sends an AxisChangeEvent to all registered listeners. |
protected double |
calculateCategoryGapSize(int categoryCount,
java.awt.geom.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,
java.awt.geom.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,
java.awt.Graphics2D g2)
A utility method for determining the height of a text block. |
protected double |
calculateTextBlockWidth(TextBlock block,
CategoryLabelPosition position,
java.awt.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. |
java.lang.Object |
clone()
Creates a clone of the axis. |
void |
configure()
Configures the axis against the current plot. |
protected TextBlock |
createLabel(java.lang.Comparable category,
float width,
RectangleEdge edge,
java.awt.Graphics2D g2)
Creates a label. |
AxisState |
draw(java.awt.Graphics2D g2,
double cursor,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.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(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea,
RectangleEdge edge,
AxisState state,
PlotRenderingInfo plotState)
Draws the category labels and returns the updated axis state. |
boolean |
equals(java.lang.Object obj)
Tests this axis for equality with an arbitrary object. |
double |
getCategoryEnd(int category,
int categoryCount,
java.awt.geom.Rectangle2D area,
RectangleEdge edge)
Returns the end coordinate for the specified category. |
double |
getCategoryJava2DCoordinate(CategoryAnchor anchor,
int category,
int categoryCount,
java.awt.geom.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). |
double |
getCategoryMargin()
Returns the category margin. |
double |
getCategoryMiddle(int category,
int categoryCount,
java.awt.geom.Rectangle2D area,
RectangleEdge edge)
Returns the middle coordinate for the specified category. |
double |
getCategoryStart(int category,
int categoryCount,
java.awt.geom.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. |
double |
getUpperMargin()
Returns the upper margin for the axis. |
java.util.List |
refreshTicks(java.awt.Graphics2D g2,
AxisState state,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea,
RectangleEdge edge)
Creates a temporary list of ticks that can be used when drawing the axis. |
void |
removeCategoryLabelToolTip(java.lang.Comparable category)
Removes the tooltip for the specified category and sends an AxisChangeEvent to all registered listeners. |
AxisSpace |
reserveSpace(java.awt.Graphics2D g2,
Plot plot,
java.awt.geom.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 |
setUpperMargin(double margin)
Sets the upper margin for the axis and sends an AxisChangeEvent
to all registered listeners. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final double DEFAULT_AXIS_MARGIN
public static final double DEFAULT_CATEGORY_MARGIN
protected static final LogContext logger
Constructor Detail |
public CategoryAxis()
public CategoryAxis(java.lang.String label)
label
- the axis label (null
permitted).Method Detail |
public double getLowerMargin()
public void setLowerMargin(double margin)
AxisChangeEvent
to all registered listeners.
margin
- the margin as a percentage of the axis length (for
example, 0.05 is five percent).public double getUpperMargin()
public void setUpperMargin(double margin)
AxisChangeEvent
to all registered listeners.
margin
- the margin as a percentage of the axis length (for
example, 0.05 is five percent).public double getCategoryMargin()
public void setCategoryMargin(double margin)
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.
margin
- the margin as a percentage of the axis length (for
example, 0.05 is five percent).public int getMaximumCategoryLabelLines()
public void setMaximumCategoryLabelLines(int lines)
AxisChangeEvent
to all registered listeners.
lines
- the maximum number of lines.public float getMaximumCategoryLabelWidthRatio()
public void setMaximumCategoryLabelWidthRatio(float ratio)
AxisChangeEvent
to all registered listeners.
ratio
- the ratio.public int getCategoryLabelPositionOffset()
public void setCategoryLabelPositionOffset(int offset)
offset
- the offset (in Java2D units).public CategoryLabelPositions getCategoryLabelPositions()
null
).public void setCategoryLabelPositions(CategoryLabelPositions positions)
AxisChangeEvent
to all registered listeners.
positions
- the positions (null
not permitted).public void addCategoryLabelToolTip(java.lang.Comparable category, java.lang.String tooltip)
AxisChangeEvent
to all registered listeners.
category
- the category (null not permitted).tooltip
- the tooltip text (null
permitted).
public void removeCategoryLabelToolTip(java.lang.Comparable category)
AxisChangeEvent
to all registered listeners.
category
- the category (null not permitted).
public void clearCategoryLabelToolTips()
AxisChangeEvent
to all registered listeners.
public double getCategoryJava2DCoordinate(CategoryAnchor anchor, int category, int categoryCount, java.awt.geom.Rectangle2D area, RectangleEdge edge)
anchor
- the anchor point.category
- the category index.categoryCount
- the category count.area
- the data area.edge
- the location of the axis.
public double getCategoryStart(int category, int categoryCount, java.awt.geom.Rectangle2D area, RectangleEdge edge)
category
- the category.categoryCount
- the number of categories.area
- the data area.edge
- the axis location.
public double getCategoryMiddle(int category, int categoryCount, java.awt.geom.Rectangle2D area, RectangleEdge edge)
category
- the category.categoryCount
- the number of categories.area
- the data area.edge
- the axis location.
public double getCategoryEnd(int category, int categoryCount, java.awt.geom.Rectangle2D area, RectangleEdge edge)
category
- the category.categoryCount
- the number of categories.area
- the data area.edge
- the axis location.
protected double calculateCategorySize(int categoryCount, java.awt.geom.Rectangle2D area, RectangleEdge edge)
categoryCount
- the number of categories.area
- the area within which the categories will be drawn.edge
- the axis location.
protected double calculateCategoryGapSize(int categoryCount, java.awt.geom.Rectangle2D area, RectangleEdge edge)
categoryCount
- the number of categories.area
- the area within which the categories will be drawn.edge
- the axis location.
public AxisSpace reserveSpace(java.awt.Graphics2D g2, Plot plot, java.awt.geom.Rectangle2D plotArea, RectangleEdge edge, AxisSpace space)
reserveSpace
in class Axis
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.
public void configure()
configure
in class Axis
public AxisState draw(java.awt.Graphics2D g2, double cursor, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState)
draw
in class Axis
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).
null
).protected AxisState drawCategoryLabels(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)
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).
null
).public java.util.List refreshTicks(java.awt.Graphics2D g2, AxisState state, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, RectangleEdge edge)
refreshTicks
in class Axis
g2
- the graphics device (used to get font measurements).state
- the axis state.plotArea
- the area where the plot and axes will be drawn.dataArea
- the area inside the axes.edge
- the location of the axis.
protected TextBlock createLabel(java.lang.Comparable category, float width, RectangleEdge edge, java.awt.Graphics2D g2)
category
- the category.width
- the available width.edge
- the edge on which the axis appears.g2
- the graphics device.
protected double calculateTextBlockWidth(TextBlock block, CategoryLabelPosition position, java.awt.Graphics2D g2)
block
- the text block.position
- the position.g2
- the graphics device.
protected double calculateTextBlockHeight(TextBlock block, CategoryLabelPosition position, java.awt.Graphics2D g2)
block
- the text block.position
- the label position.g2
- the graphics device.
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class Axis
java.lang.CloneNotSupportedException
- if some component of the axis does
not support cloning.public boolean equals(java.lang.Object obj)
equals
in class Axis
obj
- the object (null
permitted).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |