org.axsl.common.value
Enum SuppressAtLineBreak

java.lang.Object
  java.lang.Enum<SuppressAtLineBreak>
      org.axsl.common.value.SuppressAtLineBreak

All Implemented Interfaces:

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

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

Enumeration of possible suppress-at-line-break values.

See Also:

"XSL-FO, 1.1, Section 7.17.3 (page 330)."

Enum Constant Summary

AUTO
The character U+0020 (space) is treated as if "suppress" had been specified, all other characters are treated as if "retain" has been specified.

RETAIN
The character shall be placed in the area tree whether or not it is first or last in a line-area.

SUPPRESS
The character is eligible to be suppressed at the start or end of a line-area depending on the white-space-treatment property.

Method Summary

static SuppressAtLineBreak	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SuppressAtLineBreak[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, 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 SuppressAtLineBreak AUTO

The character U+0020 (space) is treated as if "suppress" had been specified, all other characters are treated as if "retain" has been specified.

SUPPRESS

public static final SuppressAtLineBreak SUPPRESS

The character is eligible to be suppressed at the start or end of a line-area depending on the white-space-treatment property.

RETAIN

public static final SuppressAtLineBreak RETAIN

The character shall be placed in the area tree whether or not it is first or last in a line-area.

Method Detail

values

public static final SuppressAtLineBreak[] values()

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

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

Returns:

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

valueOf

public static SuppressAtLineBreak 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