Module platform

Package org.jfree.chart.renderer.category

Class AbstractCategoryItemRenderer

java.lang.Object

org.jfree.chart.renderer.AbstractRenderer

org.jfree.chart.renderer.category.AbstractCategoryItemRenderer

All Implemented Interfaces:

Serializable, Cloneable, LegendItemSource, CategoryItemRenderer, PublicCloneable

Direct Known Subclasses:

AreaRenderer, BarRenderer, BoxAndWhiskerRenderer, CategoryStepRenderer, LevelRenderer, LineAndShapeRenderer, MinMaxCategoryRenderer, ScatterRenderer

public abstract class AbstractCategoryItemRenderer
extends AbstractRenderer
implements CategoryItemRenderer, Cloneable, PublicCloneable, Serializable

An abstract base class that you can use to implement a new CategoryItemRenderer. When you create a new CategoryItemRenderer you are not required to extend this class, but it makes the job easier.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.jfree.chart.renderer.AbstractRenderer

DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCategoryItemRenderer()	Creates a new renderer with no tool tip generator and no URL generator.

Method Summary

Modifier and Type	Method	Description
protected void	addEntity(EntityCollection entities, Shape hotspot, CategoryDataset dataset, int row, int column, double entityX, double entityY)	Adds an entity to the collection.
protected void	addItemEntity(EntityCollection entities, CategoryDataset dataset, int row, int column, Shape hotspot)	Adds an entity with the specified hotspot.
protected void	beginElementGroup(Graphics2D g2, Comparable rowKey, Comparable columnKey)	Adds a KEY_BEGIN_ELEMENT hint to the graphics target.
protected Point2D	calculateDomainMarkerTextAnchorPoint(Graphics2D g2, PlotOrientation orientation, Rectangle2D dataArea, Rectangle2D markerArea, RectangleInsets markerOffset, LengthAdjustmentType labelOffsetType, RectangleAnchor anchor)	Calculates the (x, y) coordinates for drawing the label for a marker on the range axis.
protected Point2D	calculateRangeMarkerTextAnchorPoint(Graphics2D g2, PlotOrientation orientation, Rectangle2D dataArea, Rectangle2D markerArea, RectangleInsets markerOffset, LengthAdjustmentType labelOffsetType, RectangleAnchor anchor)	Calculates the (x, y) coordinates for drawing a marker label.
Object	clone()	Returns an independent copy of the renderer.
protected CategoryItemRendererState	createState(PlotRenderingInfo info)	Creates a new state instance---this method is called from the initialise(Graphics2D, Rectangle2D, CategoryPlot, int, PlotRenderingInfo) method.
void	drawBackground(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)	Draws a background for the data area.
void	drawDomainGridline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, double value)	Draws a grid line against the domain axis.
void	drawDomainMarker(Graphics2D g2, CategoryPlot plot, CategoryAxis axis, CategoryMarker marker, Rectangle2D dataArea)	Draws a marker for the domain axis.
protected void	drawItemLabel(Graphics2D g2, PlotOrientation orientation, CategoryDataset dataset, int row, int column, double x, double y, boolean negative)	Draws an item label.
void	drawOutline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)	Draws an outline for the data area.
void	drawRangeLine(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value, Paint paint, Stroke stroke)	Draws a line perpendicular to the range axis.
void	drawRangeMarker(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)	Draws a marker for the range axis.
boolean	equals(Object obj)	Tests this renderer for equality with another object.
Range	findRangeBounds(CategoryDataset dataset)	Returns the range of values the renderer requires to display all the items from the specified dataset.
protected Range	findRangeBounds(CategoryDataset dataset, boolean includeInterval)	Returns the range of values the renderer requires to display all the items from the specified dataset.
int	getColumnCount()	Returns the number of columns in the dataset.
CategoryItemLabelGenerator	getDefaultItemLabelGenerator()	Returns the default item label generator.
CategoryURLGenerator	getDefaultItemURLGenerator()	Returns the default item URL generator.
CategoryToolTipGenerator	getDefaultToolTipGenerator()	Returns the default tool tip generator (the "layer 2" generator).
protected CategoryAxis	getDomainAxis(CategoryPlot plot, int index)	Returns a domain axis for a plot.
DrawingSupplier	getDrawingSupplier()	Returns the drawing supplier from the plot.
CategoryItemLabelGenerator	getItemLabelGenerator(int row, int column)	Returns the item label generator for a data item.
double	getItemMiddle(Comparable rowKey, Comparable columnKey, CategoryDataset dataset, CategoryAxis axis, Rectangle2D area, RectangleEdge edge)	Returns the Java2D coordinate for the middle of the specified data item.
CategoryURLGenerator	getItemURLGenerator(int row, int column)	Returns the URL generator for a data item.
LegendItem	getLegendItem(int datasetIndex, int series)	Returns a legend item for a series.
CategorySeriesLabelGenerator	getLegendItemLabelGenerator()	Returns the legend item label generator.
LegendItemCollection	getLegendItems()	Returns a (possibly empty) collection of legend items for the series that this renderer is responsible for drawing.
CategorySeriesLabelGenerator	getLegendItemToolTipGenerator()	Returns the legend item tool tip generator.
CategorySeriesLabelGenerator	getLegendItemURLGenerator()	Returns the legend item URL generator.
int	getPassCount()	Returns the number of passes through the dataset required by the renderer.
CategoryPlot	getPlot()	Returns the plot that the renderer has been assigned to (where null indicates that the renderer is not currently assigned to a plot).
protected ValueAxis	getRangeAxis(CategoryPlot plot, int index)	Returns a range axis for a plot.
int	getRowCount()	Returns the number of rows in the dataset.
CategoryItemLabelGenerator	getSeriesItemLabelGenerator(int series)	Returns the item label generator for a series.
CategoryURLGenerator	getSeriesItemURLGenerator(int series)	Returns the URL generator for a series.
CategoryToolTipGenerator	getSeriesToolTipGenerator(int series)	Returns the tool tip generator for the specified series (a "layer 1" generator).
CategoryToolTipGenerator	getToolTipGenerator(int row, int column)	Returns the tool tip generator that should be used for the specified item.
int	hashCode()	Returns a hash code for the renderer.
CategoryItemRendererState	initialise(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, PlotRenderingInfo info)	Initialises the renderer and returns a state object that will be used for the remainder of the drawing process for a single chart.
void	setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator)	Sets the default item label generator and sends a RendererChangeEvent to all registered listeners.
void	setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator, boolean notify)	Sets the default item label generator and sends a RendererChangeEvent to all registered listeners.
void	setDefaultItemURLGenerator(CategoryURLGenerator generator)	Sets the default item URL generator and sends a RendererChangeEvent to all registered listeners.
void	setDefaultItemURLGenerator(CategoryURLGenerator generator, boolean notify)	Sets the default item URL generator and sends a RendererChangeEvent to all registered listeners.
void	setDefaultToolTipGenerator(CategoryToolTipGenerator generator)	Sets the default tool tip generator and sends a RendererChangeEvent to all registered listeners.
void	setDefaultToolTipGenerator(CategoryToolTipGenerator generator, boolean notify)	Sets the default tool tip generator and sends a RendererChangeEvent to all registered listeners.
void	setLegendItemLabelGenerator(CategorySeriesLabelGenerator generator)	Sets the legend item label generator and sends a RendererChangeEvent to all registered listeners.
void	setLegendItemToolTipGenerator(CategorySeriesLabelGenerator generator)	Sets the legend item tool tip generator and sends a RendererChangeEvent to all registered listeners.
void	setLegendItemURLGenerator(CategorySeriesLabelGenerator generator)	Sets the legend item URL generator and sends a RendererChangeEvent to all registered listeners.
void	setPlot(CategoryPlot plot)	Sets the plot that the renderer has been assigned to.
void	setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator)	Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners.
void	setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator, boolean notify)	Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners.
void	setSeriesItemURLGenerator(int series, CategoryURLGenerator generator)	Sets the URL generator for a series and sends a RendererChangeEvent to all registered listeners.
void	setSeriesItemURLGenerator(int series, CategoryURLGenerator generator, boolean notify)	Sets the URL generator for a series and sends a RendererChangeEvent to all registered listeners.
void	setSeriesToolTipGenerator(int series, CategoryToolTipGenerator generator)	Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners.
void	setSeriesToolTipGenerator(int series, CategoryToolTipGenerator generator, boolean notify)	Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners.
protected void	updateCrosshairValues(CategoryCrosshairState crosshairState, Comparable rowKey, Comparable columnKey, double value, int datasetIndex, double transX, double transY, PlotOrientation orientation)	Considers the current (x, y) coordinate and updates the crosshair point if it meets the criteria (usually means the (x, y) coordinate is the closest to the anchor point so far).

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

