public class

CategoryLabelPosition

extends Object
implements Serializable
java.lang.Object
   ↳ org.jfree.chart.axis.CategoryLabelPosition

Class Overview

The attributes that control the position of the labels for the categories on a CategoryAxis. Instances of this class are immutable and other JFreeChart classes rely upon this.

Summary

Public Constructors
CategoryLabelPosition()
Creates a new position record with default settings.
CategoryLabelPosition(RectangleAnchor categoryAnchor, TextBlockAnchor labelAnchor)
Creates a new category label position record.
CategoryLabelPosition(RectangleAnchor categoryAnchor, TextBlockAnchor labelAnchor, CategoryLabelWidthType widthType, float widthRatio)
Creates a new category label position record.
CategoryLabelPosition(RectangleAnchor categoryAnchor, TextBlockAnchor labelAnchor, TextAnchor rotationAnchor, double angle, CategoryLabelWidthType widthType, float widthRatio)
Creates a new position record.
Public Methods
boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
double getAngle()
Returns the angle of rotation for the label.
RectangleAnchor getCategoryAnchor()
Returns the item label anchor.
TextBlockAnchor getLabelAnchor()
Returns the text block anchor.
TextAnchor getRotationAnchor()
Returns the rotation anchor point.
float getWidthRatio()
Returns the ratio used to calculate the maximum category label width.
CategoryLabelWidthType getWidthType()
Returns the width calculation type.
int hashCode()
Returns a hash code for this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CategoryLabelPosition ()

Creates a new position record with default settings.

public CategoryLabelPosition (RectangleAnchor categoryAnchor, TextBlockAnchor labelAnchor)

Creates a new category label position record.

Parameters
categoryAnchor the category anchor (null not permitted).
labelAnchor the label anchor (null not permitted).

public CategoryLabelPosition (RectangleAnchor categoryAnchor, TextBlockAnchor labelAnchor, CategoryLabelWidthType widthType, float widthRatio)

Creates a new category label position record.

Parameters
categoryAnchor the category anchor (null not permitted).
labelAnchor the label anchor (null not permitted).
widthType the width type (null not permitted).
widthRatio the maximum label width as a percentage (of the category space or the range space).

public CategoryLabelPosition (RectangleAnchor categoryAnchor, TextBlockAnchor labelAnchor, TextAnchor rotationAnchor, double angle, CategoryLabelWidthType widthType, float widthRatio)

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
categoryAnchor the category anchor (null not permitted).
labelAnchor the label anchor (null not permitted).
rotationAnchor the rotation anchor (null not permitted).
angle the rotation angle (null not permitted).
widthType the width type (null not permitted).
widthRatio the maximum label width as a percentage (of the category space or the range space).

Public Methods

public boolean equals (Object obj)

Tests this instance for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public double getAngle ()

Returns the angle of rotation for the label.

Returns
  • The angle (in radians).

public RectangleAnchor getCategoryAnchor ()

Returns the item label anchor.

Returns
  • The item label anchor (never null).

public TextBlockAnchor getLabelAnchor ()

Returns the text block anchor.

Returns
  • The text block anchor (never null).

public TextAnchor getRotationAnchor ()

Returns the rotation anchor point.

Returns
  • The rotation anchor point (never null).

public float getWidthRatio ()

Returns the ratio used to calculate the maximum category label width.

Returns
  • The ratio.

public CategoryLabelWidthType getWidthType ()

Returns the width calculation type.

Returns
  • The width calculation type (never null).

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.