org.jfree.chart.renderer
Class BoxAndWhiskerRenderer

java.lang.Object
  org.jfree.chart.renderer.AbstractRenderer
      org.jfree.chart.renderer.AbstractCategoryItemRenderer
          org.jfree.chart.renderer.BoxAndWhiskerRenderer

All Implemented Interfaces:

CategoryItemRenderer, java.lang.Cloneable, java.io.Serializable

public class BoxAndWhiskerRenderer

extends AbstractCategoryItemRenderer

A box-and-whisker renderer.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jfree.chart.renderer.AbstractRenderer

DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO

Constructor Summary

BoxAndWhiskerRenderer()
Default constructor.

Method Summary

void	drawHorizontalItem(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column) Draws the visual representation of a single data item when the plot has a horizontal orientation.
void	drawItem(java.awt.Graphics2D g2, CategoryItemRendererState state, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column) Draw a single data item.
void	drawVerticalItem(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column) Draws the visual representation of a single data item when the plot has a vertical orientation.
java.awt.Paint	getArtifactPaint() Returns the paint used to color the median and average markers.
double	getBoxWidth() Returns the box width.
double	getItemMargin() Returns the item margin.
CategoryItemRendererState	initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, java.lang.Integer index, PlotRenderingInfo info) Initialises the renderer.
void	setArtifactPaint(java.awt.Paint paint) Sets the paint used to color the median and average markers.
void	setBoxWidth(double width) Sets the box width.
void	setItemMargin(double margin) Sets the item margin.

Methods inherited from class org.jfree.chart.renderer.AbstractCategoryItemRenderer

clone, drawBackground, drawDomainGridline, drawItemLabel, drawOutline, drawRangeGridline, drawRangeMarker, equals, getBaseItemLabelGenerator, getBaseItemURLGenerator, getColumnCount, getDataset, getDomainAxis, getDrawingSupplier, getItemLabelAnchorOffset, getItemLabelGenerator, getItemURLGenerator, getLegendItem, getPlot, getRangeAxis, getRangeType, getRowCount, getSeriesItemLabelGenerator, getSeriesItemURLGenerator, hashCode, setBaseItemLabelGenerator, setBaseItemURLGenerator, setItemLabelAnchorOffset, setItemLabelGenerator, setItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesItemURLGenerator

Methods inherited from class org.jfree.chart.renderer.AbstractRenderer

addChangeListener, addPropertyChangeListener, createTransformedShape, firePropertyChanged, getBaseItemLabelAnchor, getBaseItemLabelAngle, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelRotationAnchor, getBaseItemLabelsVisible, getBaseItemLabelTextAnchor, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseShape, getBaseStroke, getItemLabelAnchor, getItemLabelAngle, getItemLabelFont, getItemLabelPaint, getItemLabelRotationAnchor, getItemLabelTextAnchor, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelAnchor, getSeriesItemLabelAngle, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesItemLabelRotationAnchor, getSeriesItemLabelTextAnchor, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, isItemLabelVisible, isSeriesItemLabelsVisible, notifyListeners, removeChangeListener, removePropertyChangeListener, setBaseAngle, setBaseItemLabelAnchor, setBaseItemLabelFont, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelPaint, setBaseItemLabelRotationAnchor, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelTextAnchor, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlinePaint, setBaseOutlineStroke, setBaseOutlineStroke, setBasePaint, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseShape, setBaseShape, setBaseStroke, setBaseStroke, setItemLabelAnchor, setItemLabelAngle, setItemLabelFont, setItemLabelFont, setItemLabelPaint, setItemLabelPaint, setItemLabelRotationAnchor, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setItemLabelTextAnchor, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlinePaint, setOutlineStroke, setOutlineStroke, setPaint, setPaint, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesAngle, setSeriesItemLabelAnchor, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelRotationAnchor, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelTextAnchor, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setShape, setShape, setStroke, setStroke

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.renderer.CategoryItemRenderer