addChangeListener, beginElementGroup, calculateLabelAnchorPoint, clearSeriesPaints, clearSeriesStrokes, endElementGroup, fireChangeEvent, getAutoPopulateSeriesFillPaint, getAutoPopulateSeriesOutlinePaint, getAutoPopulateSeriesOutlineStroke, getAutoPopulateSeriesPaint, getAutoPopulateSeriesShape, getAutoPopulateSeriesStroke, getDataBoundsIncludesVisibleSeriesOnly, getDefaultCreateEntities, getDefaultEntityRadius, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultLegendShape, getDefaultLegendTextFont, getDefaultLegendTextPaint, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getItemCreateEntity, getItemFillPaint, getItemLabelAnchorOffset, getItemLabelFont, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendShape, getLegendTextFont, getLegendTextPaint, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisibleInLegend, getTreatLegendShapeAsLine, hasListener, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, lookupLegendShape, lookupLegendTextFont, lookupLegendTextPaint, lookupSeriesFillPaint, lookupSeriesOutlinePaint, lookupSeriesOutlineStroke, lookupSeriesPaint, lookupSeriesShape, lookupSeriesStroke, notifyListeners, removeChangeListener, setAutoPopulateSeriesFillPaint, setAutoPopulateSeriesOutlinePaint, setAutoPopulateSeriesOutlineStroke, setAutoPopulateSeriesPaint, setAutoPopulateSeriesShape, setAutoPopulateSeriesStroke, setDataBoundsIncludesVisibleSeriesOnly, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultEntityRadius, setDefaultFillPaint, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelFont, setDefaultItemLabelPaint, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultLegendShape, setDefaultLegendTextFont, setDefaultLegendTextPaint, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setItemLabelAnchorOffset, setLegendShape, setLegendTextFont, setLegendTextPaint, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setTreatLegendShapeAsLine

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.renderer.category.CategoryItemRenderer

