Package io.keikai.axyra.sheets.style

Enum Class Underline

java.lang.Object

java.lang.Enum<Underline>

io.keikai.axyra.sheets.style.Underline

All Implemented Interfaces:

Serializable, Comparable<Underline>, Constable

public enum Underline
extends Enum<Underline>

The underline style of a font (ECMA-376 ST_UnderlineValues). Set it with CellStyle.Builder.underline(Underline).

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
DOUBLE	Two lines under the text.
DOUBLE_ACCOUNTING	Two lines placed lower and spanning the cell width.
NONE	No underline.
SINGLE	One line under the text.
SINGLE_ACCOUNTING	One line placed lower and spanning the cell width, as on financial statements.

Method Summary

Modifier and Type	Method	Description
static Underline	from(String token)	Parses an ST_UnderlineValues token, case-sensitively.
String	token()	The ECMA-376 ST_UnderlineValues token, e.g.
static Underline	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Underline[]	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 Underline NONE

No underline.

SINGLE

public static final Underline SINGLE

One line under the text.

DOUBLE

public static final Underline DOUBLE

Two lines under the text.

SINGLE_ACCOUNTING

public static final Underline SINGLE_ACCOUNTING

One line placed lower and spanning the cell width, as on financial statements.

DOUBLE_ACCOUNTING

public static final Underline DOUBLE_ACCOUNTING

Two lines placed lower and spanning the cell width.

Method Details

values

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

token

public String token()

The ECMA-376 ST_UnderlineValues token, e.g. "singleAccounting".

Returns:

the token as written in the file

from

public static Underline from(String token)

Parses an ST_UnderlineValues token, case-sensitively.

Parameters:

token - the token, e.g. "single"

Returns:

the matching style; NONE for null, empty or unknown tokens