Package io.keikai.axyra.sheets.style

Enum Class FontVertical

java.lang.Object

java.lang.Enum<FontVertical>

io.keikai.axyra.sheets.style.FontVertical

All Implemented Interfaces:

Serializable, Comparable<FontVertical>, Constable

public enum FontVertical
extends Enum<FontVertical>

The vertical position of the font: normal baseline, superscript or subscript (ECMA-376 ST_VerticalAlignRun). Set it with CellStyle.Builder.fontVertical(FontVertical).

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
BASELINE	Normal text on the baseline.
SUBSCRIPT	Lowered and smaller, as the 2 in H2O.
SUPERSCRIPT	Raised and smaller, as in x squared.

Method Summary

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

BASELINE

public static final FontVertical BASELINE

Normal text on the baseline.

SUPERSCRIPT

public static final FontVertical SUPERSCRIPT

Raised and smaller, as in x squared.

SUBSCRIPT

public static final FontVertical SUBSCRIPT

Lowered and smaller, as the 2 in H2O.

Method Details

values

public static FontVertical[] 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 FontVertical 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_VerticalAlignRun token, e.g. "superscript".

Returns:

the token as written in the file

from

public static FontVertical from(String token)

Parses an ST_VerticalAlignRun token, case-sensitively.

Parameters:

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

Returns:

the matching position; BASELINE for null, empty or unknown tokens