Module org.jfree.chart

Package org.jfree.chart.renderer.xy

Class XYBlockRenderer

java.lang.Object

org.jfree.chart.renderer.AbstractRenderer

org.jfree.chart.renderer.xy.AbstractXYItemRenderer

org.jfree.chart.renderer.xy.XYBlockRenderer

All Implemented Interfaces:

Serializable, Cloneable, EventListener, PublicCloneable, ChartElement, AnnotationChangeListener, org.jfree.chart.legend.LegendItemSource, XYItemRenderer

public class XYBlockRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, PublicCloneable, Serializable

A renderer that represents data from an XYZDataset by drawing a color block at each (x, y) point, where the color is a function of the z-value from the dataset. The example shown here is generated by the XYBlockChartDemo1.java program included in the JFreeChart demo collection:

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

Constructor	Description
XYBlockRenderer()	Creates a new XYBlockRenderer instance with default attributes.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone of this 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 block representing the specified item.
boolean	equals(Object obj)	Tests this XYBlockRenderer for equality with an arbitrary object.
Range	findDomainBounds(XYDataset dataset)	Returns the lower and upper bounds (range) of the x-values in the specified dataset.
Range	findRangeBounds(XYDataset dataset)	Returns the range of values the renderer requires to display all the items from the specified dataset.
RectangleAnchor	getBlockAnchor()	Returns the anchor point used to align a block at its (x, y) location.
double	getBlockHeight()	Returns the block height, in data/axis units.
double	getBlockWidth()	Returns the block width, in data/axis units.
boolean	getDrawOutlines()	Returns true if outlines should be drawn for blocks, and false otherwise.
PaintScale	getPaintScale()	Returns the paint scale used by the renderer.
boolean	getUseOutlinePaint()	Returns true if the renderer should use the outline paint setting to draw block outlines, and false if it should just use the regular item paint.
void	setBlockAnchor(RectangleAnchor anchor)	Sets the anchor point used to align a block at its (x, y) location and sends a RendererChangeEvent to all registered listeners.
void	setBlockHeight(double height)	Sets the height of the blocks used to represent each data item and sends a RendererChangeEvent to all registered listeners.
void	setBlockWidth(double width)	Sets the width of the blocks used to represent each data item and sends a RendererChangeEvent to all registered listeners.
void	setDrawOutlines(boolean flag)	Sets the flag that controls whether outlines are drawn for blocks, and sends a RendererChangeEvent to all registered listeners.
void	setPaintScale(PaintScale scale)	Sets the paint scale used by the renderer 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 block outlines, and sends a RendererChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer

addAnnotation, addAnnotation, addEntity, annotationChanged, beginElementGroup, calculateDomainMarkerTextAnchorPoint, drawAnnotations, drawDomainLine, drawDomainMarker, drawItemLabel, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findRangeBounds, getAnnotations, getDefaultItemLabelGenerator, getDefaultToolTipGenerator, getDrawingSupplier, getItemLabelGenerator, getLegendItem, getLegendItemLabelGenerator, getLegendItems, getLegendItemToolTipGenerator, getLegendItemURLGenerator, getPassCount, getPlot, getSeriesItemLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getURLGenerator, hashCode, initialise, lineTo, moveTo, removeAnnotation, removeAnnotations, setDefaultItemLabelGenerator, setDefaultToolTipGenerator, setLegendItemLabelGenerator, setLegendItemToolTipGenerator, setLegendItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesToolTipGenerator, setURLGenerator, updateCrosshairValues

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, receive, 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.ChartElement

receive

Methods inherited from interface org.jfree.chart.legend.LegendItemSource

getLegendItems

Methods inherited from interface org.jfree.chart.renderer.xy.XYItemRenderer

addAnnotation, addAnnotation, addChangeListener, drawAnnotations, drawDomainLine, drawDomainMarker, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, getAnnotations, getDefaultCreateEntities, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelGenerator, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getDefaultToolTipGenerator, getItemCreateEntity, getItemFillPaint, getItemLabelFont, getItemLabelGenerator, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendItem, getLegendItemLabelGenerator, getNegativeItemLabelPosition, getPassCount, getPlot, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelGenerator, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisibleInLegend, getToolTipGenerator, getURLGenerator, initialise, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, removeAnnotation, removeAnnotations, removeChangeListener, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultFillPaint, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelGenerator, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setDefaultToolTipGenerator, setLegendItemLabelGenerator, setPlot, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelGenerator, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesToolTipGenerator, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setURLGenerator

