org.apache.pdfbox.util

Enum Overlay.Position

java.lang.Object

java.lang.Enum<Overlay.Position>

org.apache.pdfbox.util.Overlay.Position

All Implemented Interfaces:

Serializable, Comparable<Overlay.Position>

Enclosing class:

Overlay

public static enum Overlay.Position
extends Enum<Overlay.Position>

Possible location of the overlayed pages: foreground or background.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKGROUND
FOREGROUND

Method Summary

Methods

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

FOREGROUND

public static final Overlay.Position FOREGROUND

BACKGROUND

public static final Overlay.Position BACKGROUND

Method Detail

values

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

Returns:

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

valueOf

public static Overlay.Position valueOf(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:

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

NullPointerException - if the argument is null