org.jfree.chart.labels

Class ItemLabelPosition

Implemented Interfaces:
Serializable

public class ItemLabelPosition
extends java.lang.Object
implements Serializable

The attributes that control the position of the label for each data item on a chart. Instances of this class are immutable.

Constructor Summary

ItemLabelPosition()
Creates a new position record with default settings.
ItemLabelPosition(ItemLabelAnchor itemLabelAnchor, TextAnchor textAnchor)
Creates a new position record (with zero rotation).
ItemLabelPosition(ItemLabelAnchor itemLabelAnchor, TextAnchor textAnchor, TextAnchor rotationAnchor, double angle)
Creates a new position record.

Method Summary

boolean
equals(Object obj)
Tests this object for equality with an arbitrary object.
double
getAngle()
Returns the angle of rotation for the label.
ItemLabelAnchor
getItemLabelAnchor()
Returns the item label anchor.
TextAnchor
getRotationAnchor()
Returns the rotation anchor point.
TextAnchor
getTextAnchor()
Returns the text anchor.

Constructor Details

ItemLabelPosition

public ItemLabelPosition()
Creates a new position record with default settings.

ItemLabelPosition

public ItemLabelPosition(ItemLabelAnchor itemLabelAnchor,
                         TextAnchor textAnchor)
Creates a new position record (with zero rotation).
Parameters:
itemLabelAnchor - the item label anchor (null not permitted).
textAnchor - the text anchor (null not permitted).

ItemLabelPosition

public ItemLabelPosition(ItemLabelAnchor itemLabelAnchor,
                         TextAnchor textAnchor,
                         TextAnchor rotationAnchor,
                         double angle)
Creates a new position record. The item label anchor is a point relative to the data item (dot, bar or other visual item) on a chart. The item label is aligned by aligning the text anchor with the item label anchor.
Parameters:
itemLabelAnchor - the item label anchor (null not permitted).
textAnchor - the text anchor (null not permitted).
rotationAnchor - the rotation anchor (null not permitted).
angle - the rotation angle (in radians).

Method Details

equals

public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getAngle

public double getAngle()
Returns the angle of rotation for the label.
Returns:
The angle (in radians).

getItemLabelAnchor

public ItemLabelAnchor getItemLabelAnchor()
Returns the item label anchor.
Returns:
The item label anchor (never null).

getRotationAnchor

public TextAnchor getRotationAnchor()
Returns the rotation anchor point.
Returns:
The rotation anchor point (never null).

getTextAnchor

public TextAnchor getTextAnchor()
Returns the text anchor.
Returns:
The text anchor (never null).