Package org.jfree.chart.annotations
Class CategoryPointerAnnotation
java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.TextAnnotation
org.jfree.chart.annotations.CategoryTextAnnotation
org.jfree.chart.annotations.CategoryPointerAnnotation
- All Implemented Interfaces:
Serializable
,Cloneable
,Annotation
,CategoryAnnotation
,PublicCloneable
public class CategoryPointerAnnotation extends CategoryTextAnnotation implements Cloneable, PublicCloneable, Serializable
An arrow and label that can be placed on a
CategoryPlot
. The arrow
is drawn at a user-definable angle so that it points towards the (category,
value) location for the annotation.
The arrow length (and its offset from the (category, value) location) is controlled by the tip radius and the base radius attributes. Imagine two circles around the (category, value) 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.
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field 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).Fields inherited from class org.jfree.chart.annotations.TextAnnotation
DEFAULT_FONT, DEFAULT_PAINT, DEFAULT_ROTATION_ANCHOR, DEFAULT_ROTATION_ANGLE, DEFAULT_TEXT_ANCHOR
-
Constructor Summary
Constructors Constructor Description CategoryPointerAnnotation(String label, Comparable key, double value, double angle)
Creates a new label and arrow annotation. -
Method Summary
Modifier and Type Method Description Object
clone()
Returns a clone of the annotation.void
draw(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)
Draws the annotation.boolean
equals(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.Paint
getArrowPaint()
Returns the paint used for the arrow.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 and sends anAnnotationChangeEvent
to all registered listeners.void
setArrowLength(double length)
Sets the arrow length and sends anAnnotationChangeEvent
to all registered listeners.void
setArrowPaint(Paint paint)
Sets the paint used for the arrow and sends anAnnotationChangeEvent
to all registered listeners.void
setArrowStroke(Stroke stroke)
Sets the stroke used to draw the arrow line and sends anAnnotationChangeEvent
to all registered listeners.void
setArrowWidth(double width)
Sets the arrow width and sends anAnnotationChangeEvent
to all registered listeners.void
setBaseRadius(double radius)
Sets the base radius and sends anAnnotationChangeEvent
to all registered listeners.void
setLabelOffset(double offset)
Sets the label offset (from the arrow base, continuing in a straight line, in Java2D units) and sends anAnnotationChangeEvent
to all registered listeners.void
setTipRadius(double radius)
Sets the tip radius and sends anAnnotationChangeEvent
to all registered listeners.Methods inherited from class org.jfree.chart.annotations.CategoryTextAnnotation
getCategory, getCategoryAnchor, getValue, setCategory, setCategoryAnchor, setValue
Methods inherited from class org.jfree.chart.annotations.TextAnnotation
getFont, getPaint, getRotationAnchor, getRotationAngle, getText, getTextAnchor, setFont, setPaint, setRotationAnchor, setRotationAngle, setText, setTextAnchor
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 Details
-
DEFAULT_TIP_RADIUS
The default tip radius (in Java2D units).- See Also:
- Constant Field Values
-
DEFAULT_BASE_RADIUS
The default base radius (in Java2D units).- See Also:
- Constant Field Values
-
DEFAULT_LABEL_OFFSET
The default label offset (in Java2D units).- See Also:
- Constant Field Values
-
DEFAULT_ARROW_LENGTH
The default arrow length (in Java2D units).- See Also:
- Constant Field Values
-
DEFAULT_ARROW_WIDTH
The default arrow width (in Java2D units).- See Also:
- Constant Field Values
-
-
Constructor Details
-
CategoryPointerAnnotation
Creates a new label and arrow annotation.- Parameters:
label
- the label (null
permitted).key
- the category key.value
- the y-value (measured against the chart's range axis).angle
- the angle of the arrow's line (in radians).
-
-
Method Details
-
getAngle
Returns the angle of the arrow.- Returns:
- The angle (in radians).
- See Also:
setAngle(double)
-
setAngle
Sets the angle of the arrow and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
angle
- the angle (in radians).- See Also:
getAngle()
-
getTipRadius
Returns the tip radius.- Returns:
- The tip radius (in Java2D units).
- See Also:
setTipRadius(double)
-
setTipRadius
Sets the tip radius and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
radius
- the radius (in Java2D units).- See Also:
getTipRadius()
-
getBaseRadius
Returns the base radius.- Returns:
- The base radius (in Java2D units).
- See Also:
setBaseRadius(double)
-
setBaseRadius
Sets the base radius and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
radius
- the radius (in Java2D units).- See Also:
getBaseRadius()
-
getLabelOffset
Returns the label offset.- Returns:
- The label offset (in Java2D units).
- See Also:
setLabelOffset(double)
-
setLabelOffset
Sets the label offset (from the arrow base, continuing in a straight line, in Java2D units) and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
offset
- the offset (in Java2D units).- See Also:
getLabelOffset()
-
getArrowLength
Returns the arrow length.- Returns:
- The arrow length.
- See Also:
setArrowLength(double)
-
setArrowLength
Sets the arrow length and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
length
- the length.- See Also:
getArrowLength()
-
getArrowWidth
Returns the arrow width.- Returns:
- The arrow width (in Java2D units).
- See Also:
setArrowWidth(double)
-
setArrowWidth
Sets the arrow width and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
width
- the width (in Java2D units).- See Also:
getArrowWidth()
-
getArrowStroke
Returns the stroke used to draw the arrow line.- Returns:
- The arrow stroke (never
null
). - See Also:
setArrowStroke(Stroke)
-
setArrowStroke
Sets the stroke used to draw the arrow line and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getArrowStroke()
-
getArrowPaint
Returns the paint used for the arrow.- Returns:
- The arrow paint (never
null
). - See Also:
setArrowPaint(Paint)
-
setArrowPaint
Sets the paint used for the arrow and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
paint
- the arrow paint (null
not permitted).- See Also:
getArrowPaint()
-
draw
public void draw(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)Draws the annotation.- Specified by:
draw
in interfaceCategoryAnnotation
- Overrides:
draw
in classCategoryTextAnnotation
- Parameters:
g2
- the graphics device.plot
- the plot.dataArea
- the data area.domainAxis
- the domain axis.rangeAxis
- the range axis.
-
equals
Tests this annotation for equality with an arbitrary object.- Overrides:
equals
in classCategoryTextAnnotation
- Parameters:
obj
- the object (null
permitted).- Returns:
true
orfalse
.
-
hashCode
Returns a hash code for this instance.- Overrides:
hashCode
in classCategoryTextAnnotation
- Returns:
- A hash code.
-
clone
Returns a clone of the annotation.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classCategoryTextAnnotation
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- if the annotation can't be cloned.
-