addChangeListener, drawItem, getDefaultCreateEntities, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getItemCreateEntity, getItemFillPaint, getItemLabelFont, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisibleInLegend, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, removeChangeListener, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelFont, setDefaultItemLabelPaint, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend

Constructor Details

AbstractCategoryItemRenderer

protected AbstractCategoryItemRenderer()

Creates a new renderer with no tool tip generator and no URL generator. The defaults (no tool tip or URL generators) have been chosen to minimise the processing required to generate a default chart. If you require tool tips or URLs, then you can easily add the required generators.

Method Details

getPassCount

public int getPassCount()

Returns the number of passes through the dataset required by the renderer. This method returns 1, subclasses should override if they need more passes.

Specified by:

getPassCount in interface CategoryItemRenderer

Returns:

The pass count.

getPlot

public CategoryPlot getPlot()

Returns the plot that the renderer has been assigned to (where null indicates that the renderer is not currently assigned to a plot).

Specified by:

getPlot in interface CategoryItemRenderer

Returns:

The plot (possibly null).

See Also:

• setPlot(CategoryPlot)

setPlot

public void setPlot(CategoryPlot plot)

Sets the plot that the renderer has been assigned to. This method is usually called by the CategoryPlot, in normal usage you shouldn't need to call this method directly.

Specified by:

setPlot in interface CategoryItemRenderer

Parameters:

plot - the plot (null not permitted).

See Also:

• getPlot()

getItemLabelGenerator

public CategoryItemLabelGenerator getItemLabelGenerator(int row,
 int column)

Returns the item label generator for a data item. This implementation simply passes control to the getSeriesItemLabelGenerator(int) method. If, for some reason, you want a different generator for individual items, you can override this method.

Specified by:

getItemLabelGenerator in interface CategoryItemRenderer

Parameters:

row - the row index (zero based).

column - the column index (zero based).

Returns:

