Module platform

Package org.jfree.chart.renderer.xy

Class XYItemRendererState

java.lang.Object

org.jfree.chart.renderer.RendererState

org.jfree.chart.renderer.xy.XYItemRendererState

Direct Known Subclasses:

SamplingXYLineRenderer.State, StandardXYItemRenderer.State, XYBarRenderer.XYBarRendererState, XYLineAndShapeRenderer.State

public class XYItemRendererState
extends RendererState

The state for an XYItemRenderer.

Field Summary

Fields

Modifier and Type	Field	Description
Line2D	workingLine	A line object that the renderer can reuse to save instantiating a lot of objects.

Constructor Summary

Constructors

Constructor	Description
XYItemRendererState(PlotRenderingInfo info)	Creates a new state.

Method Summary

Modifier and Type	Method	Description
void	endSeriesPass(XYDataset dataset, int series, int firstItem, int lastItem, int pass, int passCount)	This method is called by the XYPlot when it ends a pass through the (visible) items in a series.
int	getFirstItemIndex()	Returns the first item index (this is updated with each call to startSeriesPass(XYDataset, int, int, int, int, int).
int	getLastItemIndex()	Returns the last item index (this is updated with each call to startSeriesPass(XYDataset, int, int, int, int, int).
boolean	getProcessVisibleItemsOnly()	Returns the flag that controls whether the plot passes all data items in each series to the renderer, or just the visible items.
void	setProcessVisibleItemsOnly(boolean flag)	Sets the flag that controls whether the plot passes all data items in each series to the renderer, or just the visible items.
void	startSeriesPass(XYDataset dataset, int series, int firstItem, int lastItem, int pass, int passCount)	This method is called by the XYPlot when it starts a pass through the (visible) items in a series.

Methods inherited from class org.jfree.chart.renderer.RendererState

getElementHinting, getEntityCollection, getInfo, setElementHinting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

workingLine

public Line2D workingLine

A line object that the renderer can reuse to save instantiating a lot of objects.

Constructor Details

XYItemRendererState

public XYItemRendererState(PlotRenderingInfo info)

Creates a new state.

Parameters:

info - the plot rendering info.

Method Details

getProcessVisibleItemsOnly

public boolean getProcessVisibleItemsOnly()

Returns the flag that controls whether the plot passes all data items in each series to the renderer, or just the visible items. The default value is true.

Returns:

A boolean.

See Also:

• setProcessVisibleItemsOnly(boolean)

setProcessVisibleItemsOnly

public void setProcessVisibleItemsOnly(boolean flag)

Sets the flag that controls whether the plot passes all data items in each series to the renderer, or just the visible items.

Parameters:

flag - the new flag value.

getFirstItemIndex

public int getFirstItemIndex()

Returns the first item index (this is updated with each call to startSeriesPass(XYDataset, int, int, int, int, int).

Returns:

The first item index.

getLastItemIndex

public int getLastItemIndex()

Returns the last item index (this is updated with each call to startSeriesPass(XYDataset, int, int, int, int, int).

Returns:

The last item index.

startSeriesPass

public void startSeriesPass(XYDataset dataset,
 int series,
 int firstItem,
 int lastItem,
 int pass,
 int passCount)

This method is called by the XYPlot when it starts a pass through the (visible) items in a series. The default implementation records the first and last item indices - override this method to implement additional specialised behaviour.

Parameters:

dataset - the dataset.

series - the series index.

firstItem - the index of the first item in the series.

lastItem - the index of the last item in the series.

pass - the pass index.

passCount - the number of passes.

See Also:

• endSeriesPass(XYDataset, int, int, int, int, int)

endSeriesPass

public void endSeriesPass(XYDataset dataset,
 int series,
 int firstItem,
 int lastItem,
 int pass,
 int passCount)

This method is called by the XYPlot when it ends a pass through the (visible) items in a series. The default implementation does nothing, but you can override this method to implement specialised behaviour.

Parameters:

dataset - the dataset.

series - the series index.

firstItem - the index of the first item in the series.

lastItem - the index of the last item in the series.

pass - the pass index.

passCount - the number of passes.

See Also:

• startSeriesPass(XYDataset, int, int, int, int, int)