Package com.realobjects.pdfreactor

Enum Configuration.OverlayFit

java.lang.Object

java.lang.Enum<Configuration.OverlayFit>

com.realobjects.pdfreactor.Configuration.OverlayFit

All Implemented Interfaces:

Serializable, Comparable<Configuration.OverlayFit>, java.lang.constant.Constable

Enclosing class:

Configuration

public static enum Configuration.OverlayFit
extends Enum<Configuration.OverlayFit>

An enum containing data to configure how overlay pages that have different dimensions from the pages they are overlaying should be resized.

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
CONTAIN	The page keeps its aspect ratio, but is resized to fit within the given dimension.
COVER	The page keeps its aspect ratio and fills the given dimension.
FILL	The default.
NONE	The page is not resized.

Method Summary

Modifier and Type	Method	Description
static Configuration.OverlayFit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Configuration.OverlayFit[]	values()	Returns an array containing the constants of this enum type, 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

FILL

public static final Configuration.OverlayFit FILL

The default. The page is resized to fill the given dimension. If necessary, the page will be stretched or squished to fit.

COVER

public static final Configuration.OverlayFit COVER

The page keeps its aspect ratio and fills the given dimension. It will be clipped to fit.

CONTAIN

public static final Configuration.OverlayFit CONTAIN

The page keeps its aspect ratio, but is resized to fit within the given dimension.

NONE

public static final Configuration.OverlayFit NONE

The page is not resized. If necessary it will be clipped to fit.

Method Details

values

public static Configuration.OverlayFit[] values()

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

Returns:

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

valueOf

public static Configuration.OverlayFit 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