Package com.nsdev.lettergenerator.model.layout

Enum Class Keep

java.lang.Object

java.lang.Enum<Keep>

com.nsdev.lettergenerator.model.layout.Keep

All Implemented Interfaces:

Serializable, Comparable<Keep>, Constable

public enum Keep
extends Enum<Keep>

Page-breaking strength for a block, successor relationship or table row.

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
ALWAYS	Strongly request a keep; impossible layouts remain subject to engine validation.
AUTO	Allow normal page breaks, including disabling an ordinary heading keep.
PREFER	Prefer keeping content together, but allow a break when necessary.

Method Summary

Modifier and Type	Method	Description
static Keep	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Keep[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final Keep AUTO

Allow normal page breaks, including disabling an ordinary heading keep.

PREFER

public static final Keep PREFER

Prefer keeping content together, but allow a break when necessary.

ALWAYS

public static final Keep ALWAYS

Strongly request a keep; impossible layouts remain subject to engine validation.

Method Details

values

public static Keep[] 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 Keep 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