org.jfree.chart.renderer.xy

Class XYStepRenderer

public class XYStepRenderer extends XYLineAndShapeRenderer implements XYItemRenderer, Cloneable, PublicCloneable, Serializable

Line/Step item renderer for an XYPlot. This class draws lines between data points, only allowing horizontal or vertical lines (steps). The example shown here is generated by the XYStepRendererDemo1.java program included in the JFreeChart demo collection:

XYStepRendererSample.png
Constructor Summary
XYStepRenderer()
Constructs a new renderer with no tooltip or URL generation.
XYStepRenderer(XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
Constructs a new renderer with the specified tool tip and URL generators.
Method Summary
Objectclone()
Returns a clone of the renderer.
voiddrawItem(Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
Draws the visual representation of a single data item.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
doublegetStepPoint()
Returns the fraction of the domain position between two points on which the step is drawn.
inthashCode()
Returns a hash code for this instance.
voidsetStepPoint(double stepPoint)
Sets the step point and sends a RendererChangeEvent to all registered listeners.

Constructor Detail

XYStepRenderer

public XYStepRenderer()
Constructs a new renderer with no tooltip or URL generation.

XYStepRenderer

public XYStepRenderer(XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
Constructs a new renderer with the specified tool tip and URL generators.

Parameters: toolTipGenerator the item label generator (null permitted). urlGenerator the URL generator (null permitted).

Method Detail

clone

public Object clone()
Returns a clone of the renderer.

Returns: A clone.

Throws: CloneNotSupportedException if the renderer cannot be cloned.

drawItem

public void drawItem(Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
Draws the visual representation of a single data item.

Parameters: g2 the graphics device. state the renderer state. dataArea the area within which the data is being drawn. info collects information about the drawing. plot the plot (can be used to obtain standard color information etc). domainAxis the domain axis. rangeAxis the vertical axis. dataset the dataset. series the series index (zero-based). item the item index (zero-based). crosshairState crosshair information for the plot (null permitted). pass the pass index.

equals

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

Parameters: obj the object (null permitted).

Returns: A boolean.

getStepPoint

public double getStepPoint()
Returns the fraction of the domain position between two points on which the step is drawn. The default is 1.0d, which means the step is drawn at the domain position of the second`point. If the stepPoint is 0.5d the step is drawn at half between the two points.

Returns: The fraction of the domain position between two points where the step is drawn.

Since: 1.0.10

See Also:

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.

setStepPoint

public void setStepPoint(double stepPoint)
Sets the step point and sends a RendererChangeEvent to all registered listeners.

Parameters: stepPoint the step point (in the range 0.0 to 1.0)

Since: 1.0.10

See Also:

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