com.alee.api.data

Enum CompassDirection

java.lang.Object

java.lang.Enum<CompassDirection>

com.alee.api.data.CompassDirection

All Implemented Interfaces:

Serializable, Comparable<CompassDirection>, SwingConstants

public enum CompassDirection
extends Enum<CompassDirection>
implements SwingConstants

Enumeration representing compass direction constants. It is designed to conveniently provide state titles for various components. todo Remove center direction as it not really correct?

Author:

Mikle Garin

Enum Constant Summary

Enum Constants

Enum Constant and Description
center
east
north
northEast
northWest
south
southEast
southWest
west

Field Summary

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Method Summary

Modifier and Type	Method and Description
CompassDirection	adjust(ComponentOrientation orientation) Returns direction adjusted according to component orientation.
static CompassDirection	get(int value) Returns enumeration literal referencing constant value.
int	getValue() Returns constant value.
CompassDirection	opposite() Returns direction opposite to this one.
static CompassDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompassDirection[]	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

center

public static final CompassDirection center

northEast

public static final CompassDirection northEast

north

public static final CompassDirection north

northWest

public static final CompassDirection northWest

east

public static final CompassDirection east

west

public static final CompassDirection west

southEast

public static final CompassDirection southEast

south

public static final CompassDirection south

southWest

public static final CompassDirection southWest

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Returns constant value.

Returns:

constant value

opposite

public CompassDirection opposite()

Returns direction opposite to this one.

Returns:

direction opposite to this one

adjust

public CompassDirection adjust(ComponentOrientation orientation)

Returns direction adjusted according to component orientation.

Parameters:

orientation - component orientation

Returns:

direction adjusted according to component orientation

get

public static CompassDirection get(int value)

Returns enumeration literal referencing constant value.

Parameters:

value - constant value

Returns:

enumeration literal referencing constant value