Package org.jfree.chart.plot

Class Plot

java.lang.Object
org.jfree.chart.plot.Plot
All Implemented Interfaces:
Serializable, Cloneable, EventListener, AnnotationChangeListener, AxisChangeListener, MarkerChangeListener, LegendItemSource, PublicCloneable, DatasetChangeListener
Direct Known Subclasses:
CategoryPlot, CompassPlot, DialPlot, FastScatterPlot, FlowPlot, MeterPlot, MultiplePiePlot, PiePlot, PolarPlot, SpiderWebPlot, ThermometerPlot, WaferMapPlot, XYPlot
public abstract class Plot extends Object implements AxisChangeListener, DatasetChangeListener, AnnotationChangeListener, MarkerChangeListener, LegendItemSource, PublicCloneable, Cloneable, Serializable
The base class for all plots in JFreeChart. The JFreeChart class delegates the drawing of axes and data to the plot. This base class provides facilities common to most plot types.
See Also:

  • Field Details

  • Constructor Details

    • Plot

      protected Plot()
      Creates a new plot.

  • Method Details

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

    • getDatasetGroup

      public DatasetGroup getDatasetGroup()
      Returns the dataset group for the plot (not currently used).
      Returns:
      The dataset group.
      See Also:

    • setDatasetGroup

      protected void setDatasetGroup(DatasetGroup group)
      Sets the dataset group (not currently used).
      Parameters:
      group - the dataset group (null permitted).
      See Also:

    • getNoDataMessage

      public String getNoDataMessage()
      Returns the string that is displayed when the dataset is empty or null.
      Returns:
      The 'no data' message (null possible).
      See Also:

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

    • getNoDataMessageFont

      public Font getNoDataMessageFont()
      Returns the font used to display the 'no data' message.
      Returns:
      The font (never null).
      See Also:

    • setNoDataMessageFont

      public void setNoDataMessageFont(Font font)
      Sets the font used to display the 'no data' message and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      font - the font (null not permitted).
      See Also:

    • getNoDataMessagePaint

      public Paint getNoDataMessagePaint()
      Returns the paint used to display the 'no data' message.
      Returns:
      The paint (never null).
      See Also:

    • setNoDataMessagePaint

      public void setNoDataMessagePaint(Paint paint)
      Sets the paint used to display the 'no data' message and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

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

    • getParent

      public Plot getParent()
      Returns the parent plot (or null if this plot is not part of a combined plot).
      Returns:
      The parent plot.
      See Also:

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

    • getRootPlot

      public Plot getRootPlot()
      Returns the root plot.
      Returns:
      The root plot.
      See Also:

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

    • getInsets

      public RectangleInsets getInsets()
      Returns the insets for the plot area.
      Returns:
      The insets (never null).
      See Also:

    • setInsets

      public void setInsets(RectangleInsets insets)
      Sets the insets for the plot and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      insets - the new insets (null not permitted).
      See Also:

    • setInsets

      public void setInsets(RectangleInsets insets, boolean notify)
      Sets the insets for the plot and, if requested, and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      insets - the new insets (null not permitted).
      notify - a flag that controls whether the registered listeners are notified.
      See Also:

    • getBackgroundPaint

      public Paint getBackgroundPaint()
      Returns the background color of the plot area.
      Returns:
      The paint (possibly null).
      See Also:

    • setBackgroundPaint

      public void setBackgroundPaint(Paint paint)
      Sets the background color of the plot area and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null permitted).
      See Also:

    • getBackgroundAlpha

      public float getBackgroundAlpha()
      Returns the alpha transparency of the plot area background.
      Returns:
      The alpha transparency.
      See Also:

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

    • getDrawingSupplier

      public DrawingSupplier getDrawingSupplier()
      Returns the drawing supplier for the plot.
      Returns:
      The drawing supplier (possibly null).
      See Also:

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

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

    • getBackgroundImage

      public Image getBackgroundImage()
      Returns the background image that is used to fill the plot's background area.
      Returns:
      The image (possibly null).
      See Also:

    • setBackgroundImage

      public void setBackgroundImage(Image image)
      Sets the background image for the plot and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      image - the image (null permitted).
      See Also:

    • getBackgroundImageAlignment

      public int getBackgroundImageAlignment()
      Returns the background image alignment. Alignment constants are defined in the Align class.
      Returns:
      The alignment.
      See Also:

    • setBackgroundImageAlignment

      public void setBackgroundImageAlignment(int alignment)
      Sets the alignment for the background image and sends a PlotChangeEvent to all registered listeners. Alignment options are defined by the Align class.
      Parameters:
      alignment - the alignment.
      See Also:

    • 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

      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:

    • 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

      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:

    • getOutlineStroke

      public Stroke getOutlineStroke()
      Returns the stroke used to outline the plot area.
      Returns:
      The stroke (possibly null).
      See Also:

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

    • getOutlinePaint

      public Paint getOutlinePaint()
      Returns the color used to draw the outline of the plot area.
      Returns:
      The color (possibly null).
      See Also:

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

    • getForegroundAlpha

      public float getForegroundAlpha()
      Returns the alpha-transparency for the plot foreground.
      Returns:
      The alpha-transparency.
      See Also:

    • setForegroundAlpha

      public void setForegroundAlpha(float alpha)
      Sets the alpha-transparency for the plot and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      alpha - the new alpha transparency.
      See Also:

    • getLegendItems

      public 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 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

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

    • addChangeListener

      public void addChangeListener(PlotChangeListener listener)
      Registers an object for notification of changes to the plot.
      Parameters:
      listener - the object to be registered.
      See Also:

    • removeChangeListener

      public void removeChangeListener(PlotChangeListener listener)
      Unregisters an object for notification of changes to the plot.
      Parameters:
      listener - the object to be unregistered.
      See Also:

    • notifyListeners

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

    • fireChangeEvent

      protected void fireChangeEvent()
      Sends a PlotChangeEvent to all registered listeners.

    • 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)
      Fills the specified area with the background paint.
      Parameters:
      g2 - the graphics device.
      area - the area.
      See Also:

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

    • drawBackgroundImage

      public void drawBackgroundImage(Graphics2D g2, Rectangle2D area)
      Draws the background image (if there is one) aligned within the specified area.
      Parameters:
      g2 - the graphics device.
      area - the area.
      See Also:

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

    • annotationChanged

      public void annotationChanged(AnnotationChangeEvent event)
      Receives notification of a change to an Annotation added to this plot.
      Specified by:
      annotationChanged in interface AnnotationChangeListener
      Parameters:
      event - information about the event (not used here).

    • axisChanged

      public void axisChanged(AxisChangeEvent event)
      Receives notification of a change to one of the plot's axes.
      Specified by:
      axisChanged in interface AxisChangeListener
      Parameters:
      event - information about the event (not used here).

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

    • markerChanged

      public void markerChanged(MarkerChangeEvent event)
      Receives notification of a change to a marker that is assigned to the plot.
      Specified by:
      markerChanged in interface MarkerChangeListener
      Parameters:
      event - the event.

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

    • canEqual

      public boolean canEqual(Object other)
      Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.
      Parameters:
      other - Object
      Returns:
      true ONLY if the parameter is THIS class type

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Object clone() throws CloneNotSupportedException
      Creates a clone of the plot.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if some component of the plot does not support cloning.

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