org.jfree.chart.renderer
Interface XYItemRenderer

All Superinterfaces:
Renderer
All Known Implementing Classes:
AbstractXYItemRenderer, AreaXYRenderer, CandlestickRenderer, HighLowRenderer, SignalRenderer, StandardXYItemRenderer, VerticalXYBarRenderer, WindItemRenderer, XYBubbleRenderer, XYDotRenderer, XYStepRenderer, YIntervalRenderer

public interface XYItemRenderer
extends Renderer

Interface for rendering the visual representation of a single (x, y) item on an XYPlot.

Author:
David Gilbert

Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a property change listener to the renderer.
 void drawDomainGridLine(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double value)
          Draws a grid line against the domain axis.
 void drawDomainMarker(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, Marker marker, java.awt.geom.Rectangle2D dataArea)
          Draws a vertical line on the chart to represent a 'range marker'.
 void drawItem(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, ChartRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int datasetIndex, int series, int item, CrosshairInfo crosshairInfo)
          Called for each item to be plotted.
 void drawRangeGridLine(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double value)
          Draws a grid line against the range axis.
 void drawRangeMarker(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, Marker marker, java.awt.geom.Rectangle2D dataArea)
          Draws a horizontal line across the chart to represent a 'range marker'.
 java.awt.Paint getItemOutlinePaint(int dataset, int series, int item)
          Returns the paint used to outline an item.
 java.awt.Paint getItemPaint(int dataset, int series, int item)
          Returns the paint used to fill an item.
 java.awt.Shape getItemShape(int dataset, int series, int item)
          Returns the shape for an item.
 java.awt.Stroke getItemStroke(int dataset, int series, int item)
          Returns the stroke used to draw an item.
 LegendItem getLegendItem(int datasetIndex, int series)
          Returns a legend item for a series from a dataset.
 Plot getPlot()
          Returns the plot that this renderer has been assigned to.
 java.awt.Paint getSeriesOutlinePaint(int dataset, int series)
          Returns the paint used to outline items in a series.
 java.awt.Paint getSeriesPaint(int dataset, int series)
          Returns the paint used to fill items in a series.
 java.awt.Shape getSeriesShape(int dataset, int series)
          Returns the shape for a series.
 java.awt.Stroke getSeriesStroke(int dataset, int series)
          Returns the stroke used to draw items in a series.
 XYToolTipGenerator getToolTipGenerator()
          Returns the tool tip generator for the renderer (possibly null).
 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 removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a property change listener from the renderer.
 void setDrawingSupplier(DrawingSupplier supplier)
          Sets the drawing supplier.
 void setPlot(Plot plot)
          Sets the plot that this renderer is assigned to.
 void setSeriesPaint(int dataset, int series, java.awt.Paint paint)
          Sets the paint for a series.
 void setSeriesPaint(int series, java.awt.Paint paint)
          Sets the paint for a series in the primary dataset.
 void setToolTipGenerator(XYToolTipGenerator toolTipGenerator)
          Sets the tool tip generator for the renderer.
 void setURLGenerator(XYURLGenerator urlGenerator)
          Sets the URL generator for HTML image maps.
 
Methods inherited from interface org.jfree.chart.renderer.Renderer
getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultShape, getDefaultStroke, getDrawingSupplier, isOutlinePaintTableActive, isOutlineStrokeTableActive, isPaintTableActive, isShapeTableActive, isStrokeTableActive, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultPaint, setDefaultShape, setDefaultStroke, setOutlinePaintTableActive, setOutlineStrokeTableActive, setPaintTableActive, setSeriesStroke, setSeriesStroke, setShapeTableActive, setStrokeTableActive
 

Method Detail

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.

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.

setDrawingSupplier

public void setDrawingSupplier(DrawingSupplier supplier)
Sets the drawing supplier.

Specified by:
setDrawingSupplier in interface Renderer
Parameters:
supplier - the supplier.

getToolTipGenerator

public XYToolTipGenerator getToolTipGenerator()
Returns the tool tip generator for the renderer (possibly null).

Returns:
the tool tip generator.

setToolTipGenerator

public void setToolTipGenerator(XYToolTipGenerator toolTipGenerator)
Sets the tool tip generator for the renderer.

Parameters:
toolTipGenerator - the tool tip generator (null permitted).

getURLGenerator

public XYURLGenerator getURLGenerator()
Returns the URL generator for HTML image maps.

Returns:
the URL generator (possibly null).

setURLGenerator

public void setURLGenerator(XYURLGenerator urlGenerator)
Sets the URL generator for HTML image maps.

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

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a property change listener to the renderer.

Parameters:
listener - the listener.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener from the renderer.

Parameters:
listener - the listener.

getItemPaint

public java.awt.Paint getItemPaint(int dataset,
                                   int series,
                                   int item)
Returns the paint used to fill an item.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The paint.

