org.jfree.chart.axis

Class CategoryLabelPositions

public class CategoryLabelPositions extends Object implements Serializable

Records the label positions for a category axis. Instances of this class are immutable.
Field Summary
static CategoryLabelPositionsDOWN_45
DOWN_45 category label positions.
static CategoryLabelPositionsDOWN_90
DOWN_90 category label positions.
static CategoryLabelPositionsSTANDARD
STANDARD category label positions.
static CategoryLabelPositionsUP_45
UP_45 category label positions.
static CategoryLabelPositionsUP_90
UP_90 category label positions.
Constructor Summary
CategoryLabelPositions()
Default constructor.
CategoryLabelPositions(CategoryLabelPosition top, CategoryLabelPosition bottom, CategoryLabelPosition left, CategoryLabelPosition right)
Creates a new position specification.
Method Summary
static CategoryLabelPositionscreateDownRotationLabelPositions(double angle)
Creates a new instance where the category labels angled downwards by the specified amount.
static CategoryLabelPositionscreateUpRotationLabelPositions(double angle)
Creates a new instance where the category labels angled upwards by the specified amount.
booleanequals(Object obj)
Returns true if this object is equal to the specified object, and false otherwise.
CategoryLabelPositiongetLabelPosition(RectangleEdge edge)
Returns the category label position specification for an axis at the given location.
inthashCode()
Returns a hash code for this object.
static CategoryLabelPositionsreplaceBottomPosition(CategoryLabelPositions base, CategoryLabelPosition bottom)
Returns a new instance based on an existing instance but with the bottom position changed.
static CategoryLabelPositionsreplaceLeftPosition(CategoryLabelPositions base, CategoryLabelPosition left)
Returns a new instance based on an existing instance but with the left position changed.
static CategoryLabelPositionsreplaceRightPosition(CategoryLabelPositions base, CategoryLabelPosition right)
Returns a new instance based on an existing instance but with the right position changed.
static CategoryLabelPositionsreplaceTopPosition(CategoryLabelPositions base, CategoryLabelPosition top)
Returns a new instance based on an existing instance but with the top position changed.

Field Detail

DOWN_45

public static final CategoryLabelPositions DOWN_45
DOWN_45 category label positions.

DOWN_90

public static final CategoryLabelPositions DOWN_90
DOWN_90 category label positions.

STANDARD

public static final CategoryLabelPositions STANDARD
STANDARD category label positions.

UP_45

public static final CategoryLabelPositions UP_45
UP_45 category label positions.

UP_90

public static final CategoryLabelPositions UP_90
UP_90 category label positions.

Constructor Detail

CategoryLabelPositions

public CategoryLabelPositions()
Default constructor.

CategoryLabelPositions

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

Method Detail

createDownRotationLabelPositions

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.

createUpRotationLabelPositions

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.

equals

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.

getLabelPosition

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.

hashCode

public int hashCode()
Returns a hash code for this object.

Returns: A hash code.

replaceBottomPosition

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

replaceLeftPosition

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

replaceRightPosition

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

replaceTopPosition

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

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.