org.jhotdraw.draw

Enum TranslationDirection

java.lang.Object

java.lang.Enum<TranslationDirection>

org.jhotdraw.draw.TranslationDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TranslationDirection>

public enum TranslationDirection
extends java.lang.Enum<TranslationDirection>

Specifies the possible directions for translations on a two-dimensional plane.

This enumeration is used by drawing tools and handles to perform constrained transforms of figures on a drawing.

See Also:

Constrainer

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
NORTH
NORTH_EAST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_WEST
WEST

Method Summary

Modifier and Type	Method and Description
static TranslationDirection	getDirection(java.awt.geom.Point2D.Double startPoint, java.awt.geom.Point2D.Double endPoint) Returns the direction from the provided start point to the end point.
static TranslationDirection	getDirection(java.awt.Point startPoint, java.awt.Point endPoint) Returns the direction from the provided start point to the end point.
static TranslationDirection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TranslationDirection[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final TranslationDirection NORTH

WEST

public static final TranslationDirection WEST

SOUTH

public static final TranslationDirection SOUTH

EAST

public static final TranslationDirection EAST

NORTH_WEST

public static final TranslationDirection NORTH_WEST

SOUTH_WEST

public static final TranslationDirection SOUTH_WEST

NORTH_EAST

public static final TranslationDirection NORTH_EAST

SOUTH_EAST

public static final TranslationDirection SOUTH_EAST

Method Detail

values

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

Returns:

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

valueOf

public static TranslationDirection valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getDirection

@Nullable
public static TranslationDirection getDirection(java.awt.Point startPoint,
                                                          java.awt.Point endPoint)

Returns the direction from the provided start point to the end point. Returns null, if both points are at the same location.

getDirection

@Nullable
public static TranslationDirection getDirection(java.awt.geom.Point2D.Double startPoint,
                                                          java.awt.geom.Point2D.Double endPoint)

Returns the direction from the provided start point to the end point. Returns null, if both points are at the same location.