getSeriesPaint

public java.awt.Paint getSeriesPaint(int dataset,
                                     int series)
Returns the paint used to fill items in a series.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
Returns:
The paint.

setSeriesPaint

public void setSeriesPaint(int series,
                           java.awt.Paint paint)
Sets the paint for a series in the primary dataset.

Specified by:
setSeriesPaint in interface Renderer
Parameters:
series - the series index (zero-based).
paint - the paint.

setSeriesPaint

public void setSeriesPaint(int dataset,
                           int series,
                           java.awt.Paint paint)
Sets the paint for a series.

Specified by:
setSeriesPaint in interface Renderer
Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
paint - the paint.

getItemOutlinePaint

public java.awt.Paint getItemOutlinePaint(int dataset,
                                          int series,
                                          int item)
Returns the paint used to outline an item.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The paint.

getSeriesOutlinePaint

public java.awt.Paint getSeriesOutlinePaint(int dataset,
                                            int series)
Returns the paint used to outline items in a series.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
Returns:
The paint.

getItemStroke

public java.awt.Stroke getItemStroke(int dataset,
                                     int series,
                                     int item)
Returns the stroke used to draw an item.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The stroke.

getSeriesStroke

public java.awt.Stroke getSeriesStroke(int dataset,
                                       int series)
Returns the stroke used to draw items in a series.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
Returns:
The stroke.

getItemShape

public java.awt.Shape getItemShape(int dataset,
                                   int series,
                                   int item)
Returns the shape for an item.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The shape.

getSeriesShape

public java.awt.Shape getSeriesShape(int dataset,
                                     int series)
Returns the shape for a series.

Parameters:
dataset - the dataset index (zero-based).
series - the series index (zero-based).
Returns:
The shape.

drawItem

public void drawItem(java.awt.Graphics2D g2,
                     java.awt.geom.Rectangle2D dataArea,
                     ChartRenderingInfo info,
                     XYPlot plot,
                     ValueAxis domainAxis,
                     ValueAxis rangeAxis,
                     XYDataset dataset,
                     int datasetIndex,
                     int series,
                     int item,
                     CrosshairInfo crosshairInfo)
Called for each item to be plotted.

Parameters:
g2 - the graphics device.
dataArea - the area within which the data is being rendered.
info - collects drawing info.
plot - the plot (can be used to obtain standard color information etc).
domainAxis - the domain axis.
rangeAxis - the range axis.
dataset - the dataset.
datasetIndex - the dataset index (zero-based).
series - the series index (zero-based).
item - the item index (zero-based).
crosshairInfo - collects information about crosshairs.

getLegendItem

public LegendItem getLegendItem(int datasetIndex,
                                int series)
Returns a legend item for a series from a dataset.

Parameters:
datasetIndex - the dataset index.
series - the series (zero-based index).
Returns:
the legend item.

drawDomainGridLine

public void drawDomainGridLine(java.awt.Graphics2D g2,
                               XYPlot plot,
                               ValueAxis axis,
                               java.awt.geom.Rectangle2D dataArea,
                               double value)
Draws a grid line against the domain axis.

Parameters:
g2 - the graphics device.
plot - the plot.
axis - the value axis.
dataArea - the area for plotting data (not yet adjusted for any 3D effect).
value - the value.

drawRangeGridLine

public void drawRangeGridLine(java.awt.Graphics2D g2,
                              XYPlot plot,
                              ValueAxis axis,
                              java.awt.geom.Rectangle2D dataArea,
                              double value)
Draws a grid line against the range axis.

Parameters:
g2 - the graphics device.
plot - the plot.
axis - the value axis.
dataArea - the area for plotting data (not yet adjusted for any 3D effect).
value - the value.

drawDomainMarker

public void drawDomainMarker(java.awt.Graphics2D g2,
                             XYPlot plot,
                             ValueAxis axis,
                             Marker marker,
                             java.awt.geom.Rectangle2D dataArea)
Draws a vertical line on the chart to represent a 'range marker'.

Parameters:
g2 - the graphics device.
plot - the plot.
axis - the value axis.
marker - the marker line.
dataArea - the axis data area.

drawRangeMarker

public void drawRangeMarker(java.awt.Graphics2D g2,
                            XYPlot plot,
                            ValueAxis axis,
                            Marker marker,
                            java.awt.geom.Rectangle2D dataArea)
Draws a horizontal line across the chart to represent a 'range marker'.

Parameters:
g2 - the graphics device.
plot - the plot.
axis - the value axis.
marker - the marker line.
dataArea - the axis data area.

getPlot

public Plot getPlot()
Returns the plot that this renderer has been assigned to.

Specified by:
getPlot in interface Renderer
Returns:
the plot.

setPlot

public void setPlot(Plot plot)
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.

Specified by:
setPlot in interface Renderer
Parameters:
plot - the plot.