Module org.refcodes.graphical

Package org.refcodes.graphical

Enum Class BoxBorderMode

java.lang.Object

java.lang.Enum<BoxBorderMode>

org.refcodes.graphical.BoxBorderMode

All Implemented Interfaces:

Serializable, Comparable<BoxBorderMode>, Constable

public enum BoxBorderMode
extends Enum<BoxBorderMode>

The BoxBorderMode specifies for according algorithms on how a box is to be drawn.

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
BOTTOM
BOTTOM_LEFT
LEFT
NONE
RIGHT
RIGHT_BOTTOM
RIGHT_BOTTOM_LEFT
RIGHT_LEFT
TOP
TOP_BOTTOM
TOP_BOTTOM_LEFT
TOP_LEFT
TOP_RIGHT
TOP_RIGHT_BOTTOM
TOP_RIGHT_BOTTOM_LEFT
TOP_RIGHT_LEFT

Method Summary

Modifier and Type	Method	Description
static BoxBorderMode	fromBoxBorders(boolean isTopBorder, boolean isRightBorder, boolean isBottomBorder, boolean isLeftBorder)	From box borders.
boolean	isBottomBorder()	Checks if is bottom border.
boolean	isLeftBorder()	Checks if is left border.
boolean	isRightBorder()	Checks if is right border.
boolean	isTopBorder()	Checks if is top border.
static BoxBorderMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BoxBorderMode[]	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

Enum Constant Details

NONE

public static final BoxBorderMode NONE

LEFT

public static final BoxBorderMode LEFT

BOTTOM

public static final BoxBorderMode BOTTOM

BOTTOM_LEFT

public static final BoxBorderMode BOTTOM_LEFT

RIGHT

public static final BoxBorderMode RIGHT

RIGHT_LEFT

public static final BoxBorderMode RIGHT_LEFT

RIGHT_BOTTOM

public static final BoxBorderMode RIGHT_BOTTOM

RIGHT_BOTTOM_LEFT

public static final BoxBorderMode RIGHT_BOTTOM_LEFT

TOP

public static final BoxBorderMode TOP

TOP_LEFT

public static final BoxBorderMode TOP_LEFT

TOP_BOTTOM

public static final BoxBorderMode TOP_BOTTOM

TOP_BOTTOM_LEFT

public static final BoxBorderMode TOP_BOTTOM_LEFT

TOP_RIGHT

public static final BoxBorderMode TOP_RIGHT

TOP_RIGHT_LEFT

public static final BoxBorderMode TOP_RIGHT_LEFT

TOP_RIGHT_BOTTOM

public static final BoxBorderMode TOP_RIGHT_BOTTOM

TOP_RIGHT_BOTTOM_LEFT

public static final BoxBorderMode TOP_RIGHT_BOTTOM_LEFT

ALL

public static final BoxBorderMode ALL

Method Details

values

public static BoxBorderMode[] 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 BoxBorderMode 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

isLeftBorder

public boolean isLeftBorder()

Checks if is left border.

Returns:

true, if is left border

isTopBorder

public boolean isTopBorder()

Checks if is top border.

Returns:

true, if is top border

isRightBorder

public boolean isRightBorder()

Checks if is right border.

Returns:

true, if is right border

isBottomBorder

public boolean isBottomBorder()

Checks if is bottom border.

Returns:

true, if is bottom border

fromBoxBorders

public static BoxBorderMode fromBoxBorders(boolean isTopBorder,
 boolean isRightBorder,
 boolean isBottomBorder,
 boolean isLeftBorder)

From box borders.

Parameters:

isTopBorder - the is top border

isRightBorder - the is right border

isBottomBorder - the is bottom border

isLeftBorder - the is left border

Returns:

the box border mode