addChangeListener, getBaseItemLabelAnchor, getBaseItemLabelFont, getBaseItemLabelTextAnchor, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBaseShape, getBaseStroke, getItemLabelAnchor, getItemLabelFont, getItemLabelTextAnchor, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelAnchor, getSeriesItemLabelFont, getSeriesItemLabelTextAnchor, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesShape, getSeriesStroke, removeChangeListener, setBaseItemLabelAnchor, setBaseItemLabelFont, setBaseItemLabelTextAnchor, setBaseOutlinePaint, setBaseOutlineStroke, setBasePaint, setBaseShape, setBaseStroke, setItemLabelAnchor, setItemLabelFont, setItemLabelsVisible, setItemLabelsVisible, setItemLabelTextAnchor, setNegativeItemLabelPosition, setOutlinePaint, setOutlineStroke, setPositiveItemLabelPosition, setSeriesItemLabelAnchor, setSeriesItemLabelFont, setSeriesItemLabelTextAnchor, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesPaint, setSeriesShape, setSeriesStroke, setStroke

Constructor Detail

BoxAndWhiskerRenderer

public BoxAndWhiskerRenderer()

Default constructor.

Method Detail

getArtifactPaint

public java.awt.Paint getArtifactPaint()

Returns the paint used to color the median and average markers.

Returns:

A paint.

setArtifactPaint

public void setArtifactPaint(java.awt.Paint paint)

Sets the paint used to color the median and average markers.

Parameters:

paint - the paint.

getBoxWidth

public double getBoxWidth()

Returns the box width.

Returns:

The box width.

setBoxWidth

public void setBoxWidth(double width)

Sets the box width.

Parameters:

width - the width.

getItemMargin

public double getItemMargin()

Returns the item margin. This is a percentage of the available space that is allocated to the space between items in the chart.

Returns:

The margin.

setItemMargin

public void setItemMargin(double margin)

Sets the item margin.

Parameters:

margin - the margin.

initialise

public CategoryItemRendererState initialise(java.awt.Graphics2D g2,
                                            java.awt.geom.Rectangle2D dataArea,
                                            CategoryPlot plot,
                                            java.lang.Integer index,
                                            PlotRenderingInfo info)

Initialises the renderer.

This method gets called once at the start of the process of drawing a chart.

Specified by:

initialise in interface CategoryItemRenderer

Overrides:

initialise in class AbstractCategoryItemRenderer

Parameters:

g2 - the graphics device.

dataArea - the area in which the data is to be plotted.

plot - the plot.

index - the renderer index (null for primary index).

info - collects chart rendering information for return to caller.

Returns:

The renderer state.

drawItem

public void drawItem(java.awt.Graphics2D g2,
                     CategoryItemRendererState state,
                     java.awt.geom.Rectangle2D dataArea,
                     CategoryPlot plot,
                     CategoryAxis domainAxis,
                     ValueAxis rangeAxis,
                     CategoryDataset dataset,
                     int row,
                     int column)

Draw a single data item.

Parameters:

g2 - the graphics device.

state - the renderer state.

dataArea - the area in which the data is drawn.

plot - the plot.

domainAxis - the domain axis.

rangeAxis - the range axis.

dataset - the data.

row - the row index (zero-based).

column - the column index (zero-based).

drawHorizontalItem

public void drawHorizontalItem(java.awt.Graphics2D g2,
                               java.awt.geom.Rectangle2D dataArea,
                               CategoryPlot plot,
                               CategoryAxis domainAxis,
                               ValueAxis rangeAxis,
                               CategoryDataset dataset,
                               int row,
                               int column)

Draws the visual representation of a single data item when the plot has a horizontal orientation.

Parameters:

g2 - the graphics device.

dataArea - the area within which the plot is being drawn.

plot - the plot (can be used to obtain standard color information etc).

domainAxis - the domain axis.

rangeAxis - the range axis.

dataset - the dataset.

row - the row index (zero-based).

column - the column index (zero-based).

drawVerticalItem

public void drawVerticalItem(java.awt.Graphics2D g2,
                             java.awt.geom.Rectangle2D dataArea,
                             CategoryPlot plot,
                             CategoryAxis domainAxis,
                             ValueAxis rangeAxis,
                             CategoryDataset dataset,
                             int row,
                             int column)

Draws the visual representation of a single data item when the plot has a vertical orientation.

Parameters:

g2 - the graphics device.

dataArea - the area within which the plot is being drawn.

plot - the plot (can be used to obtain standard color information etc).

domainAxis - the domain axis.

rangeAxis - the range axis.

dataset - the dataset.

row - the row index (zero-based).

column - the column index (zero-based).