Module org.jfree.chart

Package org.jfree.chart.api

Enum RectangleEdge

java.lang.Object

java.lang.Enum<RectangleEdge>

org.jfree.chart.api.RectangleEdge

All Implemented Interfaces:

Serializable, Comparable<RectangleEdge>

public enum RectangleEdge
extends Enum<RectangleEdge>

Used to indicate the edge of a rectangle.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	Bottom.
LEFT	Left.
RIGHT	Right.
TOP	Top.

Method Summary

Modifier and Type	Method	Description
static double	coordinate(Rectangle2D rectangle, RectangleEdge edge)	Returns the x or y coordinate of the specified edge.
static boolean	isLeftOrRight(RectangleEdge edge)	Returns true if the edge is LEFT or RIGHT, and false otherwise.
static boolean	isTopOrBottom(RectangleEdge edge)	Returns true if the edge is TOP or BOTTOM, and false otherwise.
static RectangleEdge	opposite(RectangleEdge edge)	Returns the opposite edge.
static RectangleEdge	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RectangleEdge[]	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

public static final RectangleEdge TOP

Top.

BOTTOM

public static final RectangleEdge BOTTOM

Bottom.

LEFT

public static final RectangleEdge LEFT

Left.

RIGHT

public static final RectangleEdge RIGHT

Right.

Method Detail

values

public static RectangleEdge[] 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 (RectangleEdge c : RectangleEdge.values())
    System.out.println(c);

Returns:

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

valueOf

public static RectangleEdge 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

isTopOrBottom

public static boolean isTopOrBottom(RectangleEdge edge)

Returns true if the edge is TOP or BOTTOM, and false otherwise.

Parameters:

edge - the edge.

Returns:

A boolean.

isLeftOrRight

public static boolean isLeftOrRight(RectangleEdge edge)

Returns true if the edge is LEFT or RIGHT, and false otherwise.

Parameters:

edge - the edge.

Returns:

A boolean.

opposite

public static RectangleEdge opposite(RectangleEdge edge)

Returns the opposite edge.

Parameters:

edge - an edge.

Returns:

The opposite edge.

coordinate

public static double coordinate(Rectangle2D rectangle,
                                RectangleEdge edge)

Returns the x or y coordinate of the specified edge.

Parameters:

rectangle - the rectangle.

edge - the edge.

Returns:

The coordinate.