Package org.jfree.chart.annotations

Class XYBoxAnnotation

java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYBoxAnnotation
All Implemented Interfaces:
Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable
public class XYBoxAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable
A box annotation that can be placed on an XYPlot. The box coordinates are specified in data space.
See Also:

  • Constructor Details

    • 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, Stroke stroke, 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, Stroke stroke, Paint outlinePaint, 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 Details

    • 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 Stroke getStroke()
      Returns the stroke used for the box outline.
      Returns:
      The stroke (possibly null).

    • getOutlinePaint

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

    • getFillPaint

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

    • draw

      public void draw(Graphics2D g2, XYPlot plot, 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(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(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

    • hashCode

      public int hashCode()
      Returns a hash code.
      Overrides:
      hashCode in class AbstractXYAnnotation
      Returns:
      A hash code.

    • clone

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