The generator (possibly null).

getSeriesItemLabelGenerator

public CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series)

Returns the item label generator for a series.

Specified by:

getSeriesItemLabelGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero based).

Returns:

The generator (possibly null).

See Also:

• setSeriesItemLabelGenerator(int, CategoryItemLabelGenerator)

setSeriesItemLabelGenerator

public void setSeriesItemLabelGenerator(int series,
 CategoryItemLabelGenerator generator)

Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners.

Specified by:

setSeriesItemLabelGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero based).

generator - the generator (null permitted).

See Also:

• getSeriesItemLabelGenerator(int)

setSeriesItemLabelGenerator

public void setSeriesItemLabelGenerator(int series,
 CategoryItemLabelGenerator generator,
 boolean notify)

Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners.

Specified by:

setSeriesItemLabelGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero based).

generator - the generator (null permitted).

notify - notify listeners?

See Also:

• getSeriesItemLabelGenerator(int)

getDefaultItemLabelGenerator

public CategoryItemLabelGenerator getDefaultItemLabelGenerator()

Returns the default item label generator.

Specified by:

getDefaultItemLabelGenerator in interface CategoryItemRenderer

Returns:

The generator (possibly null).

See Also:

• setDefaultItemLabelGenerator(CategoryItemLabelGenerator)

setDefaultItemLabelGenerator

public void setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator)

Sets the default item label generator and sends a RendererChangeEvent to all registered listeners.

Specified by:

setDefaultItemLabelGenerator in interface CategoryItemRenderer

Parameters:

generator - the generator (null permitted).

See Also:

• getDefaultItemLabelGenerator()

setDefaultItemLabelGenerator

public void setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator,
 boolean notify)

Sets the default item label generator and sends a RendererChangeEvent to all registered listeners.

Specified by:

setDefaultItemLabelGenerator in interface CategoryItemRenderer

Parameters:

generator - the generator (null permitted).

notify - notify listeners?

See Also:

• getDefaultItemLabelGenerator()

getToolTipGenerator

public CategoryToolTipGenerator getToolTipGenerator(int row,
 int column)

Returns the tool tip generator that should be used for the specified item. This method looks up the generator using the "three-layer" approach outlined in the general description of this interface. You can override this method if you want to return a different generator per item.

Specified by:

getToolTipGenerator in interface CategoryItemRenderer

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The generator (possibly null).

getSeriesToolTipGenerator

public CategoryToolTipGenerator getSeriesToolTipGenerator(int series)

Returns the tool tip generator for the specified series (a "layer 1" generator).

Specified by:

getSeriesToolTipGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero-based).

Returns:

The tool tip generator (possibly null).

See Also:

• setSeriesToolTipGenerator(int, CategoryToolTipGenerator)

setSeriesToolTipGenerator

public void setSeriesToolTipGenerator(int series,
 CategoryToolTipGenerator generator)

Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners.

Specified by:

setSeriesToolTipGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero-based).

generator - the generator (null permitted).

See Also:

• getSeriesToolTipGenerator(int)

setSeriesToolTipGenerator

public void setSeriesToolTipGenerator(int series,
 CategoryToolTipGenerator generator,
 boolean notify)

Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners.

Specified by:

setSeriesToolTipGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero-based).

generator - the generator (null permitted).

notify - notify listeners?

See Also:

• getSeriesToolTipGenerator(int)

getDefaultToolTipGenerator

public CategoryToolTipGenerator getDefaultToolTipGenerator()

Returns the default tool tip generator (the "layer 2" generator).

Specified by:

getDefaultToolTipGenerator in interface CategoryItemRenderer

Returns:

The tool tip generator (possibly null).

See Also:

• setDefaultToolTipGenerator(CategoryToolTipGenerator)

setDefaultToolTipGenerator

public void setDefaultToolTipGenerator(CategoryToolTipGenerator generator)

Sets the default tool tip generator and sends a RendererChangeEvent to all registered listeners.

Specified by:

setDefaultToolTipGenerator in interface CategoryItemRenderer

Parameters:

generator - the generator (null permitted).

See Also:

• getDefaultToolTipGenerator()

setDefaultToolTipGenerator

