Module org.jfree.chart
Package org.jfree.chart.renderer.xy

Class XYLineAndShapeRenderer

    • Constructor Detail

      • XYLineAndShapeRenderer

        public XYLineAndShapeRenderer()
        Creates a new renderer with both lines and shapes visible.

      • XYLineAndShapeRenderer

        public XYLineAndShapeRenderer​(boolean lines,
                              boolean shapes)
        Creates a new renderer.
        Parameters:
        lines - lines visible?
        shapes - shapes visible?

    • Method Detail

      • getItemLineVisible

        public boolean getItemLineVisible​(int series,
                                  int item)
        Returns the flag used to control whether or not the shape for an item is visible.
        Parameters:
        series - the series index (zero-based).
        item - the item index (zero-based).
        Returns:
        A boolean.

      • getItemShapeVisible

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

        The default implementation passes control to the getSeriesShapesVisible() 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.

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

      • setDrawOutlines

        public void setDrawOutlines​(boolean flag)
        Sets the flag that controls whether outlines are drawn for shapes, and sends a RendererChangeEvent to all registered listeners.

        In some cases, shapes look better if they do NOT have an outline, but this flag allows you to set your own preference.

        Parameters:
        flag - the flag.
        See Also:
        getDrawOutlines()

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

        Refer to XYLineAndShapeRendererDemo2.java to see the effect of this flag.

        Returns:
        A boolean.
        See Also:
        setUseFillPaint(boolean), getUseOutlinePaint()

      • 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:
        getUseFillPaint()

      • setUseOutlinePaint

        public void setUseOutlinePaint​(boolean flag)
        Sets the flag that controls whether the outline paint is used to draw shape outlines, and sends a RendererChangeEvent to all registered listeners.

        Refer to XYLineAndShapeRendererDemo2.java to see the effect of this flag.

        Parameters:
        flag - the flag.
        See Also:
        getUseOutlinePaint()

      • initialise

        public XYItemRendererState initialise​(Graphics2D g2,
                                      Rectangle2D dataArea,
                                      XYPlot plot,
                                      XYDataset data,
                                      PlotRenderingInfo info)
        Initialises the renderer.

        This method will be called before the first item is rendered, giving the renderer an opportunity to initialise any state information it wants to maintain. The renderer can do nothing if it chooses.

        Specified by:
        initialise in interface XYItemRenderer
        Overrides:
        initialise in class AbstractXYItemRenderer
        Parameters:
        g2 - the graphics device.
        dataArea - the area inside the axes.
        plot - the plot.
        data - the data.
        info - an optional info collection object to return data back to the caller.
        Returns:
        The renderer state.

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

      • isLinePass

        protected boolean isLinePass​(int pass)
        Returns true if the specified pass is the one for drawing lines.
        Parameters:
        pass - the pass.
        Returns:
        A boolean.

      • isItemPass

        protected boolean isItemPass​(int pass)
        Returns true if the specified pass is the one for drawing items.
        Parameters:
        pass - the pass.
        Returns:
        A boolean.

      • drawPrimaryLine

        protected void drawPrimaryLine​(XYItemRendererState state,
                               Graphics2D g2,
                               XYPlot plot,
                               XYDataset dataset,
                               int pass,
                               int series,
                               int item,
                               ValueAxis domainAxis,
                               ValueAxis rangeAxis,
                               Rectangle2D dataArea)
        Draws the item (first pass). This method draws the lines connecting the items.
        Parameters:
        g2 - the graphics device.
        state - the renderer state.
        dataArea - the area within which the data 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.
        pass - the pass.
        series - the series index (zero-based).
        item - the item index (zero-based).

      • drawFirstPassShape

        protected void drawFirstPassShape​(Graphics2D g2,
                                  int pass,
                                  int series,
                                  int item,
                                  Shape shape)
        Draws the first pass shape.
        Parameters:
        g2 - the graphics device.
        pass - the pass.
        series - the series index.
        item - the item index.
        shape - the shape.

      • drawPrimaryLineAsPath

        protected void drawPrimaryLineAsPath​(XYItemRendererState state,
                                     Graphics2D g2,
                                     XYPlot plot,
                                     XYDataset dataset,
                                     int pass,
                                     int series,
                                     int item,
                                     ValueAxis domainAxis,
                                     ValueAxis rangeAxis,
                                     Rectangle2D dataArea)
        Draws the item (first pass). This method draws the lines connecting the items. Instead of drawing separate lines, a GeneralPath is constructed and drawn at the end of the series painting.
        Parameters:
        g2 - the graphics device.
        state - the renderer state.
        plot - the plot (can be used to obtain standard color information etc).
        dataset - the dataset.
        pass - the pass.
        series - the series index (zero-based).
        item - the item index (zero-based).
        domainAxis - the domain axis.
        rangeAxis - the range axis.
        dataArea - the area within which the data is being drawn.

      • drawSecondaryPass

        protected void drawSecondaryPass​(Graphics2D g2,
                                 XYPlot plot,
                                 XYDataset dataset,
                                 int pass,
                                 int series,
                                 int item,
                                 ValueAxis domainAxis,
                                 Rectangle2D dataArea,
                                 ValueAxis rangeAxis,
                                 CrosshairState crosshairState,
                                 EntityCollection entities)
        Draws the item shapes and adds chart entities (second pass). This method draws the shapes which mark the item positions. If entities is not null it will be populated with entity information for points that fall within the data area.
        Parameters:
        g2 - the graphics device.
        plot - the plot (can be used to obtain standard color information etc).
        domainAxis - the domain axis.
        dataArea - the area within which the data is being drawn.
        rangeAxis - the range axis.
        dataset - the dataset.
        pass - the pass.
        series - the series index (zero-based).
        item - the item index (zero-based).
        crosshairState - the crosshair state.
        entities - the entity collection.

      • getLegendItem

        public org.jfree.chart.legend.LegendItem getLegendItem​(int datasetIndex,
                                                       int series)
        Returns a legend item for the specified 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 (possibly null).

      • equals

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