com.alee.api.data

Enum BoxOrientation

java.lang.Object

java.lang.Enum<BoxOrientation>

com.alee.api.data.BoxOrientation

All Implemented Interfaces:

Serializable, Comparable<BoxOrientation>, SwingConstants

public enum BoxOrientation
extends Enum<BoxOrientation>
implements SwingConstants

Enumeration representing box 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
bottom
center
left
right
top

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 BoxOrientation	get(int value) Returns enumeration literal referencing constant value.
int	getValue() Returns constant value.
boolean	isBottom() Returns whether or not this is a bottom literal.
boolean	isCenter() Returns whether or not this is a center literal.
boolean	isLeft() Returns whether or not this is a left literal.
boolean	isRight() Returns whether or not this is a right literal.
boolean	isTop() Returns whether or not this is a top literal.
static BoxOrientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoxOrientation[]	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 BoxOrientation center

top

public static final BoxOrientation top

left

public static final BoxOrientation left

bottom

public static final BoxOrientation bottom

right

public static final BoxOrientation right

Method Detail

values

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

Returns:

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

valueOf

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

isCenter

public boolean isCenter()

Returns whether or not this is a center literal.

Returns:

true if this is a center literal, false otherwise

isTop

public boolean isTop()

Returns whether or not this is a top literal.

Returns:

true if this is a top literal, false otherwise

isLeft

public boolean isLeft()

Returns whether or not this is a left literal.

Returns:

true if this is a left literal, false otherwise

isBottom

public boolean isBottom()

Returns whether or not this is a bottom literal.

Returns:

true if this is a bottom literal, false otherwise

isRight

public boolean isRight()

Returns whether or not this is a right literal.

Returns:

true if this is a right literal, false otherwise

get

@NotNull
public static BoxOrientation get(int value)

Returns enumeration literal referencing constant value.

Parameters:

value - constant value

Returns:

enumeration literal referencing constant value