Module org.jfree.chart

Package org.jfree.chart.axis

Enum AxisLocation

java.lang.Object

java.lang.Enum<AxisLocation>

org.jfree.chart.axis.AxisLocation

All Implemented Interfaces:

Serializable, Comparable<AxisLocation>

public enum AxisLocation
extends Enum<AxisLocation>

Used to indicate the location of an axis on a 2D plot, prior to knowing the orientation of the plot.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM_OR_LEFT	Axis at the bottom or left.
BOTTOM_OR_RIGHT	Axis at the bottom or right.
TOP_OR_LEFT	Axis at the top or left.
TOP_OR_RIGHT	Axis at the top or right.

Method Summary

Modifier and Type	Method	Description
AxisLocation	getOpposite()	Returns the location that is opposite to this location.
static AxisLocation	getOpposite(AxisLocation location)	Returns the location that is opposite to the supplied location.
static AxisLocation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AxisLocation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP_OR_LEFT

public static final AxisLocation TOP_OR_LEFT

Axis at the top or left.

TOP_OR_RIGHT

public static final AxisLocation TOP_OR_RIGHT

Axis at the top or right.

BOTTOM_OR_LEFT

public static final AxisLocation BOTTOM_OR_LEFT

Axis at the bottom or left.

BOTTOM_OR_RIGHT

public static final AxisLocation BOTTOM_OR_RIGHT

Axis at the bottom or right.

Method Detail

values

public static AxisLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AxisLocation c : AxisLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AxisLocation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOpposite

public AxisLocation getOpposite()

Returns the location that is opposite to this location.

Returns:

The opposite location.

getOpposite

public static AxisLocation getOpposite(AxisLocation location)

Returns the location that is opposite to the supplied location.

Parameters:

location - the location (null not permitted).

Returns:

The opposite location.