org.axsl.common.value

Enum MediaUsage

java.lang.Object

java.lang.Enum<MediaUsage>

org.axsl.common.value.MediaUsage

All Implemented Interfaces:

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

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

Enumeration of possible media-usage values. Note that the XSL-FO standard specifies an "auto" value, but that value should be resolved to one of the others.

See Also:

"XSL-FO Recommendation 1.1, Section 7.27.11"

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOUNDED_IN_ONE_DIMENSION Output is placed on one page.
PAGINATE Output is paginated.
UNBOUNDED Output is placed on one page, and neither page-height nor page-width may be specified.

Method Summary

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

PAGINATE

public static final MediaUsage PAGINATE

Output is paginated.

BOUNDED_IN_ONE_DIMENSION

public static final MediaUsage BOUNDED_IN_ONE_DIMENSION

Output is placed on one page. Either page-height or page-width may be specified.

UNBOUNDED

public static final MediaUsage UNBOUNDED

Output is placed on one page, and neither page-height nor page-width may be specified.

Method Detail

values

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

Returns:

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

valueOf

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