XYBlockRenderer.java
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2022, by David Gilbert and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* --------------------
* XYBlockRenderer.java
* --------------------
* (C) Copyright 2006-2022, by David Gilbert.
*
* Original Author: David Gilbert;
* Contributor(s): -;
*
*/
package org.jfree.chart.renderer.xy;
import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.geom.Rectangle2D;
import java.io.Serializable;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.entity.EntityCollection;
import org.jfree.chart.event.RendererChangeEvent;
import org.jfree.chart.plot.CrosshairState;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.plot.PlotRenderingInfo;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.renderer.LookupPaintScale;
import org.jfree.chart.renderer.PaintScale;
import org.jfree.chart.api.RectangleAnchor;
import org.jfree.chart.internal.Args;
import org.jfree.chart.api.PublicCloneable;
import org.jfree.data.Range;
import org.jfree.data.general.DatasetUtils;
import org.jfree.data.xy.XYDataset;
import org.jfree.data.xy.XYZDataset;
/**
* A renderer that represents data from an {@link 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
* {@code XYBlockChartDemo1.java} program included in the JFreeChart
* demo collection:
* <br><br>
* <img src="doc-files/XYBlockRendererSample.png" alt="XYBlockRendererSample.png">
*/
public class XYBlockRenderer extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, PublicCloneable, Serializable {
/**
* The block width (defaults to 1.0).
*/
private double blockWidth = 1.0;
/**
* The block height (defaults to 1.0).
*/
private double blockHeight = 1.0;
/**
* The anchor point used to align each block to its (x, y) location. The
* default value is {@code RectangleAnchor.CENTER}.
*/
private RectangleAnchor blockAnchor = RectangleAnchor.CENTER;
/** Temporary storage for the x-offset used to align the block anchor. */
private double xOffset;
/** Temporary storage for the y-offset used to align the block anchor. */
private double yOffset;
/** The paint scale. */
private PaintScale paintScale;
/** A flag that controls whether outlines are drawn for blocks. */
private boolean drawOutlines;
/**
* A flag that controls whether the outline paint is used for drawing block
* outlines.
*/
private boolean useOutlinePaint;
/**
* Creates a new {@code XYBlockRenderer} instance with default
* attributes.
*/
public XYBlockRenderer() {
updateOffsets();
this.paintScale = new LookupPaintScale();
this.drawOutlines = true;
this.useOutlinePaint = false; // use item paint by default
}
/**
* Returns the block width, in data/axis units.
*
* @return The block width.
*
* @see #setBlockWidth(double)
*/
public double getBlockWidth() {
return this.blockWidth;
}
/**
* Sets the width of the blocks used to represent each data item and
* sends a {@link RendererChangeEvent} to all registered listeners.
*
* @param width the new width, in data/axis units (must be > 0.0).
*
* @see #getBlockWidth()
*/
public void setBlockWidth(double width) {
if (width <= 0.0) {
throw new IllegalArgumentException(
"The 'width' argument must be > 0.0");
}
this.blockWidth = width;
updateOffsets();
fireChangeEvent();
}
/**
* Returns the block height, in data/axis units.
*
* @return The block height.
*
* @see #setBlockHeight(double)
*/
public double getBlockHeight() {
return this.blockHeight;
}
/**
* Sets the height of the blocks used to represent each data item and
* sends a {@link RendererChangeEvent} to all registered listeners.
*
* @param height the new height, in data/axis units (must be > 0.0).
*
* @see #getBlockHeight()
*/
public void setBlockHeight(double height) {
if (height <= 0.0) {
throw new IllegalArgumentException(
"The 'height' argument must be > 0.0");
}
this.blockHeight = height;
updateOffsets();
fireChangeEvent();
}
/**
* Returns the anchor point used to align a block at its (x, y) location.
* The default values is {@link RectangleAnchor#CENTER}.
*
* @return The anchor point (never {@code null}).
*
* @see #setBlockAnchor(RectangleAnchor)
*/
public RectangleAnchor getBlockAnchor() {
return this.blockAnchor;
}
/**
* Sets the anchor point used to align a block at its (x, y) location and
* sends a {@link RendererChangeEvent} to all registered listeners.
*
* @param anchor the anchor.
*
* @see #getBlockAnchor()
*/
public void setBlockAnchor(RectangleAnchor anchor) {
Args.nullNotPermitted(anchor, "anchor");
if (this.blockAnchor.equals(anchor)) {
return; // no change
}
this.blockAnchor = anchor;
updateOffsets();
fireChangeEvent();
}
/**
* Returns the paint scale used by the renderer.
*
* @return The paint scale (never {@code null}).
*
* @see #setPaintScale(PaintScale)
*/
public PaintScale getPaintScale() {
return this.paintScale;
}
/**
* Sets the paint scale used by the renderer and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param scale the scale ({@code null} not permitted).
*
* @see #getPaintScale()
*/
public void setPaintScale(PaintScale scale) {
Args.nullNotPermitted(scale, "scale");
this.paintScale = scale;
fireChangeEvent();
}
/**
* Returns {@code true} if outlines should be drawn for blocks, and
* {@code false} otherwise. The default value is {@code true}.
*
* @return A boolean.
*
* @see #setDrawOutlines(boolean)
*/
public boolean getDrawOutlines() {
return this.drawOutlines;
}
/**
* Sets the flag that controls whether outlines are drawn for
* blocks, and sends a {@link RendererChangeEvent} to all registered
* listeners.
*
* @param flag the flag.
*
* @see #getDrawOutlines()
*/
public void setDrawOutlines(boolean flag) {
this.drawOutlines = flag;
fireChangeEvent();
}
/**
* Returns {@code true} if the renderer should use the outline paint
* setting to draw block outlines, and {@code false} if it should just
* use the regular item paint.
*
* @return A boolean.
*
* @see #setUseOutlinePaint(boolean)
*/
public boolean getUseOutlinePaint() {
return this.useOutlinePaint;
}
/**
* Sets the flag that controls whether the outline paint is used to draw
* block outlines, and sends a {@link RendererChangeEvent} to all
* registered listeners.
*
* @param flag the flag.
*
* @see #getUseOutlinePaint()
*/
public void setUseOutlinePaint(boolean flag) {
this.useOutlinePaint = flag;
fireChangeEvent();
}
/**
* Updates the offsets to take into account the block width, height and
* anchor.
*/
private void updateOffsets() {
if (this.blockAnchor.equals(RectangleAnchor.BOTTOM_LEFT)) {
this.xOffset = 0.0;
this.yOffset = 0.0;
}
else if (this.blockAnchor.equals(RectangleAnchor.BOTTOM)) {
this.xOffset = -this.blockWidth / 2.0;
this.yOffset = 0.0;
}
else if (this.blockAnchor.equals(RectangleAnchor.BOTTOM_RIGHT)) {
this.xOffset = -this.blockWidth;
this.yOffset = 0.0;
}
else if (this.blockAnchor.equals(RectangleAnchor.LEFT)) {
this.xOffset = 0.0;
this.yOffset = -this.blockHeight / 2.0;
}
else if (this.blockAnchor.equals(RectangleAnchor.CENTER)) {
this.xOffset = -this.blockWidth / 2.0;
this.yOffset = -this.blockHeight / 2.0;
}
else if (this.blockAnchor.equals(RectangleAnchor.RIGHT)) {
this.xOffset = -this.blockWidth;
this.yOffset = -this.blockHeight / 2.0;
}
else if (this.blockAnchor.equals(RectangleAnchor.TOP_LEFT)) {
this.xOffset = 0.0;
this.yOffset = -this.blockHeight;
}
else if (this.blockAnchor.equals(RectangleAnchor.TOP)) {
this.xOffset = -this.blockWidth / 2.0;
this.yOffset = -this.blockHeight;
}
else if (this.blockAnchor.equals(RectangleAnchor.TOP_RIGHT)) {
this.xOffset = -this.blockWidth;
this.yOffset = -this.blockHeight;
}
}
/**
* Returns the lower and upper bounds (range) of the x-values in the
* specified dataset.
*
* @param dataset the dataset ({@code null} permitted).
*
* @return The range ({@code null} if the dataset is {@code null}
* or empty).
*
* @see #findRangeBounds(XYDataset)
*/
@Override
public Range findDomainBounds(XYDataset dataset) {
if (dataset == null) {
return null;
}
Range r = DatasetUtils.findDomainBounds(dataset, false);
if (r == null) {
return null;
}
return new Range(r.getLowerBound() + this.xOffset,
r.getUpperBound() + this.blockWidth + this.xOffset);
}
/**
* Returns the range of values the renderer requires to display all the
* items from the specified dataset.
*
* @param dataset the dataset ({@code null} permitted).
*
* @return The range ({@code null} if the dataset is {@code null}
* or empty).
*
* @see #findDomainBounds(XYDataset)
*/
@Override
public Range findRangeBounds(XYDataset dataset) {
if (dataset != null) {
Range r = DatasetUtils.findRangeBounds(dataset, false);
if (r == null) {
return null;
}
else {
return new Range(r.getLowerBound() + this.yOffset,
r.getUpperBound() + this.blockHeight + this.yOffset);
}
}
else {
return null;
}
}
/**
* Draws the block representing the specified item.
*
* @param g2 the graphics device.
* @param state the state.
* @param dataArea the data area.
* @param info the plot rendering info.
* @param plot the plot.
* @param domainAxis the x-axis.
* @param rangeAxis the y-axis.
* @param dataset the dataset.
* @param series the series index.
* @param item the item index.
* @param crosshairState the crosshair state.
* @param pass the pass index.
*/
@Override
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) {
double x = dataset.getXValue(series, item);
double y = dataset.getYValue(series, item);
double z = 0.0;
if (dataset instanceof XYZDataset) {
z = ((XYZDataset) dataset).getZValue(series, item);
}
Paint p = this.paintScale.getPaint(z);
double xx0 = domainAxis.valueToJava2D(x + this.xOffset, dataArea,
plot.getDomainAxisEdge());
double yy0 = rangeAxis.valueToJava2D(y + this.yOffset, dataArea,
plot.getRangeAxisEdge());
double xx1 = domainAxis.valueToJava2D(x + this.blockWidth
+ this.xOffset, dataArea, plot.getDomainAxisEdge());
double yy1 = rangeAxis.valueToJava2D(y + this.blockHeight
+ this.yOffset, dataArea, plot.getRangeAxisEdge());
Rectangle2D block;
PlotOrientation orientation = plot.getOrientation();
if (orientation.equals(PlotOrientation.HORIZONTAL)) {
block = new Rectangle2D.Double(Math.min(yy0, yy1),
Math.min(xx0, xx1), Math.abs(yy1 - yy0),
Math.abs(xx0 - xx1));
}
else {
block = new Rectangle2D.Double(Math.min(xx0, xx1),
Math.min(yy0, yy1), Math.abs(xx1 - xx0),
Math.abs(yy1 - yy0));
}
g2.setPaint(p);
g2.fill(block);
if (getDrawOutlines()) {
if (getUseOutlinePaint()) {
g2.setPaint(getItemOutlinePaint(series, item));
}
g2.setStroke(lookupSeriesOutlineStroke(series));
g2.draw(block);
}
if (isItemLabelVisible(series, item)) {
drawItemLabel(g2, orientation, dataset, series, item,
block.getCenterX(), block.getCenterY(), y < 0.0);
}
int datasetIndex = plot.indexOf(dataset);
double transX = domainAxis.valueToJava2D(x, dataArea,
plot.getDomainAxisEdge());
double transY = rangeAxis.valueToJava2D(y, dataArea,
plot.getRangeAxisEdge());
updateCrosshairValues(crosshairState, x, y, datasetIndex,
transX, transY, orientation);
EntityCollection entities = state.getEntityCollection();
if (entities != null) {
addEntity(entities, block, dataset, series, item,
block.getCenterX(), block.getCenterY());
}
}
/**
* Tests this {@code XYBlockRenderer} for equality with an arbitrary
* object. This method returns {@code true} if and only if:
* <ul>
* <li>{@code obj} is an instance of {@code XYBlockRenderer} (not
* {@code null});</li>
* <li>{@code obj} has the same field values as this
* {@code XYBlockRenderer};</li>
* </ul>
*
* @param obj the object ({@code null} permitted).
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof XYBlockRenderer)) {
return false;
}
XYBlockRenderer that = (XYBlockRenderer) obj;
if (this.blockHeight != that.blockHeight) {
return false;
}
if (this.blockWidth != that.blockWidth) {
return false;
}
if (!this.blockAnchor.equals(that.blockAnchor)) {
return false;
}
if (!this.paintScale.equals(that.paintScale)) {
return false;
}
if (this.drawOutlines != that.drawOutlines) {
return false;
}
if (this.useOutlinePaint != that.useOutlinePaint) {
return false;
}
return super.equals(obj);
}
/**
* Returns a clone of this renderer.
*
* @return A clone of this renderer.
*
* @throws CloneNotSupportedException if there is a problem creating the
* clone.
*/
@Override
public Object clone() throws CloneNotSupportedException {
XYBlockRenderer clone = (XYBlockRenderer) super.clone();
if (this.paintScale instanceof PublicCloneable) {
PublicCloneable pc = (PublicCloneable) this.paintScale;
clone.paintScale = (PaintScale) pc.clone();
}
return clone;
}
}