com.alee.api.data

Enum Orientation

java.lang.Object

java.lang.Enum<Orientation>

com.alee.api.data.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>, SwingConstants

public enum Orientation
extends Enum<Orientation>
implements SwingConstants

Enumeration representing orientation constants. It is designed to conveniently provide state titles for various components.

Author:

Mikle Garin

Enum Constant Summary

Enum Constants

Enum Constant and Description
horizontal Horizontal orientation.
vertical Vertical orientation.

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
static Orientation	get(int value) Returns enumeration literal referencing constant value.
int	getValue() Returns constant value.
boolean	isHorizontal() Returns whether or not orientation is horizontal.
boolean	isVertical() Returns whether or not orientation is vertical.
Orientation	opposite() Returns Orientation opposite to this one.
static Orientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Orientation[]	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

horizontal

public static final Orientation horizontal

Horizontal orientation.

See Also:

SwingConstants.HORIZONTAL

vertical

public static final Orientation vertical

Vertical orientation.

See Also:

SwingConstants.VERTICAL

Method Detail

values

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

Returns:

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

valueOf

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

opposite

public Orientation opposite()

Returns Orientation opposite to this one.

Returns:

Orientation opposite to this one

getValue

public int getValue()

Returns constant value.

Returns:

constant value

isHorizontal

public boolean isHorizontal()

Returns whether or not orientation is horizontal.

Returns:

true if orientation is horizontal, false otherwise

isVertical

public boolean isVertical()

Returns whether or not orientation is vertical.

Returns:

true if orientation is vertical, false otherwise

get

public static Orientation get(int value)

Returns enumeration literal referencing constant value.

Parameters:

value - constant value

Returns:

enumeration literal referencing constant value