public class

XYBoxAnnotation

extends AbstractXYAnnotation
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.annotations.AbstractXYAnnotation
     ↳ org.jfree.chart.annotations.XYBoxAnnotation

Class Overview

A box annotation that can be placed on an XYPlot. The box coordinates are specified in data space.

Summary

Public Constructors
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, Stroke stroke, 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, Stroke stroke, Paint outlinePaint, Paint fillPaint)
Creates a new annotation.
Public Methods
Object clone()
Returns a clone.
void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
Draws the annotation.
boolean equals(Object obj)
Tests this annotation for equality with an arbitrary object.
int hashCode()
Returns a hash code.
[Expand]
Inherited Methods
From class org.jfree.chart.annotations.AbstractXYAnnotation
From class java.lang.Object
From interface org.jfree.chart.annotations.XYAnnotation

Public Constructors

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

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

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).
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).
fillPaint the paint used to fill the shape (null permitted).

Public Methods

public Object clone ()

Returns a clone.

Returns
  • A clone.
Throws
CloneNotSupportedException not thrown by this class, but may be by subclasses.

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.

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.

public boolean equals (Object obj)

Tests this annotation for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.