Package org.jfree.chart.annotations

Class XYDrawableAnnotation

java.lang.Object

org.jfree.chart.annotations.AbstractAnnotation

org.jfree.chart.annotations.AbstractXYAnnotation

org.jfree.chart.annotations.XYDrawableAnnotation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Annotation, XYAnnotation, PublicCloneable

public class XYDrawableAnnotation
extends AbstractXYAnnotation
implements java.lang.Cloneable, PublicCloneable, java.io.Serializable

A general annotation that can be placed on an XYPlot.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private double	displayHeight	The height.
private double	displayWidth	The width.
private Drawable	drawable	The drawable object.
private double	drawScaleFactor	The scaling factor.
private static long	serialVersionUID	For serialization.
private double	x	The x-coordinate.
private double	y	The y-coordinate.

Constructor Summary

Constructors

Constructor	Description
XYDrawableAnnotation(double x, double y, double displayWidth, double displayHeight, double drawScaleFactor, Drawable drawable)	Creates a new annotation to be displayed within the given area.
XYDrawableAnnotation(double x, double y, double width, double height, Drawable drawable)	Creates a new annotation to be displayed within the given area.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	Returns a clone of the annotation.
void	draw(java.awt.Graphics2D g2, XYPlot plot, java.awt.geom.Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)	Draws the annotation.
boolean	equals(java.lang.Object obj)	Tests this annotation for equality with an arbitrary object.
int	hashCode()	Returns a hash code.

Methods inherited from class org.jfree.chart.annotations.AbstractXYAnnotation

addEntity, getToolTipText, getURL, setToolTipText, setURL

Methods inherited from class org.jfree.chart.annotations.AbstractAnnotation

addChangeListener, fireAnnotationChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.chart.annotations.Annotation

addChangeListener, removeChangeListener

Field Detail

serialVersionUID

private static final long serialVersionUID

For serialization.

See Also:

Constant Field Values

drawScaleFactor

private double drawScaleFactor

The scaling factor.

x

private double x

The x-coordinate.

y

private double y

The y-coordinate.

displayWidth

private double displayWidth

The width.

displayHeight

private double displayHeight

The height.

drawable

private Drawable drawable

The drawable object.

Constructor Detail

XYDrawableAnnotation

public XYDrawableAnnotation(double x,
                            double y,
                            double width,
                            double height,
                            Drawable drawable)

Creates a new annotation to be displayed within the given area.

Parameters:

x - the x-coordinate for the area.

y - the y-coordinate for the area.

width - the width of the area.

height - the height of the area.

drawable - the drawable object (null not permitted).

XYDrawableAnnotation

public XYDrawableAnnotation(double x,
                            double y,
                            double displayWidth,
                            double displayHeight,
                            double drawScaleFactor,
                            Drawable drawable)

Creates a new annotation to be displayed within the given area. If you specify a drawScaleFactor of 2.0, the drawable will be drawn at twice the requested display size then scaled down to fit the space.

Parameters:

x - the x-coordinate for the area.

y - the y-coordinate for the area.

displayWidth - the width of the area.

displayHeight - the height of the area.

drawScaleFactor - the scaling factor for drawing.

drawable - the drawable object (null not permitted).

Method Detail

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.

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 - if supplied, this info object will be populated with entity information.

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 to test against.

Returns:

true or false.

hashCode

public int hashCode()

Returns a hash code.

Overrides:

hashCode in class AbstractXYAnnotation

Returns:

A hash code.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone of the annotation.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractAnnotation

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if the annotation can't be cloned.