Package swingtree

Enum Class UI.Placement

java.lang.Object

java.lang.Enum<UI.Placement>

swingtree.UI.Placement

All Implemented Interfaces:

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

Enclosing class:

UI

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

Names a point of a rectangular component: one of its four corners, the middle of one of its four sides, or its center. Use it to place an image or a text as part of the ImageConf and TextConf styles, and to align the contents of a label through UIForLabel.withAlignment(Placement).

UNDEFINED names no point at all, which leaves the choice to whoever does the placing: an image style falls back to the preferred placement of an SvgIcon, and to CENTER where there is none.

A placement is a point which has already been chosen, so this enum names no reading direction: it has no leading and no trailing constant. of(VerticalAlignment, HorizontalAlignment, ComponentOrientation) accepts UI.HorizontalAlignment.LEADING and UI.HorizontalAlignment.TRAILING and resolves them against an orientation, but horizontal() never answers with either of them. To align a component along the reading direction rather than at a fixed side, pass those two constants to UIForLabel.withHorizontalAlignment(UI.HorizontalAlignment) instead.

See Also:

• ImageConf.placement(Placement)
• TextConf.placement(Placement)
• SvgIcon.withPreferredPlacement(Placement)
• UIForLabel.withAlignment(Placement)
• ComponentStyleDelegate.fontAlignment(Placement)

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	The middle of the bottom edge, so at the bottom and horizontally centred.
BOTTOM_LEFT	The bottom left corner.
BOTTOM_RIGHT	The bottom right corner.
CENTER	The middle of the component, on both axes.
LEFT	The middle of the left edge, so at the left and vertically centred.
RIGHT	The middle of the right edge, so at the right and vertically centred.
TOP	The middle of the top edge, so at the top and horizontally centred.
TOP_LEFT	The top left corner.
TOP_RIGHT	The top right corner.
UNDEFINED	No point at all, which leaves the choice of one to whoever does the placing.

Method Summary

Modifier and Type	Method	Description
UI.HorizontalAlignment	horizontal()	Returns which of the left, the middle or the right of the component this point sits at.
boolean	isCorner()	Tells whether this point is one of the four corners rather than a side or the center.
static UI.Placement	of(UI.VerticalAlignment vertical, UI.HorizontalAlignment horizontal)	Combines a vertical and a horizontal alignment into the single point they name, reading UI.HorizontalAlignment.LEADING and UI.HorizontalAlignment.TRAILING left to right.
static UI.Placement	of(UI.VerticalAlignment vertical, UI.HorizontalAlignment horizontal, UI.ComponentOrientation orientation)	Combines a vertical and a horizontal alignment into the single point they name, reading UI.HorizontalAlignment.LEADING and UI.HorizontalAlignment.TRAILING against the given orientation, which is the only place their meaning is decided.
UI.Placement	opposite()	Returns the point reached by going from this one through the center of the component and out the other side, which is where to put something that should sit across from whatever this point marks.
static UI.Placement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UI.Placement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
UI.VerticalAlignment	vertical()	Returns which of the top, the middle or the bottom of the component this point sits at.

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

UNDEFINED

public static final UI.Placement UNDEFINED

No point at all, which leaves the choice of one to whoever does the placing.

TOP

public static final UI.Placement TOP

The middle of the top edge, so at the top and horizontally centred.

LEFT

public static final UI.Placement LEFT

The middle of the left edge, so at the left and vertically centred.

BOTTOM

public static final UI.Placement BOTTOM

The middle of the bottom edge, so at the bottom and horizontally centred.

RIGHT

public static final UI.Placement RIGHT

The middle of the right edge, so at the right and vertically centred.

TOP_LEFT

public static final UI.Placement TOP_LEFT

The top left corner.

TOP_RIGHT

public static final UI.Placement TOP_RIGHT

The top right corner.

BOTTOM_LEFT

public static final UI.Placement BOTTOM_LEFT

The bottom left corner.

BOTTOM_RIGHT

public static final UI.Placement BOTTOM_RIGHT

The bottom right corner.

CENTER

public static final UI.Placement CENTER

The middle of the component, on both axes.

Method Details

values

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

of

public static UI.Placement of(UI.VerticalAlignment vertical,
 UI.HorizontalAlignment horizontal,
 UI.ComponentOrientation orientation)

Combines a vertical and a horizontal alignment into the single point they name, reading UI.HorizontalAlignment.LEADING and UI.HorizontalAlignment.TRAILING against the given orientation, which is the only place their meaning is decided.

Parameters:

vertical - Which of the top, the middle or the bottom of the component to use.

horizontal - Which of the left, the middle or the right of the component to use.

orientation - The reading direction that turns UI.HorizontalAlignment.LEADING into a left or a right; UI.ComponentOrientation.UNKNOWN reads left to right, matching ComponentOrientation.UNKNOWN.

Returns:

The point named by both alignments, or UNDEFINED if neither names one.

of

public static UI.Placement of(UI.VerticalAlignment vertical,
 UI.HorizontalAlignment horizontal)

Combines a vertical and a horizontal alignment into the single point they name, reading UI.HorizontalAlignment.LEADING and UI.HorizontalAlignment.TRAILING left to right. Call of(VerticalAlignment, HorizontalAlignment, ComponentOrientation) where the reading direction of the component is known.

Parameters:

vertical - Which of the top, the middle or the bottom of the component to use.

horizontal - Which of the left, the middle or the right of the component to use.

Returns:

The point named by both alignments, or UNDEFINED if neither names one.

vertical

public UI.VerticalAlignment vertical()

Returns which of the top, the middle or the bottom of the component this point sits at. A point has both coordinates, so the side constants answer here too: LEFT sits at the middle of the left edge and answers UI.VerticalAlignment.CENTER.

Returns:

The vertical half of this point, and UI.VerticalAlignment.UNDEFINED only for UNDEFINED.

horizontal

public UI.HorizontalAlignment horizontal()

Returns which of the left, the middle or the right of the component this point sits at. A point has both coordinates, so the side constants answer here too: TOP sits at the middle of the top edge and answers UI.HorizontalAlignment.CENTER. This never answers UI.HorizontalAlignment.LEADING or UI.HorizontalAlignment.TRAILING, because the reading direction was already resolved when the point was built.

Returns:

The horizontal half of this point, and UI.HorizontalAlignment.UNDEFINED only for UNDEFINED.

opposite

public UI.Placement opposite()

Returns the point reached by going from this one through the center of the component and out the other side, which is where to put something that should sit across from whatever this point marks.

Returns:

The point across the component, so BOTTOM_RIGHT for TOP_LEFT and RIGHT for LEFT. CENTER and UNDEFINED return themselves, because neither marks a side to be across from.

isCorner

public boolean isCorner()

Tells whether this point is one of the four corners rather than a side or the center.

Returns:

True for TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT and BOTTOM_RIGHT.