Package org.jfree.chart.renderer.xy

Class StackedXYAreaRenderer

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values

      • shapePaint

        private transient java.awt.Paint shapePaint
        Custom Paint for drawing all shapes, if null defaults to series shapes

      • shapeStroke

        private transient java.awt.Stroke shapeStroke
        Custom Stroke for drawing all shapes, if null defaults to series strokes.

    • Constructor Detail

      • StackedXYAreaRenderer

        public StackedXYAreaRenderer()
        Creates a new renderer.

      • StackedXYAreaRenderer

        public StackedXYAreaRenderer​(int type)
        Constructs a new renderer.
        Parameters:
        type - the type of the renderer.

      • StackedXYAreaRenderer

        public StackedXYAreaRenderer​(int type,
                             XYToolTipGenerator labelGenerator,
                             XYURLGenerator urlGenerator)
        Constructs a new renderer. To specify the type of renderer, use one of the constants: SHAPES, LINES, SHAPES_AND_LINES, AREA or AREA_AND_SHAPES.
        Parameters:
        type - the type of renderer.
        labelGenerator - the tool tip generator (null permitted).
        urlGenerator - the URL generator (null permitted).

    • Method Detail

      • getShapePaint

        public java.awt.Paint getShapePaint()
        Returns the paint used for rendering shapes, or null if using series paints.
        Returns:
        The paint (possibly null).
        See Also:
        setShapePaint(Paint)

      • setShapePaint

        public void setShapePaint​(java.awt.Paint shapePaint)
        Sets the paint for rendering shapes and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        shapePaint - the paint (null permitted).
        See Also:
        getShapePaint()

      • getShapeStroke

        public java.awt.Stroke getShapeStroke()
        Returns the stroke used for rendering shapes, or null if using series strokes.
        Returns:
        The stroke (possibly null).
        See Also:
        setShapeStroke(Stroke)

      • setShapeStroke

        public void setShapeStroke​(java.awt.Stroke shapeStroke)
        Sets the stroke for rendering shapes and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        shapeStroke - the stroke (null permitted).
        See Also:
        getShapeStroke()

      • initialise

        public XYItemRendererState initialise​(java.awt.Graphics2D g2,
                                      java.awt.geom.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.
        Specified by:
        initialise in interface XYItemRenderer
        Overrides:
        initialise in class XYAreaRenderer
        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:
        A state object that should be passed to subsequent calls to the drawItem() method.

      • drawItem

        public void drawItem​(java.awt.Graphics2D g2,
                     XYItemRendererState state,
                     java.awt.geom.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
        Overrides:
        drawItem in class XYAreaRenderer
        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 - information about crosshairs on a plot.
        pass - the pass index.
        Throws:
        java.lang.ClassCastException - if state is not an instance of StackedXYAreaRendererState or dataset is not an instance of TableXYDataset.

      • getPreviousHeight

        protected double getPreviousHeight​(TableXYDataset dataset,
                                   int series,
                                   int index)
        Calculates the stacked value of the all series up to, but not including series for the specified item. It returns 0.0 if series is the first series, i.e. 0.
        Parameters:
        dataset - the dataset.
        series - the series.
        index - the index.
        Returns:
        The cumulative value for all series' values up to but excluding series for index.

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests the renderer for equality with an arbitrary object.
        Overrides:
        equals in class XYAreaRenderer
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Returns a clone of the renderer.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class XYAreaRenderer
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if the renderer cannot be cloned.

      • readObject

        private void readObject​(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
        Provides serialization support.
        Parameters:
        stream - the input stream.
        Throws:
        java.io.IOException - if there is an I/O error.
        java.lang.ClassNotFoundException - if there is a classpath problem.

      • writeObject

        private void writeObject​(java.io.ObjectOutputStream stream)
                  throws java.io.IOException
        Provides serialization support.
        Parameters:
        stream - the output stream.
        Throws:
        java.io.IOException - if there is an I/O error.