public void setDefaultToolTipGenerator(CategoryToolTipGenerator generator,
 boolean notify)

Sets the default tool tip generator and sends a RendererChangeEvent to all registered listeners.

Specified by:

setDefaultToolTipGenerator in interface CategoryItemRenderer

Parameters:

generator - the generator (null permitted).

notify - notify listeners?

See Also:

• getDefaultToolTipGenerator()

getItemURLGenerator

public CategoryURLGenerator getItemURLGenerator(int row,
 int column)

Returns the URL generator for a data item. This method just calls the getSeriesItemURLGenerator method, but you can override this behaviour if you want to.

Specified by:

getItemURLGenerator in interface CategoryItemRenderer

Parameters:

row - the row index (zero based).

column - the column index (zero based).

Returns:

The URL generator.

getSeriesItemURLGenerator

public CategoryURLGenerator getSeriesItemURLGenerator(int series)

Returns the URL generator for a series.

Specified by:

getSeriesItemURLGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero based).

Returns:

The URL generator for the series.

See Also:

• setSeriesItemURLGenerator(int, CategoryURLGenerator)

setSeriesItemURLGenerator

public void setSeriesItemURLGenerator(int series,
 CategoryURLGenerator generator)

Sets the URL generator for a series and sends a RendererChangeEvent to all registered listeners.

Specified by:

setSeriesItemURLGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero based).

generator - the generator.

See Also:

• getSeriesItemURLGenerator(int)

setSeriesItemURLGenerator

public void setSeriesItemURLGenerator(int series,
 CategoryURLGenerator generator,
 boolean notify)

Sets the URL generator for a series and sends a RendererChangeEvent to all registered listeners.

Specified by:

setSeriesItemURLGenerator in interface CategoryItemRenderer

Parameters:

series - the series index (zero based).

generator - the generator.

notify - notify listeners?

See Also:

• getSeriesItemURLGenerator(int)

getDefaultItemURLGenerator

public CategoryURLGenerator getDefaultItemURLGenerator()

Returns the default item URL generator.

Specified by:

getDefaultItemURLGenerator in interface CategoryItemRenderer

Returns:

The item URL generator.

See Also:

• setDefaultItemURLGenerator(CategoryURLGenerator)

setDefaultItemURLGenerator

public void setDefaultItemURLGenerator(CategoryURLGenerator generator)

Sets the default item URL generator and sends a RendererChangeEvent to all registered listeners.

Specified by:

setDefaultItemURLGenerator in interface CategoryItemRenderer

Parameters:

generator - the item URL generator (null permitted).

See Also:

• getDefaultItemURLGenerator()

setDefaultItemURLGenerator

public void setDefaultItemURLGenerator(CategoryURLGenerator generator,
 boolean notify)

Sets the default item URL generator and sends a RendererChangeEvent to all registered listeners.

Specified by:

setDefaultItemURLGenerator in interface CategoryItemRenderer

Parameters:

generator - the item URL generator (null permitted).

notify - notify listeners?

See Also:

• getDefaultItemURLGenerator()

getRowCount

public int getRowCount()

Returns the number of rows in the dataset. This value is updated in the initialise(java.awt.Graphics2D, java.awt.geom.Rectangle2D, org.jfree.chart.plot.CategoryPlot, int, org.jfree.chart.plot.PlotRenderingInfo) method.

Returns:

The row count.

getColumnCount

public int getColumnCount()

Returns the number of columns in the dataset. This value is updated in the initialise(java.awt.Graphics2D, java.awt.geom.Rectangle2D, org.jfree.chart.plot.CategoryPlot, int, org.jfree.chart.plot.PlotRenderingInfo) method.

Returns:

The column count.

createState

protected CategoryItemRendererState createState(PlotRenderingInfo info)

Creates a new state instance---this method is called from the initialise(Graphics2D, Rectangle2D, CategoryPlot, int, PlotRenderingInfo) method. Subclasses can override this method if they need to use a subclass of CategoryItemRendererState.

Parameters:

info - collects plot rendering info (null permitted).

Returns:

The new state instance (never null).

initialise

public CategoryItemRendererState initialise(Graphics2D g2,
 Rectangle2D dataArea,
 CategoryPlot plot,
 int rendererIndex,
 PlotRenderingInfo info)

