Package org.jfree.chart.renderer

Class XYBoxAndWhiskerRenderer

java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.AbstractXYItemRenderer
org.jfree.chart.renderer.XYBoxAndWhiskerRenderer
All Implemented Interfaces:
Serializable, Cloneable, XYItemRenderer, org.jfree.util.PublicCloneable
public class XYBoxAndWhiskerRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, org.jfree.util.PublicCloneable, Serializable
A renderer that draws box-and-whisker items on an XYPlot. This renderer requires a BoxAndWhiskerXYDataset).

This renderer does not include any code to calculate the crosshair point.

Author:
David Browning
See Also:
Serialized Form

  • Constructor Details

    • XYBoxAndWhiskerRenderer

      public XYBoxAndWhiskerRenderer()
      Creates a new renderer for box and whisker charts.

    • XYBoxAndWhiskerRenderer

      public XYBoxAndWhiskerRenderer​(double boxWidth)
      Creates a new renderer for box and whisker charts.

      Use -1 for the box width if you prefer the width to be calculated automatically.

      Parameters:
      boxWidth - the box width.

  • Method Details

    • getBoxWidth

      public double getBoxWidth()
      Returns the width of each box.
      Returns:
      the box width.

    • setBoxWidth

      public void setBoxWidth​(double width)
      Sets the box width.

      If you set the width to a negative value, the renderer will calculate the box width automatically based on the space available on the chart.

      Parameters:
      width - The width.

    • getPaint

      public Paint getPaint()
      Returns the paint used to fill boxes.
      Returns:
      the paint (possibly null).

    • setPaint

      public void setPaint​(Paint paint)
      Sets the paint used to fill boxes.

      Registered property change listeners are notified that the "BoxAndWhiskerRenderer.paint" property has changed.

      Specified by:
      setPaint in interface XYItemRenderer
      Overrides:
      setPaint in class AbstractRenderer
      Parameters:
      paint - the paint (null permitted).

    • getFillBox

      public boolean getFillBox()
      Returns the flag that controls whether or not the box is filled.
      Returns:
      A boolean.

    • setFillBox

      public void setFillBox​(boolean flag)
      Sets the flag that controls whether or not the box is filled and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      flag - the flag.

    • getArtifactPaint

      public Paint getArtifactPaint()
      Returns the paint used to paint the various artifacts such as outliers, farout symbol, median line and the averages ellipse.
      Returns:
      The paint.

    • setArtifactPaint

      public void setArtifactPaint​(Paint artifactPaint)
      Sets the paint used to paint the various artifacts such as outliers, farout symbol, median line and the averages ellipse.
      Parameters:
      artifactPaint - the paint.

    • drawItem

      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)
      Draws the visual representation of a single data item.
      Specified by:
      drawItem in interface XYItemRenderer
      Parameters:
      g2 - the graphics device.
      state - the renderer state.
      dataArea - the area within which the plot is being drawn.
      info - collects info about the drawing.
      plot - the plot (can be used to obtain standard color information etc).
      domainAxis - the domain axis.
      rangeAxis - the range axis.
      dataset - the dataset.
      series - the series index (zero-based).
      item - the item index (zero-based).
      crosshairState - crosshair information for the plot (null permitted).
      pass - the pass index.

    • drawHorizontalItem

      public void drawHorizontalItem​(Graphics2D g2, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
      Draws the visual representation of a single data item.
      Parameters:
      g2 - the graphics device.
      dataArea - the area within which the plot is being drawn.
      info - collects info about the drawing.
      plot - the plot (can be used to obtain standard color information etc).
      domainAxis - the domain axis.
      rangeAxis - the range axis.
      dataset - the dataset.
      series - the series index (zero-based).
      item - the item index (zero-based).
      crosshairState - crosshair information for the plot (null permitted).
      pass - the pass index.

    • drawVerticalItem

      public void drawVerticalItem​(Graphics2D g2, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
      Draws the visual representation of a single data item.
      Parameters:
      g2 - the graphics device.
      dataArea - the area within which the plot is being drawn.
      info - collects info about the drawing.
      plot - the plot (can be used to obtain standard color information etc).
      domainAxis - the domain axis.
      rangeAxis - the range axis.
      dataset - the dataset.
      series - the series index (zero-based).
      item - the item index (zero-based).
      crosshairState - crosshair information for the plot (null permitted).
      pass - the pass index.

    • equals

      public boolean equals​(Object obj)
      Tests this renderer for equality with another object.
      Overrides:
      equals in class AbstractXYItemRenderer
      Parameters:
      obj - the object.
      Returns:
      true or false.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the renderer.
      Specified by:
      clone in interface org.jfree.util.PublicCloneable
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the renderer cannot be cloned.