Package org.jpedal.tools

Enum Class PdfMerge.MergeOption

java.lang.Object

java.lang.Enum<PdfMerge.MergeOption>

org.jpedal.tools.PdfMerge.MergeOption

All Implemented Interfaces:

Serializable, Comparable<PdfMerge.MergeOption>, Constable

Enclosing class:

PdfMerge

public static enum PdfMerge.MergeOption
extends Enum<PdfMerge.MergeOption>

MergeOption is a collection of optional features for PdfMerge that can be activated by providing a list of these values to the mergeFiles method

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
ADD_DIVIDING_PAGE	Add a blank page to the end of each file being merged with the same dimensions as the last merged page.
ADD_FOOTER	Add a footer to the bottom of each page.
INTERLEAVE	Merges all PDF pages in an interleaved fashion such that all the documents first pages will be added first, followed by subsequent pages.
NORMALISE_PAGE_SIZE_TO_MATCH_FIRST	Adjusts all pages in the merged result to match the size of the first page in the first document.
NORMALISE_ROTATION_TO_MATCH_FIRST	Adjusts all pages in the merged result to match the rotation of the first page in the first document.

Method Summary

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

INTERLEAVE

public static final PdfMerge.MergeOption INTERLEAVE

Merges all PDF pages in an interleaved fashion such that all the documents first pages will be added first, followed by subsequent pages. In cases where files do not have an identical number of pages, those that run out of pages early will stop being merged and interleave will continue with the remaining files.

ADD_DIVIDING_PAGE

public static final PdfMerge.MergeOption ADD_DIVIDING_PAGE

Add a blank page to the end of each file being merged with the same dimensions as the last merged page. This option does nothing if interleave is also provided as an option.

ADD_FOOTER

public static final PdfMerge.MergeOption ADD_FOOTER

Add a footer to the bottom of each page. The default footer displays the original files name and the original page number PdfMergeAttributes can be provided to PdfMerge and has methods to customise the appearance of the footer. see PdfMergeAttributes

NORMALISE_PAGE_SIZE_TO_MATCH_FIRST

public static final PdfMerge.MergeOption NORMALISE_PAGE_SIZE_TO_MATCH_FIRST

Adjusts all pages in the merged result to match the size of the first page in the first document.

NORMALISE_ROTATION_TO_MATCH_FIRST

public static final PdfMerge.MergeOption NORMALISE_ROTATION_TO_MATCH_FIRST

Adjusts all pages in the merged result to match the rotation of the first page in the first document.

Method Details

values

public static PdfMerge.MergeOption[] 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 PdfMerge.MergeOption 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