Initialises the renderer and returns a state object that will be used for the remainder of the drawing process for a single chart. The state object allows for the fact that the renderer may be used simultaneously by multiple threads (each thread will work with a separate state object).

Specified by:

initialise in interface CategoryItemRenderer

Parameters:

g2 - the graphics device.

dataArea - the data area.

plot - the plot.

rendererIndex - the renderer index.

info - an object for returning information about the structure of the plot (null permitted).

Returns:

The renderer state.

beginElementGroup

protected void beginElementGroup(Graphics2D g2,
 Comparable rowKey,
 Comparable columnKey)

Adds a KEY_BEGIN_ELEMENT hint to the graphics target. This hint is recognised by JFreeSVG (in theory it could be used by other Graphics2D implementations also).

Parameters:

g2 - the graphics target (null not permitted).

rowKey - the row key that identifies the element (null not permitted).

columnKey - the column key that identifies the element (null not permitted).

findRangeBounds

public Range findRangeBounds(CategoryDataset dataset)

Returns the range of values the renderer requires to display all the items from the specified dataset.

Specified by:

findRangeBounds in interface CategoryItemRenderer

Parameters:

dataset - the dataset (null permitted).

Returns:

The range (or null if the dataset is null or empty).

findRangeBounds

protected Range findRangeBounds(CategoryDataset dataset,
 boolean includeInterval)

Returns the range of values the renderer requires to display all the items from the specified dataset.

Parameters:

dataset - the dataset (null permitted).

includeInterval - include the y-interval if the dataset has one.

Returns:

The range (null if the dataset is null or empty).

getItemMiddle

public double getItemMiddle(Comparable rowKey,
 Comparable columnKey,
 CategoryDataset dataset,
 CategoryAxis axis,
 Rectangle2D area,
 RectangleEdge edge)

Returns the Java2D coordinate for the middle of the specified data item.

Specified by:

getItemMiddle in interface CategoryItemRenderer

Parameters:

rowKey - the row key.

columnKey - the column key.

dataset - the dataset.

axis - the axis.

area - the data area.

edge - the edge along which the axis lies.

Returns:

The Java2D coordinate for the middle of the item.

drawBackground

public void drawBackground(Graphics2D g2,
 CategoryPlot plot,
 Rectangle2D dataArea)

Draws a background for the data area. The default implementation just gets the plot to draw the background, but some renderers will override this behaviour.

Specified by:

drawBackground in interface CategoryItemRenderer

Parameters:

g2 - the graphics device.

plot - the plot.

dataArea - the data area.

drawOutline

public void drawOutline(Graphics2D g2,
 CategoryPlot plot,
 Rectangle2D dataArea)

Draws an outline for the data area. The default implementation just gets the plot to draw the outline, but some renderers will override this behaviour.

Specified by:

drawOutline in interface CategoryItemRenderer

Parameters:

g2 - the graphics device.

plot - the plot.

dataArea - the data area.

drawDomainGridline

public void drawDomainGridline(Graphics2D g2,
 CategoryPlot plot,
 Rectangle2D dataArea,
 double value)

Draws a grid line against the domain axis.

Note that this default implementation assumes that the horizontal axis is the domain axis. If this is not the case, you will need to override this method.

Specified by:

drawDomainGridline in interface CategoryItemRenderer

Parameters:

g2 - the graphics device.

plot - the plot.

dataArea - the area for plotting data.

value - the Java2D value at which the grid line should be drawn.

drawRangeLine

public void drawRangeLine(Graphics2D g2,
 CategoryPlot plot,
 ValueAxis axis,
 Rectangle2D dataArea,
 double value,
 Paint paint,
 Stroke stroke)

Draws a line perpendicular to the range axis.

Specified by:

drawRangeLine in interface CategoryItemRenderer

Parameters:

g2 - the graphics device.

plot - the plot.

axis - the value axis.

dataArea - the area for plotting data.

value - the value at which the grid line should be drawn.

paint - the paint (null not permitted).

stroke - the stroke (null not permitted).

drawDomainMarker

public void drawDomainMarker(Graphics2D g2,
 CategoryPlot plot,
 CategoryAxis axis,
 CategoryMarker marker,
 Rectangle2D dataArea)

