com.jrefinery.chart
Class AbstractXYItemRenderer

java.lang.Object
  |
  +--com.jrefinery.chart.AbstractRenderer
        |
        +--com.jrefinery.chart.AbstractXYItemRenderer
All Implemented Interfaces:
XYItemRenderer
Direct Known Subclasses:
AreaXYItemRenderer, CandlestickRenderer, HighLowRenderer, SignalRenderer, StandardXYItemRenderer, VerticalXYBarRenderer, WindItemRenderer, XYDotRenderer, XYStepRenderer

public abstract class AbstractXYItemRenderer
extends AbstractRenderer
implements XYItemRenderer

A base class that can be used to create new XYItemRenderer implementations.

Author:
DG

Constructor Summary
protected AbstractXYItemRenderer()
          Default constructor.
protected AbstractXYItemRenderer(XYToolTipGenerator toolTipGenerator)
          Creates a renderer with the specified tooltip generator.
protected AbstractXYItemRenderer(XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
          Creates a renderer with the specified tooltip generator and URL generator.
protected AbstractXYItemRenderer(XYURLGenerator urlGenerator)
          Creates a renderer with the specified tooltip generator.
 
Method Summary
 void drawDomainMarker(java.awt.Graphics2D g2, XYPlot plot, ValueAxis domainAxis, Marker marker, java.awt.geom.Rectangle2D dataArea)
          Draws a vertical line on the chart to represent a 'range marker'.
 void drawRangeMarker(java.awt.Graphics2D g2, XYPlot plot, ValueAxis rangeAxis, Marker marker, java.awt.geom.Rectangle2D dataArea)
          Draws a horizontal line across the chart to represent a 'range marker'.
 LegendItem getLegendItem(int series)
          Returns a legend item for a series.
 XYPlot getPlot()
          Returns the plot that this renderer has been assigned to.
 XYToolTipGenerator getToolTipGenerator()
          Returns the tool tip generator.
 XYURLGenerator getURLGenerator()
          Returns the URL generator for HTML image maps.
 void initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, XYPlot plot, XYDataset data, ChartRenderingInfo info)
          Initialises the renderer.
 void setPlot(XYPlot plot)
          Sets the plot that this renderer has been assigned to.
 void setToolTipGenerator(XYToolTipGenerator generator)
          Sets the tool tip generator.
 void setURLGenerator(XYURLGenerator urlGenerator)
          Sets the URL generator for HTML image maps.
 
Methods inherited from class com.jrefinery.chart.AbstractRenderer
addPropertyChangeListener, firePropertyChanged, getInfo, removePropertyChangeListener, setInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.jrefinery.chart.XYItemRenderer
addPropertyChangeListener, drawItem, removePropertyChangeListener
 

Constructor Detail

AbstractXYItemRenderer

protected AbstractXYItemRenderer()
Default constructor.

AbstractXYItemRenderer

protected AbstractXYItemRenderer(XYToolTipGenerator toolTipGenerator)
Creates a renderer with the specified tooltip generator.

Storage is allocated for property change listeners.

Parameters:
toolTipGenerator - the tooltip generator (null permitted).

AbstractXYItemRenderer

protected AbstractXYItemRenderer(XYURLGenerator urlGenerator)
Creates a renderer with the specified tooltip generator.

Storage is allocated for property change listeners.

Parameters:
urlGenerator - the URL generator (null permitted).

AbstractXYItemRenderer

protected AbstractXYItemRenderer(XYToolTipGenerator toolTipGenerator,
                                 XYURLGenerator urlGenerator)
Creates a renderer with the specified tooltip generator and URL generator.

Storage is allocated for property change listeners.

Parameters:
toolTipGenerator - the tooltip generator (null permitted).
urlGenerator - the URL generator (null permitted).
Method Detail

getPlot

public XYPlot getPlot()
Returns the plot that this renderer has been assigned to.
Specified by:
getPlot in interface XYItemRenderer
Returns:
the plot.

setPlot

public void setPlot(XYPlot plot)
Sets the plot that this renderer has been assigned to.
Specified by:
setPlot in interface XYItemRenderer
Parameters:
plot - the plot.

initialise

public void initialise(java.awt.Graphics2D g2,
                       java.awt.geom.Rectangle2D dataArea,
                       XYPlot plot,
                       XYDataset data,
                       ChartRenderingInfo info)
Initialises the renderer.

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.

Specified by:
initialise in interface XYItemRenderer
Parameters:
g2 - the graphics device.
dataArea - the area inside the axes.
plot - the plot.
data - the data.
info - an optional info collection object to return data back to the caller.

getToolTipGenerator

public XYToolTipGenerator getToolTipGenerator()
Returns the tool tip generator.
Specified by:
getToolTipGenerator in interface XYItemRenderer
Returns:
the tool tip generator (possibly null).

setToolTipGenerator

public void setToolTipGenerator(XYToolTipGenerator generator)
Sets the tool tip generator.
Specified by:
setToolTipGenerator in interface XYItemRenderer
Parameters:
generator - the tool tip generator (null permitted).

getURLGenerator

public XYURLGenerator getURLGenerator()
Returns the URL generator for HTML image maps.
Specified by:
getURLGenerator in interface XYItemRenderer
Returns:
the URL generator (possibly null).

setURLGenerator

public void setURLGenerator(XYURLGenerator urlGenerator)
Sets the URL generator for HTML image maps.
Specified by:
setURLGenerator in interface XYItemRenderer
Parameters:
urlGenerator - the URL generator (null permitted).

getLegendItem

public LegendItem getLegendItem(int series)
Returns a legend item for a series.
Specified by:
getLegendItem in interface XYItemRenderer
Parameters:
series - the series (zero-based index).
Returns:
a legend item for the series.

drawDomainMarker

public void drawDomainMarker(java.awt.Graphics2D g2,
                             XYPlot plot,
                             ValueAxis domainAxis,
                             Marker marker,
                             java.awt.geom.Rectangle2D dataArea)
Draws a vertical line on the chart to represent a 'range marker'.
Specified by:
drawDomainMarker in interface XYItemRenderer
Parameters:
g2 - the graphics device.
plot - the plot.
domainAxis - the domain axis.
marker - the marker line.
dataArea - the axis data area.

drawRangeMarker

public void drawRangeMarker(java.awt.Graphics2D g2,
                            XYPlot plot,
                            ValueAxis rangeAxis,
                            Marker marker,
                            java.awt.geom.Rectangle2D dataArea)
Draws a horizontal line across the chart to represent a 'range marker'.
Specified by:
drawRangeMarker in interface XYItemRenderer
Parameters:
g2 - the graphics device.
plot - the plot.
rangeAxis - the range axis.
marker - the marker line.
dataArea - the axis data area.