de.vandermeer.skb.interfaces.transformers.textformat

Enum TextFormat

Object

Enum<TextFormat>

TextFormat

All Implemented Interfaces:

Serializable, Comparable<TextFormat>

public enum TextFormat
extends Enum<TextFormat>

Options for text format.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DROPCAP Use a dropped capital letter at the start of the paragraph.
DROPCAP_WITH_PADDING Use a dropped capital letter at the start of the paragraph with padding for all lines.
FIRST_LINE Indentation of the first line of the paragraph.
HANGING A hanging paragraph, all but the first line with special indentation.
NONE No special formatting.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mapping A mapping to the alignment options in Text_To_FormattedText.

Method Summary

Modifier and Type	Method and Description
int	getMapping() Returns a mapping to the alignment options defined in Text_To_FormattedText.
static TextFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static TextFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final TextFormat NONE

No special formatting.

FIRST_LINE

public static final TextFormat FIRST_LINE

Indentation of the first line of the paragraph.

HANGING

public static final TextFormat HANGING

A hanging paragraph, all but the first line with special indentation.

DROPCAP

public static final TextFormat DROPCAP

Use a dropped capital letter at the start of the paragraph.

DROPCAP_WITH_PADDING

public static final TextFormat DROPCAP_WITH_PADDING

Use a dropped capital letter at the start of the paragraph with padding for all lines.

Field Detail

mapping

protected int mapping

A mapping to the alignment options in Text_To_FormattedText.

Method Detail

values

public static TextFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TextFormat c : TextFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TextFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getMapping

public int getMapping()

Returns a mapping to the alignment options defined in Text_To_FormattedText.

Returns:

mapping