Package org.jfree.chart.plot

Class PlotRenderingInfo

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class PlotRenderingInfo
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
    Stores information about the dimensions of a plot and its subplots.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.awt.geom.Rectangle2D dataArea
      The data area.
      private ChartRenderingInfo owner
      The owner of this info.
      private java.awt.geom.Rectangle2D plotArea
      The plot area.
      private static long serialVersionUID
      For serialization.
      private java.util.List subplotInfo
      Storage for the plot rendering info objects belonging to the subplots.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addSubplotInfo​(PlotRenderingInfo info)
      Adds the info for a subplot.
      java.lang.Object clone()
      Returns a clone of this object.
      boolean equals​(java.lang.Object obj)
      Tests this instance for equality against an arbitrary object.
      java.awt.geom.Rectangle2D getDataArea()
      Returns the plot's data area (in Java2D space).
      ChartRenderingInfo getOwner()
      Returns the owner (as specified in the constructor).
      java.awt.geom.Rectangle2D getPlotArea()
      Returns the plot area (in Java2D space).
      int getSubplotCount()
      Returns the number of subplots (possibly zero).
      int getSubplotIndex​(java.awt.geom.Point2D source)
      Returns the index of the subplot that contains the specified (x, y) point (the "source" point).
      PlotRenderingInfo getSubplotInfo​(int index)
      Returns the info for a subplot.
      int hashCode()  
      private void readObject​(java.io.ObjectInputStream stream)
      Provides serialization support.
      void setDataArea​(java.awt.geom.Rectangle2D area)
      Sets the data area.
      void setPlotArea​(java.awt.geom.Rectangle2D area)
      Sets the plot area.
      private void writeObject​(java.io.ObjectOutputStream stream)
      Provides serialization support.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • serialVersionUID

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

      • plotArea

        private transient java.awt.geom.Rectangle2D plotArea
        The plot area.

      • dataArea

        private transient java.awt.geom.Rectangle2D dataArea
        The data area.

      • subplotInfo

        private java.util.List subplotInfo
        Storage for the plot rendering info objects belonging to the subplots.

    • Constructor Detail

      • PlotRenderingInfo

        public PlotRenderingInfo​(ChartRenderingInfo owner)
        Creates a new instance.
        Parameters:
        owner - the owner (null permitted).

    • Method Detail

      • getOwner

        public ChartRenderingInfo getOwner()
        Returns the owner (as specified in the constructor).
        Returns:
        The owner (possibly null).

      • getPlotArea

        public java.awt.geom.Rectangle2D getPlotArea()
        Returns the plot area (in Java2D space).
        Returns:
        The plot area (possibly null).
        See Also:
        setPlotArea(Rectangle2D)

      • setPlotArea

        public void setPlotArea​(java.awt.geom.Rectangle2D area)
        Sets the plot area.
        Parameters:
        area - the plot area (in Java2D space, null permitted but discouraged)
        See Also:
        getPlotArea()

      • getDataArea

        public java.awt.geom.Rectangle2D getDataArea()
        Returns the plot's data area (in Java2D space).
        Returns:
        The data area (possibly null).
        See Also:
        setDataArea(Rectangle2D)

      • setDataArea

        public void setDataArea​(java.awt.geom.Rectangle2D area)
        Sets the data area.
        Parameters:
        area - the data area (in Java2D space, null permitted but discouraged).
        See Also:
        getDataArea()

      • getSubplotCount

        public int getSubplotCount()
        Returns the number of subplots (possibly zero).
        Returns:
        The subplot count.

      • getSubplotIndex

        public int getSubplotIndex​(java.awt.geom.Point2D source)
        Returns the index of the subplot that contains the specified (x, y) point (the "source" point). The source point will usually come from a mouse click on a ChartPanel, and this method is then used to determine the subplot that contains the source point.
        Parameters:
        source - the source point (in Java2D space, null not permitted).
        Returns:
        The subplot index (or -1 if no subplot contains source).

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Returns a clone of this object.
        Overrides:
        clone in class java.lang.Object
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if there is a problem cloning.

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

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