1. /* ===========================================================

  2.  * JFreeChart : a free chart library for the Java(tm) platform

  3.  * ===========================================================

  4.  *

  5.  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.

  6.  *

  7.  * Project Info:  http://www.jfree.org/jfreechart/index.html

  8.  *

  9.  * This library is free software; you can redistribute it and/or modify it under the terms

  10.  * of the GNU Lesser General Public License as published by the Free Software Foundation;

  11.  * either version 2.1 of the License, or (at your option) any later version.

  12.  *

  13.  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

  14.  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  15.  * See the GNU Lesser General Public License for more details.

  16.  *

  17.  * You should have received a copy of the GNU Lesser General Public License along with this

  18.  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

  19.  * Boston, MA 02111-1307, USA.

  20.  *

  21.  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

  22.  * in the United States and other countries.]

  23.  *

  24.  * -------------------

  25.  * XYStepRenderer.java

  26.  * -------------------

  27.  * (C) Copyright 2002-2005, by Roger Studner and Contributors.

  28.  *

  29.  * Original Author:  Roger Studner;

  30.  * Contributor(s):   David Gilbert (for Object Refinery Limited);

  31.  *                   Matthias Rose;

  32.  *

  33.  * $Id: XYStepRenderer.java,v 1.3 2005/01/19 12:41:39 mungady Exp $

  34.  *

  35.  * Changes

  36.  * -------

  37.  * 13-May-2002 : Version 1, contributed by Roger Studner (DG);

  38.  * 25-Jun-2002 : Updated import statements (DG);

  39.  * 22-Jul-2002 : Added check for null data items (DG);

  40.  * 25-Mar-2003 : Implemented Serializable (DG);

  41.  * 01-May-2003 : Modified drawItem(...) method signature (DG);

  42.  * 20-Aug-2003 : Implemented Cloneable and PublicCloneable (DG);

  43.  * 16-Sep-2003 : Changed ChartRenderingInfo --> PlotRenderingInfo (DG);

  44.  * 28-Oct-2003 : Added tooltips, code contributed by Matthias Rose (RFE 824857) (DG);

  45.  * 10-Feb-2004 : Removed working line (use line from state object instead) (DG);

  46.  * 25-Feb-2004 : Replaced CrosshairInfo with CrosshairState.  Renamed XYToolTipGenerator

  47.  *               --> XYItemLabelGenerator (DG);

  48.  * 19-Jan-2005 : Now accesses only primitives from dataset (DG);

  49.  *

  50.  */

  51. 

  52. package org.jfree.chart.renderer.xy;

  53. 

  54. import java.awt.Graphics2D;

  55. import java.awt.Paint;

  56. import java.awt.Shape;

  57. import java.awt.Stroke;

  58. import java.awt.geom.Line2D;

  59. import java.awt.geom.Rectangle2D;

  60. import java.io.Serializable;

  61. 

  62. import org.jfree.chart.axis.ValueAxis;

  63. import org.jfree.chart.entity.EntityCollection;

  64. import org.jfree.chart.entity.XYItemEntity;

  65. import org.jfree.chart.labels.XYToolTipGenerator;

  66. import org.jfree.chart.plot.CrosshairState;

  67. import org.jfree.chart.plot.PlotOrientation;

  68. import org.jfree.chart.plot.PlotRenderingInfo;

  69. import org.jfree.chart.plot.XYPlot;

  70. import org.jfree.chart.urls.XYURLGenerator;

  71. import org.jfree.data.xy.XYDataset;

  72. import org.jfree.ui.RectangleEdge;

  73. import org.jfree.util.PublicCloneable;

  74. 

  75. /**

  76.  * Line/Step item renderer for an {@link XYPlot}.  This class draws lines between data

  77.  * points, only allowing horizontal or vertical lines (steps).

  78.  *

  79.  * @author Roger Studner

  80.  */

  81. public class XYStepRenderer extends AbstractXYItemRenderer 

  82.                             implements XYItemRenderer, 

  83.                                        Cloneable,

  84.                                        PublicCloneable,

  85.                                        Serializable {

  86. 

  87.     /**

  88.      * Constructs a new renderer with no tooltip or URL generation.

  89.      */

  90.     public XYStepRenderer() {

  91.         super();

  92.     }

  93. 

  94.     /**

  95.      * Constructs a new renderer.

  96.      *

  97.      * @param toolTipGenerator  the item label generator.

  98.      * @param urlGenerator  the URL generator.

  99.      */

  100.     public XYStepRenderer(XYToolTipGenerator toolTipGenerator,

  101.                           XYURLGenerator urlGenerator) {

  102. 

  103.         super();

  104.         setToolTipGenerator(toolTipGenerator);

  105.         setURLGenerator(urlGenerator);

  106. 

  107.     }

  108. 

  109.     /**

  110.      * Draws the visual representation of a single data item.

  111.      *

  112.      * @param g2  the graphics device.

  113.      * @param state  the renderer state.

  114.      * @param dataArea  the area within which the data is being drawn.

  115.      * @param info  collects information about the drawing.

  116.      * @param plot  the plot (can be used to obtain standard color information etc).

  117.      * @param domainAxis  the domain axis.

  118.      * @param rangeAxis  the vertical axis.

  119.      * @param dataset  the dataset.

  120.      * @param series  the series index (zero-based).

  121.      * @param item  the item index (zero-based).

  122.      * @param crosshairState  crosshair information for the plot (<code>null</code> permitted).

  123.      * @param pass  the pass index (ignored here).

  124.      */

  125.     public void drawItem(Graphics2D g2, 

  126.                          XYItemRendererState state,

  127.                          Rectangle2D dataArea, 

  128.                          PlotRenderingInfo info,

  129.                          XYPlot plot, 

  130.                          ValueAxis domainAxis, 

  131.                          ValueAxis rangeAxis,

  132.                          XYDataset dataset, 

  133.                          int series, 

  134.                          int item,

  135.                          CrosshairState crosshairState, 

  136.                          int pass) {

  137. 

  138.         PlotOrientation orientation = plot.getOrientation();

  139.         

  140.         Paint seriesPaint = getItemPaint(series, item);

  141.         Stroke seriesStroke = getItemStroke(series, item);

  142.         g2.setPaint(seriesPaint);

  143.         g2.setStroke(seriesStroke);

  144. 

  145.         // get the data point...

  146.         double x1 = dataset.getXValue(series, item);

  147.         double y1 = dataset.getYValue(series, item);

  148.         if (Double.isNaN(y1)) {

  149.             return;

  150.         }

  151. 

  152.         RectangleEdge xAxisLocation = plot.getDomainAxisEdge();

  153.         RectangleEdge yAxisLocation = plot.getRangeAxisEdge();

  154.         double transX1 = domainAxis.valueToJava2D(x1, dataArea, xAxisLocation);

  155.         double transY1 = rangeAxis.valueToJava2D(y1, dataArea, yAxisLocation);

  156. 

  157.         if (item > 0) {

  158.             // get the previous data point...

  159.             double x0 = dataset.getXValue(series, item - 1);

  160.             double y0 = dataset.getYValue(series, item - 1);

  161.             if (Double.isNaN(y0)) {

  162.                 double transX0 = domainAxis.valueToJava2D(x0, dataArea, xAxisLocation);

  163.                 double transY0 = rangeAxis.valueToJava2D(y0, dataArea, yAxisLocation);

  164. 

  165.                 Line2D line = state.workingLine;

  166.                 if (orientation == PlotOrientation.HORIZONTAL) {

  167.                     if (transY0 == transY1) { //this represents the situation for drawing a

  168.                                               //horizontal bar.

  169.                         line.setLine(transY0, transX0, transY1, transX1);

  170.                         g2.draw(line);

  171.                     }

  172.                     else {  //this handles the need to perform a 'step'.

  173.                         line.setLine(transY0, transX0, transY1, transX0);

  174.                         g2.draw(line);

  175.                         line.setLine(transY1, transX0, transY1, transX1);

  176.                         g2.draw(line);

  177.                     }

  178.                 }

  179.                 else if (orientation == PlotOrientation.VERTICAL) {

  180.                     if (transY0 == transY1) { //this represents the situation for drawing a

  181.                                               //horizontal bar.

  182.                         line.setLine(transX0, transY0, transX1, transY1);

  183.                         g2.draw(line);

  184.                     }

  185.                     else {  //this handles the need to perform a 'step'.

  186.                         line.setLine(transX0, transY0, transX1, transY0);

  187.                         g2.draw(line);

  188.                         line.setLine(transX1, transY0, transX1, transY1);

  189.                         g2.draw(line);

  190.                     }

  191.                 }

  192. 

  193.             }

  194.         }

  195. 

  196.         updateCrosshairValues(crosshairState, x1, y1, transX1, transY1, orientation);

  197.         // collect entity and tool tip information...

  198.        

  199.         if (state.getInfo() != null) {

  200.             EntityCollection entities = state.getInfo().getOwner().getEntityCollection();

  201.             if (entities != null) {

  202.                 Shape shape = orientation == PlotOrientation.VERTICAL

  203.                     ? new Rectangle2D.Double(transX1 - 2, transY1 - 2, 4.0, 4.0)

  204.                     : new Rectangle2D.Double(transY1 - 2, transX1 - 2, 4.0, 4.0);           

  205.                 if (shape != null) {

  206.                     String tip = null;

  207.                     XYToolTipGenerator generator = getToolTipGenerator(series, item);

  208.                     if (generator != null) {

  209.                         tip = generator.generateToolTip(dataset, series, item);

  210.                     }

  211.                     String url = null;

  212.                     if (getURLGenerator() != null) {

  213.                         url = getURLGenerator().generateURL(dataset, series, item);

  214.                     }

  215.                     XYItemEntity entity = new XYItemEntity(shape, dataset, series, item, tip, url);

  216.                     entities.add(entity);

  217.                 }

  218.             }

  219.         }

  220.     }

  221. 

  222.     /**

  223.      * Returns a clone of the renderer.

  224.      * 

  225.      * @return A clone.

  226.      * 

  227.      * @throws CloneNotSupportedException  if the renderer cannot be cloned.

  228.      */

  229.     public Object clone() throws CloneNotSupportedException {

  230.         return super.clone();

  231.     }

  232. 

  233. }