org.jfree.chart.annotations
public class XYPointerAnnotation extends XYTextAnnotation implements java.lang.Cloneable, java.io.Serializable
XYPlot
. The arrow is
drawn at a user-definable angle so that it points towards the (x, y)
location for the annotation.
The arrow length (and its offset from the (x, y) location) is controlled by the tip radius and the base radius attributes. Imagine two circles around the (x, y) coordinate: the inner circle defined by the tip radius, and the outer circle defined by the base radius. Now, draw the arrow starting at some point on the outer circle (the point is determined by the angle), with the arrow tip being drawn at a corresponding point on the inner circle.
Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_ARROW_LENGTH
The default arrow length (in Java2D units).
|
static double |
DEFAULT_ARROW_WIDTH
The default arrow width (in Java2D units).
|
static double |
DEFAULT_BASE_RADIUS
The default base radius (in Java2D units).
|
static double |
DEFAULT_LABEL_OFFSET
The default label offset (in Java2D units).
|
static double |
DEFAULT_TIP_RADIUS
The default tip radius (in Java2D units).
|
DEFAULT_FONT, DEFAULT_PAINT, DEFAULT_ROTATION_ANCHOR, DEFAULT_ROTATION_ANGLE, DEFAULT_TEXT_ANCHOR
Constructor and Description |
---|
XYPointerAnnotation(java.lang.String label,
double x,
double y,
double angle)
Creates a new label and arrow annotation.
|
Modifier and Type | Method and 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.
|
double |
getAngle()
Returns the angle of the arrow.
|
double |
getArrowLength()
Returns the arrow length.
|
java.awt.Paint |
getArrowPaint()
Returns the paint used for the arrow.
|
java.awt.Stroke |
getArrowStroke()
Returns the stroke used to draw the arrow line.
|
double |
getArrowWidth()
Returns the arrow width.
|
double |
getBaseRadius()
Returns the base radius.
|
double |
getLabelOffset()
Returns the label offset.
|
double |
getTipRadius()
Returns the tip radius.
|
int |
hashCode()
Returns a hash code for this instance.
|
void |
setAngle(double angle)
Sets the angle of the arrow.
|
void |
setArrowLength(double length)
Sets the arrow length.
|
void |
setArrowPaint(java.awt.Paint paint)
Sets the paint used for the arrow.
|
void |
setArrowStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the arrow line.
|
void |
setArrowWidth(double width)
Sets the arrow width.
|
void |
setBaseRadius(double radius)
Sets the base radius.
|
void |
setLabelOffset(double offset)
Sets the label offset (from the arrow base, continuing in a straight
line, in Java2D units).
|
void |
setTipRadius(double radius)
Sets the tip radius.
|
getBackgroundPaint, getFont, getOutlinePaint, getOutlineStroke, getPaint, getRotationAnchor, getRotationAngle, getText, getTextAnchor, getX, getY, isOutlineVisible, setBackgroundPaint, setFont, setOutlinePaint, setOutlineStroke, setOutlineVisible, setPaint, setRotationAnchor, setRotationAngle, setText, setTextAnchor, setX, setY
addEntity, getToolTipText, getURL, setToolTipText, setURL
public static final double DEFAULT_TIP_RADIUS
public static final double DEFAULT_BASE_RADIUS
public static final double DEFAULT_LABEL_OFFSET
public static final double DEFAULT_ARROW_LENGTH
public static final double DEFAULT_ARROW_WIDTH
public XYPointerAnnotation(java.lang.String label, double x, double y, double angle)
label
- the label (null
permitted).x
- the x-coordinate (measured against the chart's domain axis).y
- the y-coordinate (measured against the chart's range axis).angle
- the angle of the arrow's line (in radians).public double getAngle()
setAngle(double)
public void setAngle(double angle)
angle
- the angle (in radians).getAngle()
public double getTipRadius()
setTipRadius(double)
public void setTipRadius(double radius)
radius
- the radius (in Java2D units).getTipRadius()
public double getBaseRadius()
setBaseRadius(double)
public void setBaseRadius(double radius)
radius
- the radius (in Java2D units).getBaseRadius()
public double getLabelOffset()
setLabelOffset(double)
public void setLabelOffset(double offset)
offset
- the offset (in Java2D units).getLabelOffset()
public double getArrowLength()
setArrowLength(double)
public void setArrowLength(double length)
length
- the length.getArrowLength()
public double getArrowWidth()
setArrowWidth(double)
public void setArrowWidth(double width)
width
- the width (in Java2D units).getArrowWidth()
public java.awt.Stroke getArrowStroke()
null
).setArrowStroke(Stroke)
public void setArrowStroke(java.awt.Stroke stroke)
stroke
- the stroke (null
not permitted).getArrowStroke()
public java.awt.Paint getArrowPaint()
null
).setArrowPaint(Paint)
public void setArrowPaint(java.awt.Paint paint)
paint
- the arrow paint (null
not permitted).getArrowPaint()
public void draw(java.awt.Graphics2D g2, XYPlot plot, java.awt.geom.Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
draw
in interface XYAnnotation
draw
in class XYTextAnnotation
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(java.lang.Object obj)
equals
in class XYTextAnnotation
obj
- the object (null
permitted).true
or false
.public int hashCode()
hashCode
in class XYTextAnnotation
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class XYTextAnnotation
java.lang.CloneNotSupportedException
- if the annotation can't be cloned.Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.