Package 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:
Serializable, Cloneable, CategoryItemRenderer, org.jfree.util.PublicCloneable
public class BoxAndWhiskerRenderer
extends AbstractCategoryItemRenderer
implements Cloneable, org.jfree.util.PublicCloneable, Serializable
A box-and-whisker renderer.
See Also:
Serialized Form

  • Constructor Details

    • BoxAndWhiskerRenderer

      public BoxAndWhiskerRenderer()
      Default constructor.

  • Method Details

    • getArtifactPaint

      public Paint getArtifactPaint()
      Returns the paint used to color the median and average markers.
      Returns:
      A paint.

    • setArtifactPaint

      public void setArtifactPaint​(Paint paint)
      Sets the paint used to color the median and average markers.
      Parameters:
      paint - the paint.

    • 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.

    • 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​(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, 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.
      rendererIndex - the renderer index.
      info - collects chart rendering information for return to caller.
      Returns:
      The renderer state.

    • drawItem

      public void drawItem​(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column)
      Draw a single data item.
      Specified by:
      drawItem in interface CategoryItemRenderer
      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​(Graphics2D g2, CategoryItemRendererState state, 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.
      state - the renderer state.
      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​(Graphics2D g2, CategoryItemRendererState state, 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.
      state - the renderer state.
      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).

    • equals

      public boolean equals​(Object obj)
      Tests this renderer for equality with an arbitrary object.
      Overrides:
      equals in class AbstractCategoryItemRenderer
      Parameters:
      obj - the object (null permitted).
      Returns:
      true or false.