Module platform

Class DefaultPolarItemRenderer

java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.DefaultPolarItemRenderer
All Implemented Interfaces:
Serializable, Cloneable, PolarItemRenderer

public class DefaultPolarItemRenderer extends AbstractRenderer implements PolarItemRenderer
A renderer that can be used with the PolarPlot class.
See Also:
  • Constructor Details

    • DefaultPolarItemRenderer

      public DefaultPolarItemRenderer()
      Creates a new instance of DefaultPolarItemRenderer
  • Method Details

    • setPlot

      public void setPlot(PolarPlot plot)
      Set the plot associated with this renderer.
      Specified by:
      setPlot in interface PolarItemRenderer
      Parameters:
      plot - the plot.
      See Also:
    • getPlot

      public PolarPlot getPlot()
      Return the plot associated with this renderer.
      Specified by:
      getPlot in interface PolarItemRenderer
      Returns:
      The plot.
      See Also:
    • getDrawOutlineWhenFilled

      public boolean getDrawOutlineWhenFilled()
      Returns true if the renderer will draw an outline around a filled polygon, false otherwise.
      Returns:
      A boolean.
    • setDrawOutlineWhenFilled

      public void setDrawOutlineWhenFilled(boolean drawOutlineWhenFilled)
      Set the flag that controls whether the outline around a filled polygon will be drawn or not and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      drawOutlineWhenFilled - the flag.
    • getFillComposite

      public Composite getFillComposite()
      Get the composite that is used for filling.
      Returns:
      The composite (never null).
    • setFillComposite

      public void setFillComposite(Composite composite)
      Sets the composite which will be used for filling polygons and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      composite - the composite to use (null not permitted).
    • getShapesVisible

      public boolean getShapesVisible()
      Returns true if a shape will be drawn for every item, or false if not.
      Returns:
      A boolean.
    • setShapesVisible

      public void setShapesVisible(boolean visible)
      Set the flag that controls whether a shape will be drawn for every item, or not and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the flag.
    • getConnectFirstAndLastPoint

      public boolean getConnectFirstAndLastPoint()
      Returns true if first and last point of a series will be connected, false otherwise.
      Returns:
      The current status of the flag.
    • setConnectFirstAndLastPoint

      public void setConnectFirstAndLastPoint(boolean connect)
      Set the flag that controls whether the first and last point of a series will be connected or not and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      connect - the flag.
    • getDrawingSupplier

      public DrawingSupplier getDrawingSupplier()
      Returns the drawing supplier from the plot.
      Specified by:
      getDrawingSupplier in class AbstractRenderer
      Returns:
      The drawing supplier.
    • isSeriesFilled

      public boolean isSeriesFilled(int series)
      Returns true if the renderer should fill the specified series, and false otherwise.
      Parameters:
      series - the series index (zero-based).
      Returns:
      A boolean.
    • setSeriesFilled

      public void setSeriesFilled(int series, boolean filled)
      Sets a flag that controls whether or not a series is filled.
      Parameters:
      series - the series index.
      filled - the flag.
    • getUseFillPaint

      public boolean getUseFillPaint()
      Returns true if the renderer should use the fill paint setting to fill shapes, and false if it should just use the regular paint.
      Returns:
      A boolean.
      See Also:
    • setUseFillPaint

      public void setUseFillPaint(boolean flag)
      Sets the flag that controls whether the fill paint is used to fill shapes, and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      flag - the flag.
      See Also:
    • getLegendLine

      public Shape getLegendLine()
      Returns the shape used to represent a line in the legend.
      Returns:
      The legend line (never null).
      See Also:
    • setLegendLine

      public void setLegendLine(Shape line)
      Sets the shape used as a line in each legend item and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      line - the line (null not permitted).
      See Also:
    • addEntity

      protected void addEntity(EntityCollection entities, Shape area, XYDataset dataset, int series, int item, double entityX, double entityY)
      Adds an entity to the collection.
      Parameters:
      entities - the entity collection being populated.
      area - the entity area (if null a default will be used).
      dataset - the dataset.
      series - the series.
      item - the item.
      entityX - the entity's center x-coordinate in user space (only used if area is null).
      entityY - the entity's center y-coordinate in user space (only used if area is null).
    • drawSeries

      public void drawSeries(Graphics2D g2, Rectangle2D dataArea, PlotRenderingInfo info, PolarPlot plot, XYDataset dataset, int seriesIndex)
      Plots the data for a given series.
      Specified by:
      drawSeries in interface PolarItemRenderer
      Parameters:
      g2 - the drawing surface.
      dataArea - the data area.
      info - collects plot rendering info.
      plot - the plot.
      dataset - the dataset.
      seriesIndex - the series index.
    • drawAngularGridLines

      public void drawAngularGridLines(Graphics2D g2, PolarPlot plot, List ticks, Rectangle2D dataArea)
      Draw the angular gridlines - the spokes.
      Specified by:
      drawAngularGridLines in interface PolarItemRenderer
      Parameters:
      g2 - the drawing surface.
      plot - the plot (null not permitted).
      ticks - the ticks (null not permitted).
      dataArea - the data area.
    • drawRadialGridLines

      public void drawRadialGridLines(Graphics2D g2, PolarPlot plot, ValueAxis radialAxis, List ticks, Rectangle2D dataArea)
      Draw the radial gridlines - the rings.
      Specified by:
      drawRadialGridLines in interface PolarItemRenderer
      Parameters:
      g2 - the drawing surface (null not permitted).
      plot - the plot (null not permitted).
      radialAxis - the radial axis (null not permitted).
      ticks - the ticks (null not permitted).
      dataArea - the data area.
    • getLegendItem

      public LegendItem getLegendItem(int series)
      Return the legend for the given series.
      Specified by:
      getLegendItem in interface PolarItemRenderer
      Parameters:
      series - the series index.
      Returns:
      The legend item.
    • getToolTipGenerator

      public XYToolTipGenerator getToolTipGenerator(int series, int item)
      Returns the tooltip generator for the specified series and item.
      Specified by:
      getToolTipGenerator in interface PolarItemRenderer
      Parameters:
      series - the series index.
      item - the item index.
      Returns:
      The tooltip generator (possibly null).
    • getSeriesToolTipGenerator

      public XYToolTipGenerator getSeriesToolTipGenerator(int series)
      Returns the tool tip generator for the specified series.
      Specified by:
      getSeriesToolTipGenerator in interface PolarItemRenderer
      Parameters:
      series - the series index (zero based).
      Returns:
      The tooltip generator (possibly null).
      See Also:
    • setSeriesToolTipGenerator

      public void setSeriesToolTipGenerator(int series, XYToolTipGenerator generator)
      Sets the tooltip generator for the specified series.
      Specified by:
      setSeriesToolTipGenerator in interface PolarItemRenderer
      Parameters:
      series - the series index.
      generator - the tool tip generator (null permitted).
      See Also:
    • getBaseToolTipGenerator

      public XYToolTipGenerator getBaseToolTipGenerator()
      Returns the default tool tip generator.
      Specified by:
      getBaseToolTipGenerator in interface PolarItemRenderer
      Returns:
      The default tool tip generator (possibly null).
      See Also:
    • setBaseToolTipGenerator

      public void setBaseToolTipGenerator(XYToolTipGenerator generator)
      Sets the default tool tip generator and sends a RendererChangeEvent to all registered listeners.
      Specified by:
      setBaseToolTipGenerator in interface PolarItemRenderer
      Parameters:
      generator - the generator (null permitted).
      See Also:
    • getURLGenerator

      public XYURLGenerator getURLGenerator()
      Returns the URL generator.
      Specified by:
      getURLGenerator in interface PolarItemRenderer
      Returns:
      The URL generator (possibly null).
    • setURLGenerator

      public void setURLGenerator(XYURLGenerator urlGenerator)
      Sets the URL generator.
      Specified by:
      setURLGenerator in interface PolarItemRenderer
      Parameters:
      urlGenerator - the generator (null permitted)
    • getLegendItemToolTipGenerator

      public XYSeriesLabelGenerator getLegendItemToolTipGenerator()
      Returns the legend item tool tip generator.
      Returns:
      The tool tip generator (possibly null).
      See Also:
    • setLegendItemToolTipGenerator

      public void setLegendItemToolTipGenerator(XYSeriesLabelGenerator generator)
      Sets the legend item tool tip generator and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).
      See Also:
    • getLegendItemURLGenerator

      public XYSeriesLabelGenerator getLegendItemURLGenerator()
      Returns the legend item URL generator.
      Returns:
      The URL generator (possibly null).
      See Also:
    • setLegendItemURLGenerator

      public void setLegendItemURLGenerator(XYSeriesLabelGenerator generator)
      Sets the legend item URL generator and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).
      See Also:
    • equals

      public boolean equals(Object obj)
      Tests this renderer for equality with an arbitrary object.
      Overrides:
      equals in class AbstractRenderer
      Parameters:
      obj - the object (null not permitted).
      Returns:
      true if this renderer is equal to obj, and false otherwise.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the renderer.
      Overrides:
      clone in class AbstractRenderer
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the renderer cannot be cloned.