Draws a marker for the domain axis.

Specified by:

drawDomainMarker in interface CategoryItemRenderer

Parameters:

g2 - the graphics device (not null).

plot - the plot (not null).

axis - the range axis (not null).

marker - the marker to be drawn (not null).

dataArea - the area inside the axes (not null).

See Also:

• drawRangeMarker(Graphics2D, CategoryPlot, ValueAxis, Marker, Rectangle2D)

drawRangeMarker

public void drawRangeMarker(Graphics2D g2,
 CategoryPlot plot,
 ValueAxis axis,
 Marker marker,
 Rectangle2D dataArea)

Draws a marker for the range axis.

Specified by:

drawRangeMarker in interface CategoryItemRenderer

Parameters:

g2 - the graphics device (not null).

plot - the plot (not null).

axis - the range axis (not null).

marker - the marker to be drawn (not null).

dataArea - the area inside the axes (not null).

See Also:

• drawDomainMarker(Graphics2D, CategoryPlot, CategoryAxis, CategoryMarker, Rectangle2D)

calculateDomainMarkerTextAnchorPoint

protected Point2D calculateDomainMarkerTextAnchorPoint(Graphics2D g2,
 PlotOrientation orientation,
 Rectangle2D dataArea,
 Rectangle2D markerArea,
 RectangleInsets markerOffset,
 LengthAdjustmentType labelOffsetType,
 RectangleAnchor anchor)

Calculates the (x, y) coordinates for drawing the label for a marker on the range axis.

Parameters:

g2 - the graphics device.

orientation - the plot orientation.

dataArea - the data area.

markerArea - the rectangle surrounding the marker.

markerOffset - the marker offset.

labelOffsetType - the label offset type.

anchor - the label anchor.

Returns:

The coordinates for drawing the marker label.

calculateRangeMarkerTextAnchorPoint

protected Point2D calculateRangeMarkerTextAnchorPoint(Graphics2D g2,
 PlotOrientation orientation,
 Rectangle2D dataArea,
 Rectangle2D markerArea,
 RectangleInsets markerOffset,
 LengthAdjustmentType labelOffsetType,
 RectangleAnchor anchor)

Calculates the (x, y) coordinates for drawing a marker label.

Parameters:

g2 - the graphics device.

orientation - the plot orientation.

dataArea - the data area.

markerArea - the rectangle surrounding the marker.

markerOffset - the marker offset.

labelOffsetType - the label offset type.

anchor - the label anchor.

Returns:

The coordinates for drawing the marker label.

getLegendItem

public LegendItem getLegendItem(int datasetIndex,
 int series)

Returns a legend item for a series. This default implementation will return null if AbstractRenderer.isSeriesVisible(int) or AbstractRenderer.isSeriesVisibleInLegend(int) returns false.

Specified by:

getLegendItem in interface CategoryItemRenderer

Parameters:

datasetIndex - the dataset index (zero-based).

series - the series index (zero-based).

Returns:

The legend item (possibly null).

See Also:

• getLegendItems()

equals

public boolean equals(Object obj)

Tests this renderer for equality with another object.

Overrides:

equals in class AbstractRenderer

Parameters:

obj - the object.

Returns:

true or false.

hashCode

public int hashCode()

Returns a hash code for the renderer.

Overrides:

hashCode in class AbstractRenderer

Returns:

The hash code.

getDrawingSupplier

public DrawingSupplier getDrawingSupplier()

Returns the drawing supplier from the plot.

Specified by:

getDrawingSupplier in class AbstractRenderer

Returns:

The drawing supplier (possibly null).

updateCrosshairValues

protected void updateCrosshairValues(CategoryCrosshairState crosshairState,
 Comparable rowKey,
 Comparable columnKey,
 double value,
 int datasetIndex,
 double transX,
 double transY,
 PlotOrientation orientation)

Considers the current (x, y) coordinate and updates the crosshair point if it meets the criteria (usually means the (x, y) coordinate is the closest to the anchor point so far).

Parameters:

crosshairState - the crosshair state (null permitted, but the method does nothing in that case).

rowKey - the row key.

columnKey - the column key.

value - the data value.

datasetIndex - the dataset index.

transX - the x-value translated to Java2D space.

