org.jfree.chart.renderer.category

Class CategoryStepRenderer

public class CategoryStepRenderer extends AbstractCategoryItemRenderer implements Cloneable, PublicCloneable, Serializable

A "step" renderer similar to XYStepRenderer but that can be used with the CategoryPlot class. The example shown here is generated by the CategoryStepChartDemo1.java program included in the JFreeChart Demo Collection:

CategoryStepRendererSample.png
Nested Class Summary
protected static classCategoryStepRenderer.State
State information for the renderer.
Field Summary
static intSTAGGER_WIDTH
The stagger width.
Constructor Summary
CategoryStepRenderer()
Creates a new renderer (stagger defaults to false).
CategoryStepRenderer(boolean stagger)
Creates a new renderer.
Method Summary
protected CategoryItemRendererStatecreateState(PlotRenderingInfo info)
Creates a new state instance.
voiddrawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draw a single data item.
protected voiddrawLine(Graphics2D g2, CategoryStepRenderer.State state, PlotOrientation orientation, double x0, double y0, double x1, double y1)
Draws a line taking into account the specified orientation.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
LegendItemgetLegendItem(int datasetIndex, int series)
Returns a legend item for a series.
booleangetStagger()
Returns the flag that controls whether the series steps are staggered.
voidsetStagger(boolean shouldStagger)
Sets the flag that controls whether or not the series steps are staggered and sends a RendererChangeEvent to all registered listeners.

Field Detail

STAGGER_WIDTH

public static final int STAGGER_WIDTH
The stagger width.

Constructor Detail

CategoryStepRenderer

public CategoryStepRenderer()
Creates a new renderer (stagger defaults to false).

CategoryStepRenderer

public CategoryStepRenderer(boolean stagger)
Creates a new renderer.

Parameters: stagger should the horizontal part of the step be staggered by series?

Method Detail

createState

protected CategoryItemRendererState createState(PlotRenderingInfo info)
Creates a new state instance. This method is called from CategoryStepRenderer, and we override it to ensure that the state contains a working Line2D instance.

Parameters: info the plot rendering info (null is permitted).

Returns: A new state instance.

drawItem

public void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draw a single data item.

Parameters: g2 the graphics device. state the renderer state. dataArea the area in which the data is drawn. plot the plot. domainAxis the domain axis. rangeAxis the range axis. dataset the dataset. row the row index (zero-based). column the column index (zero-based). pass the pass index.

drawLine

protected void drawLine(Graphics2D g2, CategoryStepRenderer.State state, PlotOrientation orientation, double x0, double y0, double x1, double y1)
Draws a line taking into account the specified orientation.

In version 1.0.5, the signature of this method was changed by the addition of the 'state' parameter. This is an incompatible change, but is considered a low risk because it is unlikely that anyone has subclassed this renderer. If this *does* cause trouble for you, please report it as a bug.

Parameters: g2 the graphics device. state the renderer state. orientation the plot orientation. x0 the x-coordinate for the start of the line. y0 the y-coordinate for the start of the line. x1 the x-coordinate for the end of the line. y1 the y-coordinate for the end of the line.

equals

public boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getLegendItem

public LegendItem getLegendItem(int datasetIndex, int series)
Returns a legend item for a series.

Parameters: datasetIndex the dataset index (zero-based). series the series index (zero-based).

Returns: The legend item.

getStagger

public boolean getStagger()
Returns the flag that controls whether the series steps are staggered.

Returns: A boolean.

setStagger

public void setStagger(boolean shouldStagger)
Sets the flag that controls whether or not the series steps are staggered and sends a RendererChangeEvent to all registered listeners.

Parameters: shouldStagger a boolean.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.