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.

Version:

3.0 Renamed from Direction to TranslationDirection.
2.0 2007-07-31 Added directions NORTH_WEST, SOUTH_WEST, NORTH_EAST and SOUTH_EAST. Added method getDirection.
1.0 2007-04-29 Created.

Author:

Werner Randelshofer

See Also:

Constrainer

Enum Constant Summary

EAST

NORTH

NORTH_EAST

NORTH_WEST

SOUTH

SOUTH_EAST

SOUTH_WEST

WEST

Method Summary

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're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, 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 final TranslationDirection[] values()

Returns an array containing the constants of this enum type, in the order they're 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're 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

getDirection

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

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.