Constructor Detail

XYBlockRenderer

public XYBlockRenderer()

Creates a new XYBlockRenderer instance with default attributes.

Method Detail

getBlockWidth

public double getBlockWidth()

Returns the block width, in data/axis units.

Returns:

The block width.

See Also:

setBlockWidth(double)

setBlockWidth

public void setBlockWidth(double width)

Sets the width of the blocks used to represent each data item and sends a RendererChangeEvent to all registered listeners.

Parameters:

width - the new width, in data/axis units (must be > 0.0).

See Also:

getBlockWidth()

getBlockHeight

public double getBlockHeight()

Returns the block height, in data/axis units.

Returns:

The block height.

See Also:

setBlockHeight(double)

setBlockHeight

public void setBlockHeight(double height)

Sets the height of the blocks used to represent each data item and sends a RendererChangeEvent to all registered listeners.

Parameters:

height - the new height, in data/axis units (must be > 0.0).

See Also:

getBlockHeight()

getBlockAnchor

public RectangleAnchor getBlockAnchor()

Returns the anchor point used to align a block at its (x, y) location. The default values is RectangleAnchor.CENTER.

Returns:

The anchor point (never null).

See Also:

setBlockAnchor(RectangleAnchor)

setBlockAnchor

public void setBlockAnchor(RectangleAnchor anchor)

Sets the anchor point used to align a block at its (x, y) location and sends a RendererChangeEvent to all registered listeners.

Parameters:

anchor - the anchor.

See Also:

getBlockAnchor()

getPaintScale

public PaintScale getPaintScale()

Returns the paint scale used by the renderer.

Returns:

The paint scale (never null).

See Also:

setPaintScale(PaintScale)

setPaintScale

public void setPaintScale(PaintScale scale)

Sets the paint scale used by the renderer and sends a RendererChangeEvent to all registered listeners.

Parameters:

scale - the scale (null not permitted).

See Also:

getPaintScale()

getDrawOutlines

public boolean getDrawOutlines()

Returns true if outlines should be drawn for blocks, and false otherwise. The default value is true.

Returns:

A boolean.

See Also:

setDrawOutlines(boolean)

setDrawOutlines

public void setDrawOutlines(boolean flag)

Sets the flag that controls whether outlines are drawn for blocks, and sends a RendererChangeEvent to all registered listeners.

Parameters:

flag - the flag.

See Also:

getDrawOutlines()

getUseOutlinePaint

public boolean getUseOutlinePaint()

Returns true if the renderer should use the outline paint setting to draw block outlines, and false if it should just use the regular item paint.

Returns:

A boolean.

See Also:

setUseOutlinePaint(boolean)

setUseOutlinePaint

public void setUseOutlinePaint(boolean flag)

Sets the flag that controls whether the outline paint is used to draw block outlines, and sends a RendererChangeEvent to all registered listeners.

Parameters:

flag - the flag.

See Also:

getUseOutlinePaint()

findDomainBounds

public Range findDomainBounds(XYDataset dataset)

Returns the lower and upper bounds (range) of the x-values in the specified dataset.

Specified by:

findDomainBounds in interface XYItemRenderer

Overrides:

findDomainBounds in class AbstractXYItemRenderer

Parameters:

dataset - the dataset (null permitted).

Returns:

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

See Also:

findRangeBounds(XYDataset)

findRangeBounds

public Range findRangeBounds(XYDataset dataset)

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

Specified by:

findRangeBounds in interface XYItemRenderer

Overrides:

findRangeBounds in class AbstractXYItemRenderer

Parameters:

dataset - the dataset (null permitted).

Returns:

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

See Also:

findDomainBounds(XYDataset)

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 block representing the specified item.

Specified by:

drawItem in interface XYItemRenderer

Parameters:

g2 - the graphics device.

state - the state.

dataArea - the data area.

info - the plot rendering info.

plot - the plot.

domainAxis - the x-axis.

rangeAxis - the y-axis.

dataset - the dataset.

series - the series index.

item - the item index.

crosshairState - the crosshair state.

pass - the pass index.

equals

public boolean equals(Object obj)

Tests this XYBlockRenderer for equality with an arbitrary object. This method returns true if and only if:

• obj is an instance of XYBlockRenderer (not null);
• obj has the same field values as this XYBlockRenderer;

Overrides:

equals in class AbstractXYItemRenderer

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this renderer.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractXYItemRenderer

Returns:

A clone of this renderer.

Throws:

CloneNotSupportedException - if there is a problem creating the clone.