org.axsl.common.value

Enum Overflow

java.lang.Object

java.lang.Enum<Overflow>

org.axsl.common.value.Overflow

All Implemented Interfaces:

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

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

Enumeration of valid "overflow" values, that is, the property that tells what to do when the content of an element overflows its Area. See XSL-FO Recommendation 1.1, Section 7.21.2.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Provides a scrolling mechanism for overflowing boxes.
ERROR_IF_OVERFLOW Implies the same as "hidden", but with an error indicated.
HIDDEN The content is clipped, and no scrolling mechanism is provided.
REPEAT The meaning of this value is unclear.
SCROLL The content is clipped, and a scrolling mechanism is provided.
VISIBLE The content is not clipped, that is, it may be rendered outside of its area.

Method Summary

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

VISIBLE

public static final Overflow VISIBLE

The content is not clipped, that is, it may be rendered outside of its area.

HIDDEN

public static final Overflow HIDDEN

The content is clipped, and no scrolling mechanism is provided.

SCROLL

public static final Overflow SCROLL

The content is clipped, and a scrolling mechanism is provided.

ERROR_IF_OVERFLOW

public static final Overflow ERROR_IF_OVERFLOW

Implies the same as "hidden", but with an error indicated.

REPEAT

public static final Overflow REPEAT

The meaning of this value is unclear.

AUTO

public static final Overflow AUTO

Provides a scrolling mechanism for overflowing boxes.

Method Detail

values

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

Returns:

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

valueOf

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