CategoryPointerAnnotation
extends CategoryTextAnnotationimplements Serializable Cloneable
| java.lang.Object | |||
| ↳ | org.jfree.chart.annotations.TextAnnotation | ||
| ↳ | org.jfree.chart.annotations.CategoryTextAnnotation | ||
| ↳ | org.jfree.chart.annotations.CategoryPointerAnnotation | ||
Class Overview
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.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| double | DEFAULT_ARROW_LENGTH | The default arrow length (in Java2D units). | |||||||||
| double | DEFAULT_ARROW_WIDTH | The default arrow width (in Java2D units). | |||||||||
| double | DEFAULT_BASE_RADIUS | The default base radius (in Java2D units). | |||||||||
| double | DEFAULT_LABEL_OFFSET | The default label offset (in Java2D units). | |||||||||
| double | DEFAULT_TIP_RADIUS | The default tip radius (in Java2D units). | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
org.jfree.chart.annotations.TextAnnotation
| |||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
org.jfree.chart.annotations.TextAnnotation
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new label and arrow annotation.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns a clone of the annotation.
| |||||||||||
Draws the annotation.
| |||||||||||
Tests this annotation for equality with an arbitrary object.
| |||||||||||
Returns the angle of the arrow.
| |||||||||||
Returns the arrow length.
| |||||||||||
Returns the paint used for the arrow.
| |||||||||||
Returns the stroke used to draw the arrow line.
| |||||||||||
Returns the arrow width.
| |||||||||||
Returns the base radius.
| |||||||||||
Returns the label offset.
| |||||||||||
Returns the tip radius.
| |||||||||||
Returns a hash code for this instance.
| |||||||||||
Sets the angle of the arrow.
| |||||||||||
Sets the arrow length.
| |||||||||||
Sets the paint used for the arrow.
| |||||||||||
Sets the stroke used to draw the arrow line.
| |||||||||||
Sets the arrow width.
| |||||||||||
Sets the base radius.
| |||||||||||
Sets the label offset (from the arrow base, continuing in a straight
line, in Java2D units).
| |||||||||||
Sets the tip radius.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
org.jfree.chart.annotations.CategoryTextAnnotation
| |||||||||||
|
From class
org.jfree.chart.annotations.TextAnnotation
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
org.jfree.chart.annotations.CategoryAnnotation
| |||||||||||
Constants
public static final double DEFAULT_ARROW_LENGTH
The default arrow length (in Java2D units).
public static final double DEFAULT_ARROW_WIDTH
The default arrow width (in Java2D units).
public static final double DEFAULT_BASE_RADIUS
The default base radius (in Java2D units).
public static final double DEFAULT_LABEL_OFFSET
The default label offset (in Java2D units).
public static final double DEFAULT_TIP_RADIUS
The default tip radius (in Java2D units).
Public Constructors
public CategoryPointerAnnotation (String label, Comparable key, double value, double angle)
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). |
Public Methods
public Object clone ()
Returns a clone of the annotation.
Returns
- A clone.
Throws
| CloneNotSupportedException | if the annotation can't be cloned. |
|---|
public void draw (Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)
Draws the annotation.
Parameters
| g2 | the graphics device. |
|---|---|
| plot | the plot. |
| dataArea | the data area. |
| domainAxis | the domain axis. |
| rangeAxis | the range axis. |
public boolean equals (Object obj)
Tests this annotation for equality with an arbitrary object.
Parameters
| obj | the object (null permitted). |
|---|
Returns
trueorfalse.
public double getAngle ()
public double getArrowLength ()
public Paint getArrowPaint ()
Returns the paint used for the arrow.
Returns
- The arrow paint (never
null).
See Also
public Stroke getArrowStroke ()
Returns the stroke used to draw the arrow line.
Returns
- The arrow stroke (never
null).
See Also
public double getArrowWidth ()
public double getBaseRadius ()
public double getLabelOffset ()
Returns the label offset.
Returns
- The label offset (in Java2D units).
See Also
public double getTipRadius ()
public int hashCode ()
Returns a hash code for this instance.
Returns
- A hash code.
public void setAngle (double angle)
public void setArrowLength (double length)
public void setArrowPaint (Paint paint)
Sets the paint used for the arrow.
Parameters
| paint | the arrow paint (null not permitted). |
|---|
See Also
public void setArrowStroke (Stroke stroke)
Sets the stroke used to draw the arrow line.
Parameters
| stroke | the stroke (null not permitted). |
|---|
See Also
public void setArrowWidth (double width)
public void setBaseRadius (double radius)
public void setLabelOffset (double offset)
Sets the label offset (from the arrow base, continuing in a straight line, in Java2D units).
Parameters
| offset | the offset (in Java2D units). |
|---|