Package org.daisy.dotify.api.translator

Enum BorderSpecification.Align

java.lang.Object

java.lang.Enum<BorderSpecification.Align>

org.daisy.dotify.api.translator.BorderSpecification.Align

All Implemented Interfaces:

Serializable, Comparable<BorderSpecification.Align>

Enclosing class:

BorderSpecification

public static enum BorderSpecification.Align
extends Enum<BorderSpecification.Align>

Defines border alignments.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTER	Defines that the border line should be equally close to the surrounded content as it is to the surrounding content.
INNER	Defines that the border line should be close to the content.
OUTER	Defines that the border line should be far from the content.

Method Summary

Modifier and Type	Method	Description
int	align(int w)	Returns the offset from the outer edge of the specified value.
static BorderSpecification.Align	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BorderSpecification.Align[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INNER

public static final BorderSpecification.Align INNER

Defines that the border line should be close to the content.

CENTER

public static final BorderSpecification.Align CENTER

Defines that the border line should be equally close to the surrounded content as it is to the surrounding content.

OUTER

public static final BorderSpecification.Align OUTER

Defines that the border line should be far from the content.

Method Detail

values

public static BorderSpecification.Align[] 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 (BorderSpecification.Align c : BorderSpecification.Align.values())
    System.out.println(c);

Returns:

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

valueOf

public static BorderSpecification.Align 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

align

public int align(int w)

Returns the offset from the outer edge of the specified value.

Parameters:

w - the width to align

Returns:

returns the alignment value