Package swingtree

Enum Class UI.ComponentArea

java.lang.Object

java.lang.Enum<UI.ComponentArea>

swingtree.UI.ComponentArea

All Implemented Interfaces:

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

Enclosing class:

UI

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

Defines the areas of a component, which is used to by the ImageConf to determine if and how an image should be clipped. Pass instances of this to ImageConf.clipTo(ComponentArea) to configure the clipping behaviour as part of the style API (see UIForAnySwing.withStyle(Styler)).
The following list describes what each enum instance represents:

• ALL - The entire component, which is the union of all other clip areas (INTERIOR + EXTERIOR + BORDER + CONTENT).
• INTERIOR - The inner component area, which is defined as ALL - EXTERIOR - BORDER.
• EXTERIOR - The outer component area, which can be expressed as ALL - INTERIOR - BORDER, or ALL - CONTENT.
• BORDER - The border of the component, which is the area between the inner and outer component area and which can be expressed as ALL - INTERIOR - EXTERIOR.
• BODY - The body of the component is the inner component area including the border area. It can be expressed as ALL - EXTERIOR, or INTERIOR + BORDER.

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
ALL
BODY
BORDER
EXTERIOR
INTERIOR

Method Summary

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

ALL

public static final UI.ComponentArea ALL

EXTERIOR

public static final UI.ComponentArea EXTERIOR

BORDER

public static final UI.ComponentArea BORDER

INTERIOR

public static final UI.ComponentArea INTERIOR

BODY

public static final UI.ComponentArea BODY

Method Details

values

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