org.axsl.common.value

Enum HyphenationKeep

java.lang.Object

java.lang.Enum<HyphenationKeep>

org.axsl.common.value.HyphenationKeep

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HyphenationKeep>

public enum HyphenationKeep
extends java.lang.Enum<HyphenationKeep>

Enumeration of possible hyphenation-keep values.

See Also:

"XSL-FO, 1.1, Section 7.16.1 (page 318)."

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO No restriction applies.
COLUMN Both parts of a hyphenated word shall lie within a single column.
PAGE Both parts of a hyphenated word shall lie within a single page.

Method Summary

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

AUTO

public static final HyphenationKeep AUTO

No restriction applies. The word may be hyphenated at the end of any region.

COLUMN

public static final HyphenationKeep COLUMN

Both parts of a hyphenated word shall lie within a single column.

PAGE

public static final HyphenationKeep PAGE

Both parts of a hyphenated word shall lie within a single page.

Method Detail

values

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

Returns:

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

valueOf

public static HyphenationKeep valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null