/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2004, by Object Refinery Limited 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., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
* -------------------------
* LineAndShapeRenderer.java
* -------------------------
* (C) Copyright 2001-2004, by Object Refinery Limited and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): Mark Watson (www.markwatson.com);
* Jeremy Bowman;
* Richard Atkinson;
* Christian W. Zuckschwerdt;
*
* $Id: LineAndShapeRenderer.java,v 1.1 2004/08/31 14:47:48 mungady Exp $
*
* Changes
* -------
* 23-Oct-2001 : Version 1 (DG);
* 15-Nov-2001 : Modified to allow for null data values (DG);
* 16-Jan-2002 : Renamed HorizontalCategoryItemRenderer.java --> CategoryItemRenderer.java (DG);
* 05-Feb-2002 : Changed return type of the drawCategoryItem method from void to Shape, as part
* of the tooltips implementation (DG);
* 11-May-2002 : Support for value label drawing (JB);
* 29-May-2002 : Now extends AbstractCategoryItemRenderer (DG);
* 25-Jun-2002 : Removed redundant import (DG);
* 05-Aug-2002 : Small modification to drawCategoryItem method to support URLs for
* HTML image maps (RA);
* 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
* 11-Oct-2002 : Added new constructor to incorporate tool tip and URL generators (DG);
* 24-Oct-2002 : Amendments for changes in CategoryDataset interface and CategoryToolTipGenerator
* interface (DG);
* 05-Nov-2002 : Base dataset is now TableDataset not CategoryDataset (DG);
* 06-Nov-2002 : Renamed drawCategoryItem() --> drawItem() and now using axis for
* category spacing (DG);
* 17-Jan-2003 : Moved plot classes to a separate package (DG);
* 10-Apr-2003 : Changed CategoryDataset to KeyedValues2DDataset in drawItem() method (DG);
* 12-May-2003 : Modified to take into account the plot orientation (DG);
* 29-Jul-2003 : Amended code that doesn't compile with JDK 1.2.2 (DG);
* 30-Jul-2003 : Modified entity constructor (CZ);
* 22-Sep-2003 : Fixed cloning (DG);
* 10-Feb-2004 : Small change to drawItem() method to make cut-and-paste override easier (DG);
* 16-Jun-2004 : Fixed bug (id=972454) with label positioning on horizontal charts (DG);
*
*/
package org.jfree.chart.renderer.category;
import java.awt.Graphics2D;
import java.awt.Shape;
import java.awt.geom.Line2D;
import java.awt.geom.Rectangle2D;
import java.io.Serializable;
import org.jfree.chart.axis.CategoryAxis;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.entity.CategoryItemEntity;
import org.jfree.chart.entity.EntityCollection;
import org.jfree.chart.event.RendererChangeEvent;
import org.jfree.chart.labels.CategoryToolTipGenerator;
import org.jfree.chart.plot.CategoryPlot;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.data.category.CategoryDataset;
import org.jfree.util.BooleanList;
import org.jfree.util.ObjectUtils;
import org.jfree.util.PublicCloneable;
/**
* A renderer that draws shapes for each data item, and lines between data items.
* <p>
* For use with the {@link CategoryPlot} class.
*/
public class LineAndShapeRenderer extends AbstractCategoryItemRenderer
implements Cloneable, PublicCloneable, Serializable {
/** Useful constant for specifying the type of rendering (shapes only). */
public static final int SHAPES = 1;
/** Useful constant for specifying the type of rendering (lines only). */
public static final int LINES = 2;
/** Useful constant for specifying the type of rendering (shapes and lines). */
public static final int SHAPES_AND_LINES = 3;
/** Constant indicating that labels are to be shown above data points */
public static final int TOP = 1;
/** Constant indicating that labels are to be shown below data points */
public static final int BOTTOM = 2;
/** Constant indicating that labels are to be shown left of data points */
public static final int LEFT = 3;
/** Constant indicating that labels are to be shown right of data points */
public static final int RIGHT = 4;
/** A flag indicating whether or not shapes are drawn at each XY point. */
private boolean drawShapes;
/** A flag indicating whether or not lines are drawn between XY points. */
private boolean drawLines;
/** A flag that controls whether or not shapes are filled for ALL series. */
private Boolean shapesFilled;
/** A table of flags that control (per series) whether or not shapes are filled. */
private BooleanList seriesShapesFilled;
/** The default value returned by the getShapeFilled(...) method. */
private Boolean defaultShapesFilled;
/** A flag that controls whether the fill paint is used for drawing shape outlines. */
private boolean useFillPaintForShapeOutline = false;
/**
* Constructs a default renderer (draws shapes and lines).
*/
public LineAndShapeRenderer() {
this(SHAPES_AND_LINES);
}
/**
* Constructs a renderer of the specified type.
* <P>
* Use one of the constants SHAPES, LINES or SHAPES_AND_LINES.
*
* @param type the type of renderer.
*
*/
public LineAndShapeRenderer(int type) {
super();
if (type == SHAPES) {
this.drawShapes = true;
}
if (type == LINES) {
this.drawLines = true;
}
if (type == SHAPES_AND_LINES) {
this.drawShapes = true;
this.drawLines = true;
}
this.shapesFilled = null;
this.seriesShapesFilled = new BooleanList();
this.defaultShapesFilled = Boolean.TRUE;
}
/**
* Returns the flag that controls whether the fill paint is used for shape outlines.
*
* @return A boolean.
*/
public boolean getUseFillPaintForShapeOutline() {
return this.useFillPaintForShapeOutline;
}
/**
* Sets the flag that controls whether the fill paint is used for shape outlines.
*
* @param use the flag.
*/
public void setUseFillPaintForShapeOutline(boolean use) {
this.useFillPaintForShapeOutline = use;
}
/**
* Returns <code>true</code> if a shape should be drawn to represent each data point, and
* <code>false</code> otherwise.
*
* @return A boolean flag.
*/
public boolean isDrawShapes() {
return this.drawShapes;
}
/**
* Sets the flag that controls whether or not a shape should be drawn to represent each data
* point.
*
* @param draw the new value of the flag.
*/
public void setDrawShapes(boolean draw) {
if (draw != this.drawShapes) {
this.drawShapes = draw;
notifyListeners(new RendererChangeEvent(this));
}
}
/**
* Returns <code>true</code> if a line should be drawn from the previous to the current data
* point, and <code>false</code> otherwise.
*
* @return A boolean flag.
*/
public boolean isDrawLines() {
return this.drawLines;
}
/**
* Sets the flag that controls whether or not lines are drawn between consecutive data points.
*
* @param draw the new value of the flag.
*/
public void setDrawLines(boolean draw) {
if (draw != this.drawLines) {
this.drawLines = draw;
notifyListeners(new RendererChangeEvent(this));
}
}
// SHAPES FILLED
/**
* Returns the flag used to control whether or not the shape for an item is filled.
* <p>
* The default implementation passes control to the <code>getSeriesShapesFilled</code> method.
* You can override this method if you require different behaviour.
*
* @param series the series index (zero-based).
* @param item the item index (zero-based).
*
* @return A boolean.
*/
public boolean getItemShapeFilled(int series, int item) {
return getSeriesShapesFilled(series);
}
/**
* Returns the flag used to control whether or not the shapes for a series are filled.
*
* @param series the series index (zero-based).
*
* @return A boolean.
*/
public boolean getSeriesShapesFilled(int series) {
// return the overall setting, if there is one...
if (this.shapesFilled != null) {
return this.shapesFilled.booleanValue();
}
// otherwise look up the paint table
Boolean flag = this.seriesShapesFilled.getBoolean(series);
if (flag != null) {
return flag.booleanValue();
}
else {
return this.defaultShapesFilled.booleanValue();
}
}
/**
* Returns the flag that controls whether or not shapes are filled for ALL series.
*
* @return A Boolean.
*/
public Boolean getShapesFilled() {
return this.shapesFilled;
}
/**
* Sets the 'shapes filled' for ALL series.
*
* @param filled the flag.
*/
public void setShapesFilled(boolean filled) {
if (filled) {
setShapesFilled(Boolean.TRUE);
}
else {
setShapesFilled(Boolean.FALSE);
}
}
/**
* Sets the 'shapes filled' for ALL series.
*
* @param filled the flag (<code>null</code> permitted).
*/
public void setShapesFilled(Boolean filled) {
this.shapesFilled = filled;
}
/**
* Sets the 'shapes filled' flag for a series.
*
* @param series the series index (zero-based).
* @param filled the flag.
*/
public void setSeriesShapesFilled(int series, Boolean filled) {
this.seriesShapesFilled.setBoolean(series, filled);
}
/**
* Sets the 'shapes filled' flag for a series.
*
* @param series the series index (zero-based).
* @param filled the flag.
*/
public void setSeriesShapesFilled(int series, boolean filled) {
this.seriesShapesFilled.setBoolean(series, new Boolean(filled));
}
/**
* Returns the default 'shape filled' attribute.
*
* @return The default flag.
*/
public Boolean getDefaultShapesFilled() {
return this.defaultShapesFilled;
}
/**
* Sets the default 'shapes filled' flag.
*
* @param flag the flag.
*/
public void setDefaultShapesFilled(Boolean flag) {
this.defaultShapesFilled = flag;
}
/**
* Sets the default 'shapes filled' flag.
*
* @param flag the flag.
*/
public void setDefaultShapesFilled(boolean flag) {
setDefaultShapesFilled(new Boolean(flag));
}
/**
* Draw a single data item.
*
* @param g2 the graphics device.
* @param state the renderer state.
* @param dataArea the area in which the data is drawn.
* @param plot the plot.
* @param domainAxis the domain axis.
* @param rangeAxis the range axis.
* @param dataset the dataset.
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*/
public void drawItem(Graphics2D g2,
CategoryItemRendererState state,
Rectangle2D dataArea,
CategoryPlot plot,
CategoryAxis domainAxis,
ValueAxis rangeAxis,
CategoryDataset dataset,
int row,
int column) {
// nothing is drawn for null...
Number v = dataset.getValue(row, column);
if (v == null) {
return;
}
PlotOrientation orientation = plot.getOrientation();
// current data point...
double x1 = domainAxis.getCategoryMiddle(
column, getColumnCount(), dataArea, plot.getDomainAxisEdge()
);
double value = v.doubleValue();
double y1 = rangeAxis.valueToJava2D(value, dataArea, plot.getRangeAxisEdge());
Shape shape = getItemShape(row, column);
if (orientation == PlotOrientation.HORIZONTAL) {
shape = createTransformedShape(shape, y1, x1);
}
else if (orientation == PlotOrientation.VERTICAL) {
shape = createTransformedShape(shape, x1, y1);
}
if (isDrawShapes()) {
if (getItemShapeFilled(row, column)) {
g2.setPaint(getItemPaint(row, column));
g2.fill(shape);
}
else {
if (this.useFillPaintForShapeOutline) {
g2.setPaint(getItemPaint(row, column));
}
else {
g2.setPaint(getItemOutlinePaint(row, column));
}
g2.setStroke(getItemOutlineStroke(row, column));
g2.draw(shape);
}
}
if (isDrawLines()) {
if (column != 0) {
Number previousValue = dataset.getValue(row, column - 1);
if (previousValue != null) {
// previous data point...
double previous = previousValue.doubleValue();
double x0 = domainAxis.getCategoryMiddle(
column - 1, getColumnCount(), dataArea, plot.getDomainAxisEdge()
);
double y0 = rangeAxis.valueToJava2D(
previous, dataArea, plot.getRangeAxisEdge()
);
Line2D line = null;
if (orientation == PlotOrientation.HORIZONTAL) {
line = new Line2D.Double(y0, x0, y1, x1);
}
else if (orientation == PlotOrientation.VERTICAL) {
line = new Line2D.Double(x0, y0, x1, y1);
}
g2.setPaint(getItemPaint(row, column));
g2.setStroke(getItemStroke(row, column));
g2.draw(line);
}
}
}
// draw the item label if there is one...
if (isItemLabelVisible(row, column)) {
if (orientation == PlotOrientation.HORIZONTAL) {
drawItemLabel(g2, orientation, dataset, row, column, y1, x1, (value < 0.0));
}
else if (orientation == PlotOrientation.VERTICAL) {
drawItemLabel(g2, orientation, dataset, row, column, x1, y1, (value < 0.0));
}
}
// collect entity and tool tip information...
if (state.getInfo() != null) {
EntityCollection entities = state.getInfo().getOwner().getEntityCollection();
if (entities != null && shape != null) {
String tip = null;
CategoryToolTipGenerator tipster = getToolTipGenerator(row, column);
if (tipster != null) {
tip = tipster.generateToolTip(dataset, row, column);
}
String url = null;
if (getItemURLGenerator(row, column) != null) {
url = getItemURLGenerator(row, column).generateURL(dataset, row, column);
}
CategoryItemEntity entity = new CategoryItemEntity(
shape, tip, url, dataset, row, dataset.getColumnKey(column), column
);
entities.addEntity(entity);
}
}
}
/**
* Tests this renderer for equality with another object.
*
* @param obj the object.
*
* @return <code>true</code> or <code>false</code>.
*/
public boolean equals(Object obj) {
boolean result = super.equals(obj);
if (obj instanceof LineAndShapeRenderer) {
LineAndShapeRenderer r = (LineAndShapeRenderer) obj;
boolean b0 = (r.drawLines == this.drawLines);
boolean b1 = (r.drawShapes == this.drawShapes);
boolean b2 = ObjectUtils.equal(r.shapesFilled, this.shapesFilled);
boolean b3 = ObjectUtils.equal(r.seriesShapesFilled, this.seriesShapesFilled);
boolean b4 = ObjectUtils.equal(r.defaultShapesFilled, this.defaultShapesFilled);
result = result && b0 && b1 && b2 && b3 && b4;
}
return result;
}
/**
* Returns an independent copy of the renderer.
*
* @return A clone.
*
* @throws CloneNotSupportedException should not happen.
*/
public Object clone() throws CloneNotSupportedException {
LineAndShapeRenderer clone = (LineAndShapeRenderer) super.clone();
clone.seriesShapesFilled = (BooleanList) this.seriesShapesFilled.clone();
return clone;
}
}