Class XYBoxAnnotation

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.awt.Paint fillPaint
      The paint used to fill the box.
      private java.awt.Paint outlinePaint
      The paint used to draw the box outline.
      private static long serialVersionUID
      For serialization.
      private java.awt.Stroke stroke
      The stroke used to draw the box outline.
      private double x0
      The lower x-coordinate.
      private double x1
      The upper x-coordinate.
      private double y0
      The lower y-coordinate.
      private double y1
      The upper y-coordinate.
    • Constructor Summary

      Constructors 
      Constructor Description
      XYBoxAnnotation​(double x0, double y0, double x1, double y1)
      Creates a new annotation (where, by default, the box is drawn with a black outline).
      XYBoxAnnotation​(double x0, double y0, double x1, double y1, java.awt.Stroke stroke, java.awt.Paint outlinePaint)
      Creates a new annotation where the box is drawn as an outline using the specified stroke and outlinePaint.
      XYBoxAnnotation​(double x0, double y0, double x1, double y1, java.awt.Stroke stroke, java.awt.Paint outlinePaint, java.awt.Paint fillPaint)
      Creates a new annotation.
    • Field Detail

      • serialVersionUID

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

        private double x0
        The lower x-coordinate.
      • y0

        private double y0
        The lower y-coordinate.
      • x1

        private double x1
        The upper x-coordinate.
      • y1

        private double y1
        The upper y-coordinate.
      • stroke

        private transient java.awt.Stroke stroke
        The stroke used to draw the box outline.
      • outlinePaint

        private transient java.awt.Paint outlinePaint
        The paint used to draw the box outline.
      • fillPaint

        private transient java.awt.Paint fillPaint
        The paint used to fill the box.
    • Constructor Detail

      • XYBoxAnnotation

        public XYBoxAnnotation​(double x0,
                               double y0,
                               double x1,
                               double y1)
        Creates a new annotation (where, by default, the box is drawn with a black outline).
        Parameters:
        x0 - the lower x-coordinate of the box (in data space).
        y0 - the lower y-coordinate of the box (in data space).
        x1 - the upper x-coordinate of the box (in data space).
        y1 - the upper y-coordinate of the box (in data space).
      • XYBoxAnnotation

        public XYBoxAnnotation​(double x0,
                               double y0,
                               double x1,
                               double y1,
                               java.awt.Stroke stroke,
                               java.awt.Paint outlinePaint)
        Creates a new annotation where the box is drawn as an outline using the specified stroke and outlinePaint.
        Parameters:
        x0 - the lower x-coordinate of the box (in data space).
        y0 - the lower y-coordinate of the box (in data space).
        x1 - the upper x-coordinate of the box (in data space).
        y1 - the upper y-coordinate of the box (in data space).
        stroke - the shape stroke (null permitted).
        outlinePaint - the shape color (null permitted).
      • XYBoxAnnotation

        public XYBoxAnnotation​(double x0,
                               double y0,
                               double x1,
                               double y1,
                               java.awt.Stroke stroke,
                               java.awt.Paint outlinePaint,
                               java.awt.Paint fillPaint)
        Creates a new annotation.
        Parameters:
        x0 - the lower x-coordinate of the box (in data space, must be finite).
        y0 - the lower y-coordinate of the box (in data space, must be finite).
        x1 - the upper x-coordinate of the box (in data space, must be finite).
        y1 - the upper y-coordinate of the box (in data space, must be finite).
        stroke - the shape stroke (null permitted).
        outlinePaint - the shape color (null permitted).
        fillPaint - the paint used to fill the shape (null permitted).
    • Method Detail

      • getX0

        public double getX0()
        Returns the x-coordinate for the bottom left corner of the box (set in the constructor).
        Returns:
        The x-coordinate for the bottom left corner of the box.
      • getY0

        public double getY0()
        Returns the y-coordinate for the bottom left corner of the box (set in the constructor).
        Returns:
        The y-coordinate for the bottom left corner of the box.
      • getX1

        public double getX1()
        Returns the x-coordinate for the top right corner of the box (set in the constructor).
        Returns:
        The x-coordinate for the top right corner of the box.
      • getY1

        public double getY1()
        Returns the y-coordinate for the top right corner of the box (set in the constructor).
        Returns:
        The y-coordinate for the top right corner of the box.
      • getStroke

        public java.awt.Stroke getStroke()
        Returns the stroke used for the box outline.
        Returns:
        The stroke (possibly null).
      • getOutlinePaint

        public java.awt.Paint getOutlinePaint()
        Returns the paint used for the box outline.
        Returns:
        The paint (possibly null).
      • getFillPaint

        public java.awt.Paint getFillPaint()
        Returns the paint used for the box fill.
        Returns:
        The paint (possibly null).
      • draw

        public void draw​(java.awt.Graphics2D g2,
                         XYPlot plot,
                         java.awt.geom.Rectangle2D dataArea,
                         ValueAxis domainAxis,
                         ValueAxis rangeAxis,
                         int rendererIndex,
                         PlotRenderingInfo info)
        Draws the annotation. This method is usually called by the XYPlot class, you shouldn't need to call it directly.
        Specified by:
        draw in interface XYAnnotation
        Specified by:
        draw in class AbstractXYAnnotation
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        dataArea - the data area.
        domainAxis - the domain axis.
        rangeAxis - the range axis.
        rendererIndex - the renderer index.
        info - the plot rendering info.
      • equals

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

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

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Returns a clone.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class AbstractAnnotation
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - not thrown by this class, but may be by subclasses.
      • writeObject

        private void writeObject​(java.io.ObjectOutputStream stream)
                          throws java.io.IOException
        Provides serialization support.
        Parameters:
        stream - the output stream (null not permitted).
        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 (null not permitted).
        Throws:
        java.io.IOException - if there is an I/O error.
        java.lang.ClassNotFoundException - if there is a classpath problem.