com.jrefinery.chart
Class AreaXYItemRenderer

java.lang.Object
  |
  +--com.jrefinery.chart.AbstractRenderer
        |
        +--com.jrefinery.chart.AbstractXYItemRenderer
              |
              +--com.jrefinery.chart.AreaXYItemRenderer
All Implemented Interfaces:
XYItemRenderer

public class AreaXYItemRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer

Area item renderer for an XYPlot. This class can draw (a) shapes at each point, or (b) lines between points, or (c) both shapes and lines, or (d) filled areas, or (e) filled areas and shapes.

Author:
Hari

Field Summary
static int AREA
          Useful constant for specifying the type of rendering (area only).
static int AREA_AND_SHAPES
          Useful constant for specifying the type of rendering (area and shapes).
static int LINES
          Useful constant for specifying the type of rendering (lines only).
static int SHAPES
          Useful constant for specifying the type of rendering (shapes only).
static int SHAPES_AND_LINES
          Useful constant for specifying the type of rendering (shapes and lines).
 
Constructor Summary
AreaXYItemRenderer()
          Constructs a new renderer.
AreaXYItemRenderer(int type)
          Constructs a new renderer.
AreaXYItemRenderer(int type, XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
          Constructs a new renderer.
 
Method Summary
 void drawItem(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, ChartRenderingInfo info, XYPlot plot, ValueAxis horizontalAxis, ValueAxis verticalAxis, XYDataset data, int series, int item, CrosshairInfo crosshairInfo)
          Draws the visual representation of a single data item.
 boolean getPlotArea()
          Returns true if Area is being plotted by the renderer.
 boolean getPlotLines()
          Returns true if lines are being plotted by the renderer.
 boolean getPlotShapes()
          Returns true if shapes are being plotted by the renderer.
 void initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, XYPlot plot, XYDataset data, ChartRenderingInfo info)
          Initialises the renderer.
 boolean isOutline()
          Returns a flag that controls whether or not outlines of the areas are drawn.
 void setOutline(boolean show)
          Sets a flag that controls whether or not outlines of the areas are drawn.
 
Methods inherited from class com.jrefinery.chart.AbstractXYItemRenderer
drawDomainMarker, drawRangeMarker, getLegendItem, getPlot, getToolTipGenerator, getURLGenerator, setPlot, setToolTipGenerator, setURLGenerator
 
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, drawDomainMarker, drawRangeMarker, getLegendItem, getPlot, getToolTipGenerator, getURLGenerator, removePropertyChangeListener, setPlot, setToolTipGenerator, setURLGenerator
 

Field Detail

SHAPES

public static final int SHAPES
Useful constant for specifying the type of rendering (shapes only).

LINES

public static final int LINES
Useful constant for specifying the type of rendering (lines only).

SHAPES_AND_LINES

public static final int SHAPES_AND_LINES
Useful constant for specifying the type of rendering (shapes and lines).

AREA

public static final int AREA
Useful constant for specifying the type of rendering (area only).

AREA_AND_SHAPES

public static final int AREA_AND_SHAPES
Useful constant for specifying the type of rendering (area and shapes).
Constructor Detail

AreaXYItemRenderer

public AreaXYItemRenderer()
Constructs a new renderer.

AreaXYItemRenderer

public AreaXYItemRenderer(int type)
Constructs a new renderer.
Parameters:
type - the type of the renderer.

AreaXYItemRenderer

public AreaXYItemRenderer(int type,
                          XYToolTipGenerator toolTipGenerator,
                          XYURLGenerator urlGenerator)
Constructs a new renderer.

To specify the type of renderer, use one of the constants: SHAPES, LINES, SHAPES_AND_LINES, AREA or AREA_AND_SHAPES.

Parameters:
type - the type of renderer.
toolTipGenerator - the tool tip generator to use. null is none.
urlGenerator - the URL generator (null permitted).
Method Detail

isOutline

public boolean isOutline()
Returns a flag that controls whether or not outlines of the areas are drawn.
Returns:
the flag.

setOutline

public void setOutline(boolean show)
Sets a flag that controls whether or not outlines of the areas are drawn.
Parameters:
show - the flag.

getPlotShapes

public boolean getPlotShapes()
Returns true if shapes are being plotted by the renderer.
Returns:
true if shapes are being plotted by the renderer.

getPlotLines

public boolean getPlotLines()
Returns true if lines are being plotted by the renderer.
Returns:
true if lines are being plotted by the renderer.

getPlotArea

public boolean getPlotArea()
Returns true if Area is being plotted by the renderer.
Returns:
true if Area is being plotted by the renderer.

initialise

public void initialise(java.awt.Graphics2D g2,
                       java.awt.geom.Rectangle2D dataArea,
                       XYPlot plot,
                       XYDataset data,
                       ChartRenderingInfo info)
Initialises the renderer. Here we calculate the Java2D y-coordinate for zero, since all the bars have their bases fixed at zero.
Specified by:
initialise in interface XYItemRenderer
Overrides:
initialise in class AbstractXYItemRenderer
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.

drawItem

public void drawItem(java.awt.Graphics2D g2,
                     java.awt.geom.Rectangle2D dataArea,
                     ChartRenderingInfo info,
                     XYPlot plot,
                     ValueAxis horizontalAxis,
                     ValueAxis verticalAxis,
                     XYDataset data,
                     int series,
                     int item,
                     CrosshairInfo crosshairInfo)
Draws the visual representation of a single data item.
Specified by:
drawItem in interface XYItemRenderer
Parameters:
g2 - the graphics device.
dataArea - the area within which the data is being drawn.
info - collects information about the drawing.
plot - the plot (can be used to obtain standard color information etc).
horizontalAxis - the horizontal axis.
verticalAxis - the vertical axis.
data - the dataset.
series - the series index.
item - the item index.
crosshairInfo - information about crosshairs on a plot.