Package swingtree

Enum Class UI.ComponentBoundary

java.lang.Object

java.lang.Enum<UI.ComponentBoundary>

swingtree.UI.ComponentBoundary

All Implemented Interfaces:

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

Enclosing class:

UI

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

Names one of the infinitely thin lines at which the box model (margin|border|padding) of a styled component steps from one layer into the next, whereas a UI.ComponentArea names a whole region lying between two such lines. A style can anchor a gradient to a boundary through GradientConf.boundary(ComponentBoundary), and place an image or a text against one through ImageConf.placementBoundary(ComponentBoundary).
Here's a brief explanation of each enum entry:

• OUTER_TO_EXTERIOR - The outer edge of the whole component, which is where its margin starts.
• EXTERIOR_TO_BORDER - The line after the margin and before the border, which tightly wraps the entire UI.ComponentArea.BODY.
• BORDER_TO_INTERIOR - The line after the border and before the padding, which is the outer edge of the UI.ComponentArea.INTERIOR.
• INTERIOR_TO_CONTENT - The line after the padding, where the content of the component begins, like for example the contents of a JPanel or JScrollPane.
• CENTER_TO_CONTENT - The center point of the component, which is a point rather than a line.

OUTER_TO_EXTERIOR, EXTERIOR_TO_BORDER and BORDER_TO_INTERIOR each wrap a whole UI.ComponentArea, which wrappedArea() returns. The other two lie inside the interior and wrap no named area.

See Also:

• TextConf.placementBoundary(ComponentBoundary)
• ImageConf.placementBoundary(ComponentBoundary)
• GradientConf.boundary(ComponentBoundary)
• UI.ComponentArea

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
BORDER_TO_INTERIOR	The line after the border and before the padding.
CENTER_TO_CONTENT	The center point of the component, which is a point rather than a line.
EXTERIOR_TO_BORDER	The line after the margin and before the border.
INTERIOR_TO_CONTENT	The line after the padding, and the innermost boundary of the component: it is where the content of the component begins, like for example the contents of a JPanel or JScrollPane.
OUTER_TO_EXTERIOR	The outer edge of the whole component, which is where its margin starts.

Method Summary

Modifier and Type	Method	Description
static UI.ComponentBoundary	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UI.ComponentBoundary[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
Optional<UI.ComponentArea>	wrappedArea()	Returns the UI.ComponentArea this boundary tightly wraps, so that the two enums describing one box model cannot drift apart: OUTER_TO_EXTERIOR wraps UI.ComponentArea.ALL, EXTERIOR_TO_BORDER wraps UI.ComponentArea.BODY and BORDER_TO_INTERIOR wraps UI.ComponentArea.INTERIOR.

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

OUTER_TO_EXTERIOR

public static final UI.ComponentBoundary OUTER_TO_EXTERIOR

The outer edge of the whole component, which is where its margin starts. This tightly wraps the entire UI.ComponentArea.ALL.

EXTERIOR_TO_BORDER

public static final UI.ComponentBoundary EXTERIOR_TO_BORDER

The line after the margin and before the border. This tightly wraps the entire UI.ComponentArea.BODY.

BORDER_TO_INTERIOR

public static final UI.ComponentBoundary BORDER_TO_INTERIOR

The line after the border and before the padding. This tightly wraps the entire UI.ComponentArea.INTERIOR.

INTERIOR_TO_CONTENT

public static final UI.ComponentBoundary INTERIOR_TO_CONTENT

The line after the padding, and the innermost boundary of the component: it is where the content of the component begins, like for example the contents of a JPanel or JScrollPane.

CENTER_TO_CONTENT

public static final UI.ComponentBoundary CENTER_TO_CONTENT

The center point of the component, which is a point rather than a line.

Method Details

values

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

wrappedArea

public Optional<UI.ComponentArea> wrappedArea()

Returns the UI.ComponentArea this boundary tightly wraps, so that the two enums describing one box model cannot drift apart: OUTER_TO_EXTERIOR wraps UI.ComponentArea.ALL, EXTERIOR_TO_BORDER wraps UI.ComponentArea.BODY and BORDER_TO_INTERIOR wraps UI.ComponentArea.INTERIOR. Each of those three areas returns this same boundary from UI.ComponentArea.outerBoundary().

Returns:

The wrapped area, and an empty Optional for INTERIOR_TO_CONTENT and CENTER_TO_CONTENT, which enclose the content rather than a named area.