| java.lang.Object
 org.jfree.chart.axis.Axis
org.jfree.chart.axis.CategoryAxis
All known Subclasses: org.jfree.chart.axis.CategoryAxis3D, org.jfree.chart.axis.SubCategoryAxis, org.jfree.chart.axis.ExtendedCategoryAxis,
| Field Summary | |
| final public static double | DEFAULT_AXIS_MARGIN
The default margin for the axis (used for both lower and upper margins). | | final public static double | DEFAULT_CATEGORY_MARGIN
The default margin between categories (a percentage of the overall axis
length). |
| Constructor Summary | |
| public | CategoryAxis()
Creates a new category axis with no label. | | public | CategoryAxis(String label)
Constructs a category axis, using default values where necessary. |
| Method Summary | |
| public 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.
Parameters:
categoryCount - the number of categories.
Parameters:
area - the area within which the categories will be drawn.
Parameters:
edge - the axis location. | | 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.
Parameters:
area - the area within which the categories will be drawn.
Parameters:
edge - the axis location. | | 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.
Parameters:
position - the label position.
Parameters:
g2 - the graphics device. | | 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.
Parameters:
position - the position.
Parameters:
g2 - the graphics device. | | public void | clearCategoryLabelToolTips()
Clears the category label tooltips and sends an
AxisChangeEvent
to all registered listeners. | | public Object | clone()
Creates a clone of the axis. | | public void | configure()
Configures the axis against the current plot. | | protected TextBlock | createLabel(Comparable category, float width, RectangleEdge edge, Graphics2D g2)
Creates a label.
Parameters:
category - the category.
Parameters:
width - the available width. | | 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).
Parameters:
cursor - the cursor location.
Parameters:
plotArea - the area within which the axis should be drawn (null not permitted).
Parameters:
dataArea - the area within which the plot is being drawn (null not permitted).
Parameters:
edge - the location of the axis (null not permitted).
Parameters:
plotState - collects information about the plot (null permitted). | | protected AxisState | drawCategoryLabels(Graphics2D g2, 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).
Parameters:
dataArea - the area inside the axes (null not permitted).
Parameters:
edge - the axis location (null not permitted).
Parameters:
state - the axis state (null not permitted).
Parameters:
plotState - collects information about the plot (nullpermitted). | | 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).
Parameters:
plotArea - the plot area (null not permitted).
Parameters:
dataArea - the area inside the axes (null not permitted).
Parameters:
edge - the axis location (null not permitted).
Parameters:
state - the axis state (null not permitted).
Parameters:
plotState - collects information about the plot (nullpermitted). | | public boolean | equals(Object obj)
Tests this axis for equality with an arbitrary object.
Parameters:
obj - the object (null permitted). | | public double | getCategoryEnd(int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the end coordinate for the specified category.
Parameters:
category - the category.
Parameters:
categoryCount - the number of categories.
Parameters:
area - the data area.
Parameters:
edge - the axis location. | | 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.
Parameters:
category - the category index.
Parameters:
categoryCount - the category count.
Parameters:
area - the data area.
Parameters:
edge - the location of the axis. | | public int | getCategoryLabelPositionOffset()
Returns the offset between the axis and the category labels (before
label positioning is taken into account). | | public CategoryLabelPositions | getCategoryLabelPositions()
Returns the category label position specification (this contains label
positioning info for all four possible axis locations). | | 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). | | public double | getCategoryMargin()
Returns the category margin. | | public double | getCategoryMiddle(int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the middle coordinate for the specified category.
Parameters:
category - the category.
Parameters:
categoryCount - the number of categories.
Parameters:
area - the data area.
Parameters:
edge - the axis location. | | public double | getCategoryStart(int category, int categoryCount, Rectangle2D area, RectangleEdge edge)
Returns the starting coordinate for the specified category.
Parameters:
category - the category.
Parameters:
categoryCount - the number of categories.
Parameters:
area - the data area.
Parameters:
edge - the axis location. | | public double | getLowerMargin()
Returns the lower margin for the axis. | | public int | getMaximumCategoryLabelLines()
Returns the maximum number of lines to use for each category label. | | public float | getMaximumCategoryLabelWidthRatio()
Returns the category label width ratio. | | public Font | getTickLabelFont(Comparable category)
Returns the font for the tick label for the given category.
Parameters:
category - the category (null not permitted). | | public Paint | getTickLabelPaint(Comparable category)
Returns the paint for the tick label for the given category.
Parameters:
category - the category (null not permitted). | | public double | getUpperMargin()
Returns the upper margin for the axis. | | public int | hashCode()
Returns a hash code for this object. | | 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.
Parameters:
g2 - the graphics device (used to get font measurements).
Parameters:
state - the axis state.
Parameters:
dataArea - the area inside the axes.
Parameters:
edge - the location of the axis. | | public void | removeCategoryLabelToolTip(Comparable category)
Removes the tooltip for the specified category and sends an
AxisChangeEvent to all registered listeners. | | 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).
Parameters:
plot - the plot that the axis belongs to.
Parameters:
plotArea - the area within which the axis should be drawn.
Parameters:
edge - the axis location (top or bottom).
Parameters:
space - the space already reserved. | | public void | setCategoryLabelPositionOffset(int offset)
Sets the offset between the axis and the category labels (before label
positioning is taken into account). | | public void | setCategoryLabelPositions(CategoryLabelPositions positions)
Sets the category label position specification for the axis and sends an
AxisChangeEvent to all registered listeners. | | public void | setCategoryMargin(double margin)
Sets the category margin and sends an
AxisChangeEvent to all
registered listeners. | | public void | setLowerMargin(double margin)
Sets the lower margin for the axis and sends an
AxisChangeEvent
to all registered listeners. | | 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. | | public void | setMaximumCategoryLabelWidthRatio(float ratio)
Sets the maximum category label width ratio and sends an
AxisChangeEvent to all registered listeners. | | 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. | | 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. | | public void | setUpperMargin(double margin)
Sets the upper margin for the axis and sends an
AxisChangeEvent to all registered listeners. |
| DEFAULT_AXIS_MARGIN | | final public static double DEFAULT_AXIS_MARGIN(Code) | | The default margin for the axis (used for both lower and upper margins).
|
| DEFAULT_CATEGORY_MARGIN | | final public static double DEFAULT_CATEGORY_MARGIN(Code) | | The default margin between categories (a percentage of the overall axis
length).
|
| CategoryAxis | | public CategoryAxis()(Code) | | Creates a new category axis with no label.
|
| CategoryAxis | | public CategoryAxis(String label)(Code) | | Constructs a category axis, using default values where necessary.
Parameters:
label - the axis label (null permitted). |
| calculateCategoryGapSize | | protected double calculateCategoryGapSize(int categoryCount, Rectangle2D area, RectangleEdge edge)(Code) | | Calculates the size (width or height, depending on the location of the
axis) of a category gap.
Parameters:
categoryCount - the number of categories.
Parameters:
area - the area within which the categories will be drawn.
Parameters:
edge - the axis location. The category gap width. |
| calculateCategorySize | | protected double calculateCategorySize(int categoryCount, Rectangle2D area, RectangleEdge edge)(Code) | | Calculates the size (width or height, depending on the location of the
axis) of a category.
Parameters:
categoryCount - the number of categories.
Parameters:
area - the area within which the categories will be drawn.
Parameters:
edge - the axis location. The category size. |
| calculateTextBlockHeight | | protected double calculateTextBlockHeight(TextBlock block, CategoryLabelPosition position, Graphics2D g2)(Code) | | A utility method for determining the height of a text block.
Parameters:
block - the text block.
Parameters:
position - the label position.
Parameters:
g2 - the graphics device. The height. |
| calculateTextBlockWidth | | protected double calculateTextBlockWidth(TextBlock block, CategoryLabelPosition position, Graphics2D g2)(Code) | | A utility method for determining the width of a text block.
Parameters:
block - the text block.
Parameters:
position - the position.
Parameters:
g2 - the graphics device. The width. |
| configure | | public void configure()(Code) | | Configures the axis against the current plot.
|
| createLabel | | protected TextBlock createLabel(Comparable category, float width, RectangleEdge edge, Graphics2D g2)(Code) | | Creates a label.
Parameters:
category - the category.
Parameters:
width - the available width.
Parameters:
edge - the edge on which the axis appears.
Parameters:
g2 - the graphics device. A label. |
| draw | | public AxisState draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState)(Code) | | Draws the axis on a Java 2D graphics device (such as the screen or a
printer).
Parameters:
g2 - the graphics device (null not permitted).
Parameters:
cursor - the cursor location.
Parameters:
plotArea - the area within which the axis should be drawn (null not permitted).
Parameters:
dataArea - the area within which the plot is being drawn (null not permitted).
Parameters:
edge - the location of the axis (null not permitted).
Parameters:
plotState - collects information about the plot (null permitted). The axis state (never null). |
| drawCategoryLabels | | protected AxisState drawCategoryLabels(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state, PlotRenderingInfo plotState)(Code) | | Draws the category labels and returns the updated axis state.
Parameters:
g2 - the graphics device (null not permitted).
Parameters:
plotArea - the plot area (null not permitted).
Parameters:
dataArea - the area inside the axes (null not permitted).
Parameters:
edge - the axis location (null not permitted).
Parameters:
state - the axis state (null not permitted).
Parameters:
plotState - collects information about the plot (nullpermitted). The updated axis state (never null). |
| equals | | public boolean equals(Object obj)(Code) | | Tests this axis for equality with an arbitrary object.
Parameters:
obj - the object (null permitted). A boolean. |
| getCategoryJava2DCoordinate | | public double getCategoryJava2DCoordinate(CategoryAnchor anchor, int category, int categoryCount, Rectangle2D area, RectangleEdge edge)(Code) | | Returns the Java 2D coordinate for a category.
Parameters:
anchor - the anchor point.
Parameters:
category - the category index.
Parameters:
categoryCount - the category count.
Parameters:
area - the data area.
Parameters:
edge - the location of the axis. The coordinate. |
| getCategoryLabelPositionOffset | | public int getCategoryLabelPositionOffset()(Code) | | Returns the offset between the axis and the category labels (before
label positioning is taken into account).
The offset (in Java2D units).
See Also: CategoryAxis.setCategoryLabelPositionOffset(int) |
| hashCode | | public int hashCode()(Code) | | Returns a hash code for this object.
A hash code. |
| refreshTicks | | public List refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)(Code) | | Creates a temporary list of ticks that can be used when drawing the axis.
Parameters:
g2 - the graphics device (used to get font measurements).
Parameters:
state - the axis state.
Parameters:
dataArea - the area inside the axes.
Parameters:
edge - the location of the axis. A list of ticks. |
| reserveSpace | | public AxisSpace reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space)(Code) | | Estimates the space required for the axis, given a specific drawing area.
Parameters:
g2 - the graphics device (used to obtain font information).
Parameters:
plot - the plot that the axis belongs to.
Parameters:
plotArea - the area within which the axis should be drawn.
Parameters:
edge - the axis location (top or bottom).
Parameters:
space - the space already reserved. The space required to draw the axis. |
| setCategoryLabelPositionOffset | | public void setCategoryLabelPositionOffset(int offset)(Code) | | 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: CategoryAxis.getCategoryLabelPositionOffset() |
| setCategoryMargin | | public void setCategoryMargin(double margin)(Code) | | 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: CategoryAxis.getCategoryMargin() |
| setLowerMargin | | public void setLowerMargin(double margin)(Code) | | 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: CategoryAxis.getLowerMargin() |
| setUpperMargin | | public void setUpperMargin(double margin)(Code) | | 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: CategoryAxis.getUpperMargin() |
| Methods inherited from org.jfree.chart.axis.Axis | public void addChangeListener(AxisChangeListener listener)(Code)(Java Doc)
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
abstract public void configure()(Code)(Java Doc)
abstract public AxisState draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState)(Code)(Java Doc)
protected void drawAxisLine(Graphics2D g2, double cursor, Rectangle2D dataArea, RectangleEdge edge)(Code)(Java Doc)
protected AxisState drawLabel(String label, Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public Paint getAxisLinePaint()(Code)(Java Doc)
public Stroke getAxisLineStroke()(Code)(Java Doc)
public double getFixedDimension()(Code)(Java Doc)
public String getLabel()(Code)(Java Doc)
public double getLabelAngle()(Code)(Java Doc)
protected Rectangle2D getLabelEnclosure(Graphics2D g2, RectangleEdge edge)(Code)(Java Doc)
public Font getLabelFont()(Code)(Java Doc)
public RectangleInsets getLabelInsets()(Code)(Java Doc)
public Paint getLabelPaint()(Code)(Java Doc)
public Plot getPlot()(Code)(Java Doc)
public Font getTickLabelFont()(Code)(Java Doc)
public RectangleInsets getTickLabelInsets()(Code)(Java Doc)
public Paint getTickLabelPaint()(Code)(Java Doc)
public float getTickMarkInsideLength()(Code)(Java Doc)
public float getTickMarkOutsideLength()(Code)(Java Doc)
public Paint getTickMarkPaint()(Code)(Java Doc)
public Stroke getTickMarkStroke()(Code)(Java Doc)
public boolean hasListener(EventListener listener)(Code)(Java Doc)
public boolean isAxisLineVisible()(Code)(Java Doc)
public boolean isTickLabelsVisible()(Code)(Java Doc)
public boolean isTickMarksVisible()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
protected void notifyListeners(AxisChangeEvent event)(Code)(Java Doc)
abstract public List refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)(Code)(Java Doc)
public void removeChangeListener(AxisChangeListener listener)(Code)(Java Doc)
abstract public AxisSpace reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space)(Code)(Java Doc)
public void setAxisLinePaint(Paint paint)(Code)(Java Doc)
public void setAxisLineStroke(Stroke stroke)(Code)(Java Doc)
public void setAxisLineVisible(boolean visible)(Code)(Java Doc)
public void setFixedDimension(double dimension)(Code)(Java Doc)
public void setLabel(String label)(Code)(Java Doc)
public void setLabelAngle(double angle)(Code)(Java Doc)
public void setLabelFont(Font font)(Code)(Java Doc)
public void setLabelInsets(RectangleInsets insets)(Code)(Java Doc)
public void setLabelPaint(Paint paint)(Code)(Java Doc)
public void setPlot(Plot plot)(Code)(Java Doc)
public void setTickLabelFont(Font font)(Code)(Java Doc)
public void setTickLabelInsets(RectangleInsets insets)(Code)(Java Doc)
public void setTickLabelPaint(Paint paint)(Code)(Java Doc)
public void setTickLabelsVisible(boolean flag)(Code)(Java Doc)
public void setTickMarkInsideLength(float length)(Code)(Java Doc)
public void setTickMarkOutsideLength(float length)(Code)(Java Doc)
public void setTickMarkPaint(Paint paint)(Code)(Java Doc)
public void setTickMarkStroke(Stroke stroke)(Code)(Java Doc)
public void setTickMarksVisible(boolean flag)(Code)(Java Doc)
public void setVisible(boolean flag)(Code)(Java Doc)
|
|
|