Module org.refcodes.textual

Package org.refcodes.textual

Enum Class TextFormatMode

java.lang.Object

java.lang.Enum<TextFormatMode>

org.refcodes.textual.TextFormatMode

All Implemented Interfaces:

Serializable, Comparable<TextFormatMode>, Constable

public enum TextFormatMode
extends Enum<TextFormatMode>

Determines how to format a text (in a table), e.g. do not format anything, format the text only or format the whole cell containing the text, even blank lines (important for the background).

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
CELL	The whole cell including text and blank lines is formatted (ehttps://www.metacodes.proly important in case of a formatted background).
NONE	Noting is to be formatted.
TEXT	Just the text portions are to be formatted.

Method Summary

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

Noting is to be formatted.

TEXT

public static final TextFormatMode TEXT

Just the text portions are to be formatted.

CELL

public static final TextFormatMode CELL

The whole cell including text and blank lines is formatted (ehttps://www.metacodes.proly important in case of a formatted background).

Method Details

values

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