org.jfree.chart.renderer.xy

Class XYBlockRenderer

public class XYBlockRenderer extends AbstractXYItemRenderer implements XYItemRenderer, Cloneable, 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.

Since: 1.0.4

Constructor Summary
XYBlockRenderer()
Creates a new XYBlockRenderer instance with default attributes.
Method Summary
Objectclone()
Returns a clone of this 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 block representing the specified item.
booleanequals(Object obj)
Tests this XYBlockRenderer for equality with an arbitrary object.
RangefindDomainBounds(XYDataset dataset)
Returns the lower and upper bounds (range) of the x-values in the specified dataset.
RangefindRangeBounds(XYDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.
RectangleAnchorgetBlockAnchor()
Returns the anchor point used to align a block at its (x, y) location.
doublegetBlockHeight()
Returns the block height, in data/axis units.
doublegetBlockWidth()
Returns the block width, in data/axis units.
PaintScalegetPaintScale()
Returns the paint scale used by the renderer.
voidsetBlockAnchor(RectangleAnchor anchor)
Sets the anchor point used to align a block at its (x, y) location and sends a RendererChangeEvent to all registered listeners.
voidsetBlockHeight(double height)
Sets the height of the blocks used to represent each data item.
voidsetBlockWidth(double width)
Sets the width of the blocks used to represent each data item.
voidsetPaintScale(PaintScale scale)
Sets the paint scale used by the renderer.

Constructor Detail

XYBlockRenderer

public XYBlockRenderer()
Creates a new XYBlockRenderer instance with default attributes.

Method Detail

clone

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

Returns: A clone of this renderer.

Throws: CloneNotSupportedException if there is a problem creating the clone.

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.

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:

Parameters: obj the object (null permitted).

Returns: A boolean.

findDomainBounds

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

Parameters: dataset the dataset (null permitted).

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

findRangeBounds

public Range findRangeBounds(XYDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.

Parameters: dataset the dataset (null permitted).

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

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

getBlockHeight

public double getBlockHeight()
Returns the block height, in data/axis units.

Returns: The block height.

See Also: XYBlockRenderer

getBlockWidth

public double getBlockWidth()
Returns the block width, in data/axis units.

Returns: The block width.

See Also: XYBlockRenderer

getPaintScale

public PaintScale getPaintScale()
Returns the paint scale used by the renderer.

Returns: The paint scale (never null).

Since: 1.0.4

See Also: setPaintScale

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

setBlockHeight

public void setBlockHeight(double height)
Sets the height of the blocks used to represent each data item.

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

See Also: getBlockHeight

setBlockWidth

public void setBlockWidth(double width)
Sets the width of the blocks used to represent each data item.

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

See Also: getBlockWidth

setPaintScale

public void setPaintScale(PaintScale scale)
Sets the paint scale used by the renderer.

Parameters: scale the scale (null not permitted).

Since: 1.0.4

See Also: getPaintScale