/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2012, 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., 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.]
*
* -------------------
* XYItemRenderer.java
* -------------------
* (C) Copyright 2001-2012, by Object Refinery Limited and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): Mark Watson (www.markwatson.com);
* Sylvain Vieujot;
* Focus Computer Services Limited;
* Richard Atkinson;
*
* Changes:
* For history prior to the release of JFreeChart 1.0.0 in December 2005,
* please refer to the source files in the JFreeChart 1.0.x release.
*
* ------------- JFREECHART 1.0.x ---------------------------------------------
* 19-Apr-2007 : Deprecated seriesVisible and seriesVisibleInLegend flags (DG);
* 20-Apr-2007 : Deprecated paint, fillPaint, outlinePaint, stroke,
* outlineStroke, shape, itemLabelsVisible, itemLabelFont,
* itemLabelPaint, positiveItemLabelPosition,
* negativeItemLabelPosition and createEntities override
* fields (DG);
* 17-Jun-2012 : Removed JCommon dependencies (DG);
*
* ------------- JFREECHART Future State Edition (1.2.0?) ---------------------
* < under development >
*
*/
package org.jfree.chart.renderer.xy;
import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.Stroke;
import java.awt.geom.Rectangle2D;
import java.util.Collection;
import org.jfree.chart.annotations.XYAnnotation;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.ui.Layer;
import org.jfree.chart.event.RendererChangeEvent;
import org.jfree.chart.labels.XYItemLabelGenerator;
import org.jfree.chart.labels.XYSeriesLabelGenerator;
import org.jfree.chart.labels.XYToolTipGenerator;
import org.jfree.chart.plot.CrosshairState;
import org.jfree.chart.plot.Marker;
import org.jfree.chart.plot.PlotRenderingInfo;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.renderer.Renderer;
import org.jfree.chart.urls.XYURLGenerator;
import org.jfree.data.Range;
import org.jfree.data.xy.XYDataset;
/**
* Interface for rendering the visual representation of a single (x, y) item on
* an {@link XYPlot}.
* <p>
* To support cloning charts, it is recommended that renderers implement both
* the {@link Cloneable} and <code>PublicCloneable</code> interfaces.
*/
public interface XYItemRenderer extends Renderer {
/**
* Returns the plot that this renderer has been assigned to.
*
* @return The plot.
*/
public XYPlot getPlot();
/**
* Sets the plot that this renderer is assigned to. This method will be
* called by the plot class...you do not need to call it yourself.
*
* @param plot the plot.
*/
public void setPlot(XYPlot plot);
/**
* Returns the lower and upper bounds (range) of the x-values in the
* specified dataset.
*
* @param dataset the dataset (<code>null</code> permitted).
*
* @return The range.
*/
public Range findDomainBounds(XYDataset dataset);
/**
* Returns the lower and upper bounds (range) of the y-values in the
* specified dataset. The implementation of this method will take
* into account the presentation used by the renderers (for example,
* a renderer that "stacks" values will return a bigger range than
* a renderer that doesn't).
*
* @param dataset the dataset (<code>null</code> permitted).
*
* @return The range (or <code>null</code> if the dataset is
* <code>null</code> or empty).
*/
public Range findRangeBounds(XYDataset dataset);
//// LEGEND ITEM LABEL GENERATOR //////////////////////////////////////////
/**
* Returns the legend item label generator.
*
* @return The legend item label generator (never <code>null</code>).
*
* @see #setLegendItemLabelGenerator(XYSeriesLabelGenerator)
*/
public XYSeriesLabelGenerator getLegendItemLabelGenerator();
/**
* Sets the legend item label generator and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the generator (<code>null</code> not permitted).
*/
public void setLegendItemLabelGenerator(XYSeriesLabelGenerator generator);
public void setLegendItemLabelGenerator(XYSeriesLabelGenerator generator,
boolean notify);
//// TOOL TIP GENERATOR ///////////////////////////////////////////////////
/**
* Returns the tool tip generator for a data item.
*
* @param row the row index (zero based).
* @param column the column index (zero based).
*
* @return The generator (possibly <code>null</code>).
*/
public XYToolTipGenerator getToolTipGenerator(int row, int column);
/**
* Returns the tool tip generator for a series.
*
* @param series the series index (zero based).
*
* @return The generator (possibly <code>null</code>).
*
* @see #setSeriesToolTipGenerator(int, XYToolTipGenerator)
*/
public XYToolTipGenerator getSeriesToolTipGenerator(int series);
/**
* Sets the tool tip generator for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero based).
* @param generator the generator (<code>null</code> permitted).
*
* @see #getSeriesToolTipGenerator(int)
*/
public void setSeriesToolTipGenerator(int series,
XYToolTipGenerator generator);
public void setSeriesToolTipGenerator(int series,
XYToolTipGenerator generator, boolean notify);
/**
* Returns the default tool tip generator.
*
* @return The generator (possibly <code>null</code>).
*
* @see #setDefaultToolTipGenerator(XYToolTipGenerator)
*/
public XYToolTipGenerator getDefaultToolTipGenerator();
/**
* Sets the default tool tip generator and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param generator the generator (<code>null</code> permitted).
*
* @see #getDefaultToolTipGenerator()
*/
public void setDefaultToolTipGenerator(XYToolTipGenerator generator);
public void setDefaultToolTipGenerator(XYToolTipGenerator generator,
boolean notify);
//// ITEM LABEL GENERATOR /////////////////////////////////////////////////
/**
* Returns the item label generator for a data item.
*
* @param row the row index (zero based).
* @param column the column index (zero based).
*
* @return The generator (possibly <code>null</code>).
*/
public XYItemLabelGenerator getItemLabelGenerator(int row, int column);
/**
* Returns the item label generator for a series.
*
* @param series the series index (zero based).
*
* @return The generator (possibly <code>null</code>).
*
* @see #setSeriesItemLabelGenerator(int, XYItemLabelGenerator)
*/
public XYItemLabelGenerator getSeriesItemLabelGenerator(int series);
/**
* Sets the item label generator for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero based).
* @param generator the generator (<code>null</code> permitted).
*
* @see #getSeriesItemLabelGenerator(int)
*/
public void setSeriesItemLabelGenerator(int series,
XYItemLabelGenerator generator);
public void setSeriesItemLabelGenerator(int series,
XYItemLabelGenerator generator, boolean notify);
/**
* Returns the default item label generator.
*
* @return The generator (possibly <code>null</code>).
*
* @see #setDefaultItemLabelGenerator(XYItemLabelGenerator)
*/
public XYItemLabelGenerator getDefaultItemLabelGenerator();
/**
* Sets the default item label generator and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the generator (<code>null</code> permitted).
*
* @see #getDefaultItemLabelGenerator()
*/
public void setDefaultItemLabelGenerator(XYItemLabelGenerator generator);
public void setDefaultItemLabelGenerator(XYItemLabelGenerator generator,
boolean notify);
//// URL GENERATOR ////////////////////////////////////////////////////////
/**
* Returns the URL generator for HTML image maps.
*
* @return The URL generator (possibly null).
*/
public XYURLGenerator getURLGenerator();
/**
* Sets the URL generator for HTML image maps.
*
* @param urlGenerator the URL generator (null permitted).
*/
public void setURLGenerator(XYURLGenerator urlGenerator);
public void setURLGenerator(XYURLGenerator urlGenerator, boolean notify);
// FIXME: series level
//// ANNOTATIONS //////////////////////////////////////////////////////////
/**
* Adds an annotation and sends a {@link RendererChangeEvent} to all
* registered listeners. The annotation is added to the foreground
* layer.
*
* @param annotation the annotation (<code>null</code> not permitted).
*/
public void addAnnotation(XYAnnotation annotation);
/**
* Adds an annotation to the specified layer.
*
* @param annotation the annotation (<code>null</code> not permitted).
* @param layer the layer (<code>null</code> not permitted).
*/
public void addAnnotation(XYAnnotation annotation, Layer layer);
/**
* Removes the specified annotation and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param annotation the annotation to remove (<code>null</code> not
* permitted).
*
* @return A boolean to indicate whether or not the annotation was
* successfully removed.
*/
public boolean removeAnnotation(XYAnnotation annotation);
/**
* Removes all annotations and sends a {@link RendererChangeEvent}
* to all registered listeners.
*/
public void removeAnnotations();
/**
* Returns a collection of the annotations that are assigned to the
* renderer.
*
* @return A collection of annotations (possibly empty but never
* <code>null</code>).
*/
public Collection<XYAnnotation> getAnnotations();
/**
* Draws all the annotations for the specified layer.
*
* @param g2 the graphics device.
* @param dataArea the data area.
* @param domainAxis the domain axis.
* @param rangeAxis the range axis.
* @param layer the layer.
* @param info the plot rendering info.
*/
public void drawAnnotations(Graphics2D g2, Rectangle2D dataArea,
ValueAxis domainAxis, ValueAxis rangeAxis, Layer layer,
PlotRenderingInfo info);
//// DRAWING //////////////////////////////////////////////////////////////
/**
* Initialises the renderer then returns the number of 'passes' through the
* data that the renderer will require (usually just one). This method
* will be called before the first item is rendered, giving the renderer
* an opportunity to initialise any state information it wants to maintain.
* The renderer can do nothing if it chooses.
*
* @param g2 the graphics device.
* @param dataArea the area inside the axes.
* @param plot the plot.
* @param dataset the dataset.
* @param info an optional info collection object to return data back to
* the caller.
*
* @return The number of passes the renderer requires.
*/
public XYItemRendererState initialise(Graphics2D g2,
Rectangle2D dataArea,
XYPlot plot,
XYDataset dataset,
PlotRenderingInfo info);
/**
* Called for each item to be plotted.
* <p>
* The {@link XYPlot} can make multiple passes through the dataset,
* depending on the value returned by the renderer's initialise() method.
*
* @param g2 the graphics device.
* @param state the renderer state.
* @param dataArea the area within which the data is being rendered.
* @param info collects drawing info.
* @param plot the plot (can be used to obtain standard color
* information etc).
* @param domainAxis the domain axis.
* @param rangeAxis the range axis.
* @param dataset the dataset.
* @param series the series index (zero-based).
* @param item the item index (zero-based).
* @param crosshairState crosshair information for the plot
* (<code>null</code> permitted).
* @param pass the pass index.
*/
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);
/**
* Fills a band between two values on the axis. This can be used to color
* bands between the grid lines.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the domain axis.
* @param dataArea the data area.
* @param start the start value.
* @param end the end value.
*/
public void fillDomainGridBand(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double start, double end);
/**
* Fills a band between two values on the range axis. This can be used to
* color bands between the grid lines.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the range axis.
* @param dataArea the data area.
* @param start the start value.
* @param end the end value.
*/
public void fillRangeGridBand(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double start, double end);
/**
* Draws a grid line against the domain axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the value axis.
* @param dataArea the area for plotting data (not yet adjusted for any
* 3D effect).
* @param value the value.
*/
public void drawDomainGridline(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double value);
/**
* Draws a line perpendicular to the range axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the value axis.
* @param dataArea the area for plotting data.
* @param value the data value.
* @param paint the paint (<code>null</code> not permitted).
* @param stroke the stroke (<code>null</code> not permitted).
*/
public void drawRangeGridline(Graphics2D g2, XYPlot plot, ValueAxis axis,
Rectangle2D dataArea, double value, Paint paint, Stroke stroke);
/**
* Draws the specified <code>marker</code> against the domain axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the value axis.
* @param marker the marker.
* @param dataArea the axis data area.
*/
public void drawDomainMarker(Graphics2D g2, XYPlot plot, ValueAxis axis,
Marker marker, Rectangle2D dataArea);
/**
* Draws a horizontal line across the chart to represent a 'range marker'.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the value axis.
* @param marker the marker line.
* @param dataArea the axis data area.
*/
public void drawRangeMarker(Graphics2D g2, XYPlot plot, ValueAxis axis,
Marker marker, Rectangle2D dataArea);
}