Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

XYStepRenderer

extends XYLineAndShapeRenderer
implements Serializable Cloneable XYItemRenderer

java.lang.Object
↳	org.jfree.chart.renderer.AbstractRenderer
	↳	org.jfree.chart.renderer.xy.AbstractXYItemRenderer
		↳	org.jfree.chart.renderer.xy.XYLineAndShapeRenderer
			↳	org.jfree.chart.renderer.xy.XYStepRenderer

Class Overview

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:

Summary

[Expand]

Inherited Fields

From class org.jfree.chart.renderer.AbstractRenderer

Public Constructors
	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.

Public Methods
Object	clone() Returns a clone of the renderer.
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.
boolean	equals(Object obj) Tests this renderer for equality with an arbitrary object.
double	getStepPoint() Returns the fraction of the domain position between two points on which the step is drawn.
int	hashCode() Returns a hash code for this instance.
void	setStepPoint(double stepPoint) Sets the step point and sends a `RendererChangeEvent` to all registered listeners.

[Expand]

Inherited Methods

From class org.jfree.chart.renderer.xy.XYLineAndShapeRenderer

Object	clone() Returns a clone of the renderer.
void	drawFirstPassShape(Graphics2D g2, int pass, int series, int item, Shape shape) Draws the first pass shape.
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.
void	drawPrimaryLine(XYItemRendererState state, Graphics2D g2, XYPlot plot, XYDataset dataset, int pass, int series, int item, ValueAxis domainAxis, ValueAxis rangeAxis, Rectangle2D dataArea) Draws the item (first pass).
void	drawPrimaryLineAsPath(XYItemRendererState state, Graphics2D g2, XYPlot plot, XYDataset dataset, int pass, int series, int item, ValueAxis domainAxis, ValueAxis rangeAxis, Rectangle2D dataArea) Draws the item (first pass).
void	drawSecondaryPass(Graphics2D g2, XYPlot plot, XYDataset dataset, int pass, int series, int item, ValueAxis domainAxis, Rectangle2D dataArea, ValueAxis rangeAxis, CrosshairState crosshairState, EntityCollection entities) Draws the item shapes and adds chart entities (second pass).
boolean	equals(Object obj) Tests this renderer for equality with an arbitrary object.
boolean	getBaseLinesVisible() Returns the base 'lines visible' attribute.
boolean	getBaseShapesFilled() Returns the base 'shape filled' attribute.
boolean	getBaseShapesVisible() Returns the base 'shape visible' attribute.
boolean	getDrawOutlines() Returns `true` if outlines should be drawn for shapes, and `false` otherwise.
boolean	getDrawSeriesLineAsPath() Returns a flag that controls whether or not each series is drawn as a single path.
boolean	getItemLineVisible(int series, int item) Returns the flag used to control whether or not the shape for an item is visible.
boolean	getItemShapeFilled(int series, int item) Returns the flag used to control whether or not the shape for an item is filled.
boolean	getItemShapeVisible(int series, int item) Returns the flag used to control whether or not the shape for an item is visible.
LegendItem	getLegendItem(int datasetIndex, int series) Returns a legend item for the specified series.
Shape	getLegendLine() Returns the shape used to represent a line in the legend.
Boolean	getLinesVisible() This method is deprecated. As of 1.0.7, use the per-series and base level settings.
int	getPassCount() Returns the number of passes through the data that the renderer requires in order to draw the chart.
Boolean	getSeriesLinesVisible(int series) Returns the flag used to control whether or not the lines for a series are visible.
Boolean	getSeriesShapesFilled(int series) Returns the flag used to control whether or not the shapes for a series are filled.
Boolean	getSeriesShapesVisible(int series) Returns the flag used to control whether or not the shapes for a series are visible.
Boolean	getShapesVisible() This method is deprecated. As of 1.0.7, use the per-series and base level settings.
boolean	getUseFillPaint() Returns `true` if the renderer should use the fill paint setting to fill shapes, and `false` if it should just use the regular paint.
boolean	getUseOutlinePaint() Returns `true` if the renderer should use the outline paint setting to draw shape outlines, and `false` if it should just use the regular paint.
XYItemRendererState	initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info) Initialises the renderer.
boolean	isItemPass(int pass) Returns `true` if the specified pass is the one for drawing items.
boolean	isLinePass(int pass) Returns `true` if the specified pass is the one for drawing lines.
void	setBaseLinesVisible(boolean flag) Sets the base 'lines visible' flag and sends a `RendererChangeEvent` to all registered listeners.
void	setBaseShapesFilled(boolean flag) Sets the base 'shapes filled' flag and sends a `RendererChangeEvent` to all registered listeners.
void	setBaseShapesVisible(boolean flag) Sets the base 'shapes visible' flag and sends a `RendererChangeEvent` to all registered listeners.
void	setDrawOutlines(boolean flag) Sets the flag that controls whether outlines are drawn for shapes, and sends a `RendererChangeEvent` to all registered listeners.
void	setDrawSeriesLineAsPath(boolean flag) Sets the flag that controls whether or not each series is drawn as a single path and sends a `RendererChangeEvent` to all registered listeners.
void	setLegendLine(Shape line) Sets the shape used as a line in each legend item and sends a `RendererChangeEvent` to all registered listeners.
void	setLinesVisible(boolean visible) This method is deprecated. As of 1.0.7, use the per-series and base level settings.
void	setLinesVisible(Boolean visible) This method is deprecated. As of 1.0.7, use the per-series and base level settings.
void	setSeriesLinesVisible(int series, boolean visible) Sets the 'lines visible' flag for a series and sends a `RendererChangeEvent` to all registered listeners.
void	setSeriesLinesVisible(int series, Boolean flag) Sets the 'lines visible' flag for a series and sends a `RendererChangeEvent` to all registered listeners.
void	setSeriesShapesFilled(int series, boolean flag) Sets the 'shapes filled' flag for a series and sends a `RendererChangeEvent` to all registered listeners.
void	setSeriesShapesFilled(int series, Boolean flag) Sets the 'shapes filled' flag for a series and sends a `RendererChangeEvent` to all registered listeners.
void	setSeriesShapesVisible(int series, Boolean flag) Sets the 'shapes visible' flag for a series and sends a `RendererChangeEvent` to all registered listeners.
void	setSeriesShapesVisible(int series, boolean visible) Sets the 'shapes visible' flag for a series and sends a `RendererChangeEvent` to all registered listeners.
void	setShapesFilled(boolean filled) This method is deprecated. As of 1.0.7, use the per-series and base level settings.
void	setShapesFilled(Boolean filled) This method is deprecated. As of 1.0.7, use the per-series and base level settings.
void	setShapesVisible(boolean visible) This method is deprecated. As of 1.0.7, use the per-series and base level settings.
void	setShapesVisible(Boolean visible) This method is deprecated. As of 1.0.7, use the per-series and base level settings.
void	setUseFillPaint(boolean flag) Sets the flag that controls whether the fill paint is used to fill shapes, and sends a `RendererChangeEvent` to all registered listeners.
void	setUseOutlinePaint(boolean flag) Sets the flag that controls whether the outline paint is used to draw shape outlines, and sends a `RendererChangeEvent` to all registered listeners.

From class org.jfree.chart.renderer.xy.AbstractXYItemRenderer

From class org.jfree.chart.renderer.AbstractRenderer

From class java.lang.Object

From interface org.jfree.chart.LegendItemSource

From interface org.jfree.chart.renderer.xy.XYItemRenderer

Public Constructors

public XYStepRenderer ()

Constructs a new renderer with no tooltip or URL generation.

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).

Public Methods

public Object clone ()

Returns a clone of the renderer.

Returns

A clone.

Throws

CloneNotSupportedException	if the renderer cannot be cloned.

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.

public boolean equals (Object obj)

Tests this renderer for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

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.

public int hashCode ()

Returns a hash code for this instance.

Returns

A hash code.

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)

Interfaces

Classes

XYStepRenderer

Class Overview

Summary

Public Constructors

public XYStepRenderer ()

public XYStepRenderer (XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)

Parameters

Public Methods

public Object clone ()

Returns

Throws

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)

Parameters

public boolean equals (Object obj)

Parameters

Returns

public double getStepPoint ()

Returns

See Also

public int hashCode ()

Returns

public void setStepPoint (double stepPoint)

Parameters

See Also