transY - the y-value translated to Java2D space.

orientation - the plot orientation (null not permitted).

drawItemLabel

protected void drawItemLabel(Graphics2D g2,
 PlotOrientation orientation,
 CategoryDataset dataset,
 int row,
 int column,
 double x,
 double y,
 boolean negative)

Draws an item label.

Parameters:

g2 - the graphics device.

orientation - the orientation.

dataset - the dataset.

row - the row.

column - the column.

x - the x coordinate (in Java2D space).

y - the y coordinate (in Java2D space).

negative - indicates a negative value (which affects the item label position).

clone

public Object clone()
             throws CloneNotSupportedException

Returns an independent copy of the renderer. The plot reference is shallow copied.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractRenderer

Returns:

A clone.

Throws:

CloneNotSupportedException - can be thrown if one of the objects belonging to the renderer does not support cloning (for example, an item label generator).

getDomainAxis

protected CategoryAxis getDomainAxis(CategoryPlot plot,
 int index)

Returns a domain axis for a plot.

Parameters:

plot - the plot.

index - the axis index.

Returns:

A domain axis.

getRangeAxis

protected ValueAxis getRangeAxis(CategoryPlot plot,
 int index)

Returns a range axis for a plot.

Parameters:

plot - the plot.

index - the axis index.

Returns:

A range axis.

getLegendItems

public LegendItemCollection getLegendItems()

Returns a (possibly empty) collection of legend items for the series that this renderer is responsible for drawing.

Specified by:

getLegendItems in interface LegendItemSource

Returns:

The legend item collection (never null).

See Also:

• getLegendItem(int, int)

getLegendItemLabelGenerator

public CategorySeriesLabelGenerator getLegendItemLabelGenerator()

Returns the legend item label generator.

Returns:

The label generator (never null).

See Also:

• setLegendItemLabelGenerator(CategorySeriesLabelGenerator)

setLegendItemLabelGenerator

public void setLegendItemLabelGenerator(CategorySeriesLabelGenerator generator)

Sets the legend item label generator and sends a RendererChangeEvent to all registered listeners.

Parameters:

generator - the generator (null not permitted).

See Also:

• getLegendItemLabelGenerator()

getLegendItemToolTipGenerator

public CategorySeriesLabelGenerator getLegendItemToolTipGenerator()

Returns the legend item tool tip generator.

Returns:

The tool tip generator (possibly null).

See Also:

• setLegendItemToolTipGenerator(CategorySeriesLabelGenerator)

setLegendItemToolTipGenerator

public void setLegendItemToolTipGenerator(CategorySeriesLabelGenerator generator)

Sets the legend item tool tip generator and sends a RendererChangeEvent to all registered listeners.

Parameters:

generator - the generator (null permitted).

See Also:

• setLegendItemToolTipGenerator(CategorySeriesLabelGenerator)

getLegendItemURLGenerator

public CategorySeriesLabelGenerator getLegendItemURLGenerator()

Returns the legend item URL generator.

Returns:

The URL generator (possibly null).

See Also:

• setLegendItemURLGenerator(CategorySeriesLabelGenerator)

setLegendItemURLGenerator

public void setLegendItemURLGenerator(CategorySeriesLabelGenerator generator)

Sets the legend item URL generator and sends a RendererChangeEvent to all registered listeners.

Parameters:

generator - the generator (null permitted).

See Also:

• getLegendItemURLGenerator()

addItemEntity

protected void addItemEntity(EntityCollection entities,
 CategoryDataset dataset,
 int row,
 int column,
 Shape hotspot)

Adds an entity with the specified hotspot.

Parameters:

entities - the entity collection.

dataset - the dataset.

row - the row index.

column - the column index.

hotspot - the hotspot (null not permitted).

addEntity

protected void addEntity(EntityCollection entities,
 Shape hotspot,
 CategoryDataset dataset,
 int row,
 int column,
 double entityX,
 double entityY)

Adds an entity to the collection.

Parameters:

entities - the entity collection being populated.

hotspot - the entity area (if null a default will be used).

dataset - the dataset.

row - the series.

column - the item.

entityX - the entity's center x-coordinate in user space (only used if area is null).

entityY - the entity's center y-coordinate in user space (only used if area is null).