org.jfree.chart.annotations

Class CategoryPointerAnnotation

java.lang.Object
- org.jfree.chart.annotations.TextAnnotation
- - org.jfree.chart.annotations.CategoryTextAnnotation
  - - org.jfree.chart.annotations.CategoryPointerAnnotation

Implemented Interfaces:: Cloneable, PublicCloneable, Serializable, CategoryAnnotation

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.

Since:: 1.0.3

Field Summary
`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
`CategoryPointerAnnotation(String label, Comparable key, double value, double angle)` Creates a new label and arrow annotation.

Method Summary
`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.
`void`	`setArrowLength(double length)` Sets the arrow length.
`void`	`setArrowPaint(Paint paint)` Sets the paint used for the arrow.
`void`	`setArrowStroke(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.

Methods inherited from class org.jfree.chart.annotations.CategoryTextAnnotation
`clone`, `draw`, `equals`, `getCategory`, `getCategoryAnchor`, `getValue`, `hashCode`, `setCategory`, `setCategoryAnchor`, `setValue`

Methods inherited from class org.jfree.chart.annotations.TextAnnotation
`equals`, `getFont`, `getPaint`, `getRotationAnchor`, `getRotationAngle`, `getText`, `getTextAnchor`, `hashCode`, `setFont`, `setPaint`, `setRotationAnchor`, `setRotationAngle`, `setText`, `setTextAnchor`

DEFAULT_ARROW_LENGTH

public static final double DEFAULT_ARROW_LENGTH

The default arrow length (in Java2D units).
Field Value:
5.0

DEFAULT_ARROW_WIDTH

public static final double DEFAULT_ARROW_WIDTH

The default arrow width (in Java2D units).
Field Value:
3.0

DEFAULT_BASE_RADIUS

public static final double DEFAULT_BASE_RADIUS

The default base radius (in Java2D units).
Field Value:
30.0

DEFAULT_LABEL_OFFSET

public static final double DEFAULT_LABEL_OFFSET

The default label offset (in Java2D units).
Field Value:
3.0

DEFAULT_TIP_RADIUS

public static final double DEFAULT_TIP_RADIUS

The default tip radius (in Java2D units).
Field Value:
10.0

CategoryPointerAnnotation

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

clone

public Object clone()
            throws CloneNotSupportedException

Returns a clone of the annotation.
Overrides:
clone in interface CategoryTextAnnotation
Returns:
A clone.

draw

public void draw(Graphics2D g2,
                 CategoryPlot plot,
                 Rectangle2D dataArea,
                 CategoryAxis domainAxis,
                 ValueAxis rangeAxis)

Draws the annotation.
Specified by:
draw in interface CategoryAnnotation
Overrides:
draw in interface CategoryTextAnnotation
Parameters:
g2 - the graphics device.
plot - the plot.
dataArea - the data area.
domainAxis - the domain axis.
rangeAxis - the range axis.

equals

public boolean equals(Object obj)

Tests this annotation for equality with an arbitrary object.
Overrides:
equals in interface CategoryTextAnnotation
Parameters:
obj - the object (null permitted).
Returns:
true or false.

getAngle

public double getAngle()

Returns the angle of the arrow.
Returns:
The angle (in radians).
See Also:
setAngle(double)

getArrowLength

public double getArrowLength()

Returns the arrow length.
Returns:
The arrow length.
See Also:
setArrowLength(double)

getArrowPaint

public Paint getArrowPaint()

Returns the paint used for the arrow.
Returns:
The arrow paint (never null).
See Also:
setArrowPaint(Paint)

getArrowStroke

public Stroke getArrowStroke()

Returns the stroke used to draw the arrow line.
Returns:
The arrow stroke (never null).
See Also:
setArrowStroke(Stroke)

getArrowWidth

public double getArrowWidth()

Returns the arrow width.
Returns:
The arrow width (in Java2D units).
See Also:
setArrowWidth(double)

getBaseRadius

public double getBaseRadius()

Returns the base radius.
Returns:
The base radius (in Java2D units).
See Also:
setBaseRadius(double)

getLabelOffset

public double getLabelOffset()

Returns the label offset.
Returns:
The label offset (in Java2D units).
See Also:
setLabelOffset(double)

getTipRadius

public double getTipRadius()

Returns the tip radius.
Returns:
The tip radius (in Java2D units).
See Also:
setTipRadius(double)

hashCode

public int hashCode()

Returns a hash code for this instance.
Overrides:
hashCode in interface CategoryTextAnnotation
Returns:
A hash code.

setAngle

public void setAngle(double angle)

Sets the angle of the arrow.
Parameters:
angle - the angle (in radians).
See Also:
getAngle()

setArrowLength

public void setArrowLength(double length)

Sets the arrow length.
Parameters:
length - the length.
See Also:
getArrowLength()

setArrowPaint

public void setArrowPaint(Paint paint)

Sets the paint used for the arrow.
Parameters:
paint - the arrow paint (null not permitted).
See Also:
getArrowPaint()

setArrowStroke

public void setArrowStroke(Stroke stroke)

Sets the stroke used to draw the arrow line.
Parameters:
stroke - the stroke (null not permitted).
See Also:
getArrowStroke()

setArrowWidth

public void setArrowWidth(double width)

Sets the arrow width.
Parameters:
width - the width (in Java2D units).
See Also:
getArrowWidth()

setBaseRadius

public void setBaseRadius(double radius)

Sets the base radius.
Parameters:
radius - the radius (in Java2D units).
See Also:
getBaseRadius()

setLabelOffset

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).
See Also:
getLabelOffset()

setTipRadius

public void setTipRadius(double radius)

Sets the tip radius.
Parameters:
radius - the radius (in Java2D units).
See Also:
getTipRadius()

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr