org.jfree.chart.annotations

Class XYDrawableAnnotation

public class XYDrawableAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable

A general annotation that can be placed on an XYPlot.
Constructor Summary
XYDrawableAnnotation(double x, double y, double width, double height, Drawable drawable)
Creates a new annotation to be displayed within the given area.
XYDrawableAnnotation(double x, double y, double displayWidth, double displayHeight, double drawScaleFactor, Drawable drawable)
Creates a new annotation to be displayed within the given area.
Method Summary
Objectclone()
Returns a clone of the annotation.
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

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

Since: 1.0.11

Method Detail

clone

public Object clone()
Returns a clone of the annotation.

Returns: A clone.

Throws: CloneNotSupportedException if the annotation can't be cloned.

draw

public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
Draws the annotation.

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(Object obj)
Tests this annotation for equality with an arbitrary object.

Parameters: obj the object to test against.

Returns: true or false.

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.

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