public class

CategoryLabelPositions

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

Class Overview

Records the label positions for a category axis. Instances of this class are immutable.

Summary

Fields
public static final CategoryLabelPositions DOWN_45 DOWN_45 category label positions.
public static final CategoryLabelPositions DOWN_90 DOWN_90 category label positions.
public static final CategoryLabelPositions STANDARD STANDARD category label positions.
public static final CategoryLabelPositions UP_45 UP_45 category label positions.
public static final CategoryLabelPositions UP_90 UP_90 category label positions.
Public Constructors
CategoryLabelPositions()
Default constructor.
CategoryLabelPositions(CategoryLabelPosition top, CategoryLabelPosition bottom, CategoryLabelPosition left, CategoryLabelPosition right)
Creates a new position specification.
Public Methods
static CategoryLabelPositions createDownRotationLabelPositions(double angle)
Creates a new instance where the category labels angled downwards by the specified amount.
static CategoryLabelPositions createUpRotationLabelPositions(double angle)
Creates a new instance where the category labels angled upwards by the specified amount.
boolean equals(Object obj)
Returns true if this object is equal to the specified object, and false otherwise.
CategoryLabelPosition getLabelPosition(RectangleEdge edge)
Returns the category label position specification for an axis at the given location.
int hashCode()
Returns a hash code for this object.
static CategoryLabelPositions replaceBottomPosition(CategoryLabelPositions base, CategoryLabelPosition bottom)
Returns a new instance based on an existing instance but with the bottom position changed.
static CategoryLabelPositions replaceLeftPosition(CategoryLabelPositions base, CategoryLabelPosition left)
Returns a new instance based on an existing instance but with the left position changed.
static CategoryLabelPositions replaceRightPosition(CategoryLabelPositions base, CategoryLabelPosition right)
Returns a new instance based on an existing instance but with the right position changed.
static CategoryLabelPositions replaceTopPosition(CategoryLabelPositions base, CategoryLabelPosition top)
Returns a new instance based on an existing instance but with the top position changed.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final CategoryLabelPositions DOWN_45

DOWN_45 category label positions.

public static final CategoryLabelPositions DOWN_90

DOWN_90 category label positions.

public static final CategoryLabelPositions STANDARD

STANDARD category label positions.

public static final CategoryLabelPositions UP_45

UP_45 category label positions.

public static final CategoryLabelPositions UP_90

UP_90 category label positions.

Public Constructors

public CategoryLabelPositions ()

Default constructor.

public CategoryLabelPositions (CategoryLabelPosition top, CategoryLabelPosition bottom, CategoryLabelPosition left, CategoryLabelPosition right)

Creates a new position specification.

Parameters
top the label position info used when an axis is at the top (null not permitted).
bottom the label position info used when an axis is at the bottom (null not permitted).
left the label position info used when an axis is at the left (null not permitted).
right the label position info used when an axis is at the right (null not permitted).

Public Methods

public static CategoryLabelPositions createDownRotationLabelPositions (double angle)

Creates a new instance where the category labels angled downwards by the specified amount.

Parameters
angle the rotation angle (should be < Math.PI / 2.0).
Returns
  • A category label position specification.

public static CategoryLabelPositions createUpRotationLabelPositions (double angle)

Creates a new instance where the category labels angled upwards by the specified amount.

Parameters
angle the rotation angle (should be < Math.PI / 2.0).
Returns
  • A category label position specification.

public boolean equals (Object obj)

Returns true if this object is equal to the specified object, and false otherwise.

Parameters
obj the other object.
Returns
  • A boolean.

public CategoryLabelPosition getLabelPosition (RectangleEdge edge)

Returns the category label position specification for an axis at the given location.

Parameters
edge the axis location.
Returns
  • The category label position specification.

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.

public static CategoryLabelPositions replaceBottomPosition (CategoryLabelPositions base, CategoryLabelPosition bottom)

Returns a new instance based on an existing instance but with the bottom position changed.

Parameters
base the base (null not permitted).
bottom the bottom position (null not permitted).
Returns
  • A new instance (never null).

public static CategoryLabelPositions replaceLeftPosition (CategoryLabelPositions base, CategoryLabelPosition left)

Returns a new instance based on an existing instance but with the left position changed.

Parameters
base the base (null not permitted).
left the left position (null not permitted).
Returns
  • A new instance (never null).

public static CategoryLabelPositions replaceRightPosition (CategoryLabelPositions base, CategoryLabelPosition right)

Returns a new instance based on an existing instance but with the right position changed.

Parameters
base the base (null not permitted).
right the right position (null not permitted).
Returns
  • A new instance (never null).

public static CategoryLabelPositions replaceTopPosition (CategoryLabelPositions base, CategoryLabelPosition top)

Returns a new instance based on an existing instance but with the top position changed.

Parameters
base the base (null not permitted).
top the top position (null not permitted).
Returns
  • A new instance (never null).