org.jfree.chart.annotations

Class XYBoxAnnotation

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.
Constructor Summary
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.
Method Summary
Objectclone()
Returns a clone.
voiddraw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
Draws the annotation.
booleanequals(Object obj)
Tests this annotation for equality with an arbitrary object.
inthashCode()
Returns a hash code.

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

Method Detail

clone

public Object clone()
Returns a clone.

Returns: A clone.

Throws: CloneNotSupportedException not thrown by this class, but may be by subclasses.

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.

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.

Parameters: obj the object (null permitted).

Returns: A boolean.

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.