Package org.jfree.chart.renderer

Class StandardXYItemRenderer

java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.AbstractXYItemRenderer
org.jfree.chart.renderer.StandardXYItemRenderer
All Implemented Interfaces:
Serializable, Cloneable, XYItemRenderer, org.jfree.util.PublicCloneable
Direct Known Subclasses:
CyclicXYItemRenderer, DefaultXYItemRenderer
public class StandardXYItemRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, org.jfree.util.PublicCloneable, Serializable
Standard 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.
See Also:
Serialized Form

  • Field Details

    • SHAPES

      public static final int SHAPES
      Constant for the type of rendering (shapes only).
      See Also:
      Constant Field Values

    • LINES

      public static final int LINES
      Constant for the type of rendering (lines only).
      See Also:
      Constant Field Values

    • SHAPES_AND_LINES

      public static final int SHAPES_AND_LINES
      Constant for the type of rendering (shapes and lines).
      See Also:
      Constant Field Values

    • IMAGES

      public static final int IMAGES
      Constant for the type of rendering (images only).
      See Also:
      Constant Field Values

    • DISCONTINUOUS

      public static final int DISCONTINUOUS
      Constant for the type of rendering (discontinuous lines).
      See Also:
      Constant Field Values

    • DISCONTINUOUS_LINES

      public static final int DISCONTINUOUS_LINES
      Constant for the type of rendering (discontinuous lines).
      See Also:
      Constant Field Values

  • Constructor Details

    • StandardXYItemRenderer

      public StandardXYItemRenderer()
      Constructs a new renderer.

    • StandardXYItemRenderer

      public StandardXYItemRenderer​(int type)
      Constructs a new renderer.

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

      Parameters:
      type - the type.

    • StandardXYItemRenderer

      public StandardXYItemRenderer​(int type, XYToolTipGenerator toolTipGenerator)
      Constructs a new renderer.

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

      Parameters:
      type - the type of renderer.
      toolTipGenerator - the item label generator (null permitted).

    • StandardXYItemRenderer

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

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

      Parameters:
      type - the type of renderer.
      toolTipGenerator - the item label generator (null permitted).
      urlGenerator - the URL generator.

  • Method Details

    • getPlotShapes

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

    • setPlotShapes

      public void setPlotShapes​(boolean flag)
      Sets the flag that controls whether or not a shape is plotted at each data point.
      Parameters:
      flag - the flag.

    • getItemShapeFilled

      public boolean getItemShapeFilled​(int series, int item)
      Returns the flag used to control whether or not the shape for an item is filled.

      The default implementation passes control to the getSeriesShapesFilled method. You can override this method if you require different behaviour.

      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      A boolean.

    • getSeriesShapesFilled

      public boolean getSeriesShapesFilled​(int series)
      Returns the flag used to control whether or not the shapes for a series are filled.
      Parameters:
      series - the series index (zero-based).
      Returns:
      A boolean.

    • setShapesFilled

      public void setShapesFilled​(boolean filled)
      Sets the 'shapes filled' for ALL series.
      Parameters:
      filled - the flag.

    • setShapesFilled

      public void setShapesFilled​(Boolean filled)
      Sets the 'shapes filled' for ALL series.
      Parameters:
      filled - the flag (null permitted).

    • setSeriesShapesFilled

      public void setSeriesShapesFilled​(int series, Boolean flag)
      Sets the 'shapes filled' flag for a series.
      Parameters:
      series - the series index (zero-based).
      flag - the flag.

    • getDefaultShapesFilled

      public Boolean getDefaultShapesFilled()
      Returns the default 'shape filled' attribute.
      Returns:
      The default flag.

    • setDefaultShapesFilled

      public void setDefaultShapesFilled​(Boolean flag)
      Sets the default 'shapes filled' flag.
      Parameters:
      flag - the flag.

    • getPlotLines

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

    • setPlotLines

      public void setPlotLines​(boolean flag)
      Sets the flag that controls whether or not a line is plotted between each data point.
      Parameters:
      flag - the flag.

    • getGapThreshold

      public double getGapThreshold()
      Returns the gap threshold for discontinuous lines.
      Returns:
      the gap threshold.

    • setGapThreshold

      public void setGapThreshold​(double t)
      Sets the gap threshold for discontinuous lines.
      Parameters:
      t - the threshold.

    • getPlotImages

      public boolean getPlotImages()
      Returns true if images are being plotted by the renderer.
      Returns:
      true if images are being plotted by the renderer.

    • setPlotImages

      public void setPlotImages​(boolean flag)
      Sets the flag that controls whether or not an image is drawn at each data point.
      Parameters:
      flag - the flag.

    • getPlotDiscontinuous

      public boolean getPlotDiscontinuous()
      Returns true if lines should be discontinuous.
      Returns:
      true if images are being plotted by the renderer.

    • getLegendItem

      public LegendItem getLegendItem​(int datasetIndex, int series)
      Returns a legend item for a series.
      Specified by:
      getLegendItem in interface XYItemRenderer
      Overrides:
      getLegendItem in class AbstractXYItemRenderer
      Parameters:
      datasetIndex - the dataset index (zero-based).
      series - the series index (zero-based).
      Returns:
      a legend item for the series.

    • 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 data is being drawn.
      info - collects information 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.