Package swingtree

Enum Class UI.Side

java.lang.Object

java.lang.Enum<UI.Side>

swingtree.UI.Side

All Implemented Interfaces:

Serializable, Comparable<UI.Side>, Constable, UIEnum<UI.Side>

Enclosing class:

UI

@Immutable
public static enum UI.Side
extends Enum<UI.Side>
implements UIEnum<UI.Side>

All UI components are at their core rectangular, meaning they always have exactly 4 uniquely identifiable sides. This enum is used to target specific sides of a JComponent in various API methods like for example UIForTabbedPane.withTabPlacementAt(Side) or the tapped pane factory method UIFactoryMethods.tabbedPane(Side).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM
LEFT
RIGHT
TOP

Method Summary

Modifier and Type	Method	Description
static UI.Side	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UI.Side[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface swingtree.UIEnum

isNoneOf, isNoneOf, isNoneOf, isOneOf, isOneOf, isOneOf

Enum Constant Details

TOP

public static final UI.Side TOP

LEFT

public static final UI.Side LEFT

BOTTOM

public static final UI.Side BOTTOM

RIGHT

public static final UI.Side RIGHT

Method Details

values

public static UI.Side[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UI.Side valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null