Package swingtree

Enum Class UI.Axis

java.lang.Object

java.lang.Enum<UI.Axis>

swingtree.UI.Axis

All Implemented Interfaces:

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

Enclosing class:

UI

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

Used to define how a layout manager (typically the BoxLayout) will lay out components along the given axis.
Create a simple box layout for your components by calling the UIForAnySwing.withBoxLayout(Axis) method, or use Layout.box(Axis) factory method returning a Layout config object which can be passed to the style API (see UIForAnySwing.withStyle(Styler) and ComponentStyleDelegate.layout(Layout)).

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
LINE	Specifies that something is laid out in the direction of a line of text as determined by the target container's ComponentOrientation property.
PAGE	Specifies that something is laid out in the direction that lines flow across a page as determined by the target container's ComponentOrientation property.
X	Specifies that something is laid out left to right.
Y	Specifies that something is laid out top to bottom.

Method Summary

Modifier and Type	Method	Description
int	forBoxLayout()
static UI.Axis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UI.Axis[]	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

X

public static final UI.Axis X

Specifies that something is laid out left to right.

Y

public static final UI.Axis Y

Specifies that something is laid out top to bottom.

LINE

public static final UI.Axis LINE

Specifies that something is laid out in the direction of a line of text as determined by the target container's ComponentOrientation property.

PAGE

public static final UI.Axis PAGE

Specifies that something is laid out in the direction that lines flow across a page as determined by the target container's ComponentOrientation property.

Method Details

values

public static UI.Axis[] 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.Axis 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

forBoxLayout

public int forBoxLayout()