Module org.jfree.chart
Package org.jfree.chart.plot

Class Plot

    • Constructor Detail

      • Plot

        protected Plot()
        Creates a new plot.

    • Method Detail

      • getChart

        public JFreeChart getChart()
        Returns the chart that this plot is assigned to. This method can return null if the plot is not yet assigned to a plot, or if the plot is a subplot of another plot.
        Returns:
        The chart (possibly null).

      • setChart

        public void setChart​(JFreeChart chart)
        Sets the chart that the plot is assigned to. This method is not intended for external use.
        Parameters:
        chart - the chart (null permitted).

      • fetchElementHintingFlag

        public boolean fetchElementHintingFlag()
        Fetches the element hinting flag from the chart that this plot is assigned to. If the plot is not assigned (directly or indirectly) to a chart instance, this method will return false.
        Returns:
        A boolean.

      • setNoDataMessage

        public void setNoDataMessage​(String message)
        Sets the message that is displayed when the dataset is empty or null, and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        message - the message (null permitted).
        See Also:
        getNoDataMessage()

      • getPlotType

        public abstract String getPlotType()
        Returns a short string describing the plot type.

        Note: this gets used in the chart property editing user interface, but there needs to be a better mechanism for identifying the plot type.

        Returns:
        A short string describing the plot type (never null).

      • setParent

        public void setParent​(Plot parent)
        Sets the parent plot. This method is intended for internal use, you shouldn't need to call it directly.
        Parameters:
        parent - the parent plot (null permitted).
        See Also:
        getParent()

      • isSubplot

        public boolean isSubplot()
        Returns true if this plot is part of a combined plot structure (that is, getParent() returns a non-null value), and false otherwise.
        Returns:
        true if this plot is part of a combined plot structure.
        See Also:
        getParent()

      • setBackgroundAlpha

        public void setBackgroundAlpha​(float alpha)
        Sets the alpha transparency of the plot area background, and notifies registered listeners that the plot has been modified.
        Parameters:
        alpha - the new alpha value (in the range 0.0f to 1.0f).
        See Also:
        getBackgroundAlpha()

      • setDrawingSupplier

        public void setDrawingSupplier​(DrawingSupplier supplier)
        Sets the drawing supplier for the plot and sends a PlotChangeEvent to all registered listeners. The drawing supplier is responsible for supplying a limitless (possibly repeating) sequence of Paint, Stroke and Shape objects that the plot's renderer(s) can use to populate its (their) tables.
        Parameters:
        supplier - the new supplier.
        See Also:
        getDrawingSupplier()

      • setDrawingSupplier

        public void setDrawingSupplier​(DrawingSupplier supplier,
                               boolean notify)
        Sets the drawing supplier for the plot and, if requested, sends a PlotChangeEvent to all registered listeners. The drawing supplier is responsible for supplying a limitless (possibly repeating) sequence of Paint, Stroke and Shape objects that the plot's renderer(s) can use to populate its (their) tables.
        Parameters:
        supplier - the new supplier.
        notify - notify listeners?
        See Also:
        getDrawingSupplier()

      • getBackgroundImageAlpha

        public float getBackgroundImageAlpha()
        Returns the alpha transparency used to draw the background image. This is a value in the range 0.0f to 1.0f, where 0.0f is fully transparent and 1.0f is fully opaque.
        Returns:
        The alpha transparency.
        See Also:
        setBackgroundImageAlpha(float)

      • setBackgroundImageAlpha

        public void setBackgroundImageAlpha​(float alpha)
        Sets the alpha transparency used when drawing the background image.
        Parameters:
        alpha - the alpha transparency (in the range 0.0f to 1.0f, where 0.0f is fully transparent, and 1.0f is fully opaque).
        Throws:
        IllegalArgumentException - if alpha is not within the specified range.
        See Also:
        getBackgroundImageAlpha()

      • isOutlineVisible

        public boolean isOutlineVisible()
        Returns the flag that controls whether or not the plot outline is drawn. The default value is true. Note that for historical reasons, the plot's outline paint and stroke can take on null values, in which case the outline will not be drawn even if this flag is set to true.
        Returns:
        The outline visibility flag.
        See Also:
        setOutlineVisible(boolean)

      • setOutlineVisible

        public void setOutlineVisible​(boolean visible)
        Sets the flag that controls whether or not the plot's outline is drawn, and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        visible - the new flag value.
        See Also:
        isOutlineVisible()

      • setOutlineStroke

        public void setOutlineStroke​(Stroke stroke)
        Sets the stroke used to outline the plot area and sends a PlotChangeEvent to all registered listeners. If you set this attribute to null, no outline will be drawn.
        Parameters:
        stroke - the stroke (null permitted).
        See Also:
        getOutlineStroke()

      • setOutlinePaint

        public void setOutlinePaint​(Paint paint)
        Sets the paint used to draw the outline of the plot area and sends a PlotChangeEvent to all registered listeners. If you set this attribute to null, no outline will be drawn.
        Parameters:
        paint - the paint (null permitted).
        See Also:
        getOutlinePaint()

      • getLegendItems

        public org.jfree.chart.legend.LegendItemCollection getLegendItems()
        Returns the legend items for the plot. By default, this method returns null. Subclasses should override to return a LegendItemCollection.
        Specified by:
        getLegendItems in interface org.jfree.chart.legend.LegendItemSource
        Returns:
        The legend items for the plot (possibly null).

      • isNotify

        public boolean isNotify()
        Returns a flag that controls whether or not change events are sent to registered listeners.
        Returns:
        A boolean.
        See Also:
        setNotify(boolean)

      • setNotify

        public void setNotify​(boolean notify)
        Sets a flag that controls whether or not listeners receive PlotChangeEvent notifications.
        Parameters:
        notify - a boolean.
        See Also:
        isNotify()

      • notifyListeners

        public void notifyListeners​(PlotChangeEvent event)
        Notifies all registered listeners that the plot has been modified.
        Parameters:
        event - information about the change event.

      • receive

        public void receive​(ChartElementVisitor visitor)
        Receives a chart element visitor. Many plot subclasses will override this method to handle their subcomponents.
        Specified by:
        receive in interface ChartElement
        Parameters:
        visitor - the visitor (null not permitted).

      • draw

        public abstract void draw​(Graphics2D g2,
                          Rectangle2D area,
                          Point2D anchor,
                          PlotState parentState,
                          PlotRenderingInfo info)
        Draws the plot within the specified area. The anchor is a point on the chart that is specified externally (for instance, it may be the last point of the last mouse click performed by the user) - plots can use or ignore this value as they see fit.

        Subclasses need to provide an implementation of this method, obviously.
        Parameters:
        g2 - the graphics device.
        area - the plot area.
        anchor - the anchor point (null permitted).
        parentState - the parent state (if any, null permitted).
        info - carries back plot rendering info.

      • drawBackground

        public void drawBackground​(Graphics2D g2,
                           Rectangle2D area)
        Draws the plot background (the background color and/or image).

        This method will be called during the chart drawing process and is declared public so that it can be accessed by the renderers used by certain subclasses. You shouldn't need to call this method directly.

        Parameters:
        g2 - the graphics device.
        area - the area within which the plot should be drawn.

      • fillBackground

        protected void fillBackground​(Graphics2D g2,
                              Rectangle2D area,
                              PlotOrientation orientation)
        Fills the specified area with the background paint. If the background paint is an instance of GradientPaint, the gradient will run in the direction suggested by the plot's orientation.
        Parameters:
        g2 - the graphics target.
        area - the plot area.
        orientation - the plot orientation (null not permitted).

      • drawOutline

        public void drawOutline​(Graphics2D g2,
                        Rectangle2D area)
        Draws the plot outline. This method will be called during the chart drawing process and is declared public so that it can be accessed by the renderers used by certain subclasses. You shouldn't need to call this method directly.
        Parameters:
        g2 - the graphics device.
        area - the area within which the plot should be drawn.

      • drawNoDataMessage

        protected void drawNoDataMessage​(Graphics2D g2,
                                 Rectangle2D area)
        Draws a message to state that there is no data to plot.
        Parameters:
        g2 - the graphics device.
        area - the area within which the plot should be drawn.

      • createAndAddEntity

        protected void createAndAddEntity​(Rectangle2D dataArea,
                                  PlotRenderingInfo plotState,
                                  String toolTip,
                                  String urlText)
        Creates a plot entity that contains a reference to the plot and the data area as shape.
        Parameters:
        dataArea - the data area used as hot spot for the entity.
        plotState - the plot rendering info containing a reference to the EntityCollection.
        toolTip - the tool tip (defined in the respective Plot subclass) (null permitted).
        urlText - the url (defined in the respective Plot subclass) (null permitted).

      • handleClick

        public void handleClick​(int x,
                        int y,
                        PlotRenderingInfo info)
        Handles a 'click' on the plot. Since the plot does not maintain any information about where it has been drawn, the plot rendering info is supplied as an argument so that the plot dimensions can be determined.
        Parameters:
        x - the x coordinate (in Java2D space).
        y - the y coordinate (in Java2D space).
        info - an object containing information about the dimensions of the plot.

      • zoom

        public void zoom​(double percent)
        Performs a zoom on the plot. Subclasses should override if zooming is appropriate for the type of plot.
        Parameters:
        percent - the zoom percentage.

      • datasetChanged

        public void datasetChanged​(DatasetChangeEvent event)
        Receives notification of a change to the plot's dataset.

        The plot reacts by passing on a plot change event to all registered listeners.

        Specified by:
        datasetChanged in interface DatasetChangeListener
        Parameters:
        event - information about the event (not used here).

      • getRectX

        protected double getRectX​(double x,
                          double w1,
                          double w2,
                          RectangleEdge edge)
        Adjusts the supplied x-value.
        Parameters:
        x - the x-value.
        w1 - width 1.
        w2 - width 2.
        edge - the edge (left or right).
        Returns:
        The adjusted x-value.

      • getRectY

        protected double getRectY​(double y,
                          double h1,
                          double h2,
                          RectangleEdge edge)
        Adjusts the supplied y-value.
        Parameters:
        y - the x-value.
        h1 - height 1.
        h2 - height 2.
        edge - the edge (top or bottom).
        Returns:
        The adjusted y-value.

      • equals

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

      • resolveDomainAxisLocation

        public static RectangleEdge resolveDomainAxisLocation​(AxisLocation location,
                                                      PlotOrientation orientation)
        Resolves a domain axis location for a given plot orientation.
        Parameters:
        location - the location (null not permitted).
        orientation - the orientation (null not permitted).
        Returns:
        The edge (never null).

      • resolveRangeAxisLocation

        public static RectangleEdge resolveRangeAxisLocation​(AxisLocation location,
                                                     PlotOrientation orientation)
        Resolves a range axis location for a given plot orientation.
        Parameters:
        location - the location (null not permitted).
        orientation - the orientation (null not permitted).
        Returns:
        The edge (never null).