Package com.realobjects.pdfreactor

Class Configuration.MergeSettings

java.lang.Object

com.realobjects.pdfreactor.Configuration.MergeSettings

Enclosing class:

Configuration

public static final class Configuration.MergeSettings
extends Object

A type containing settings related to PDF merging.

Constructor Summary

Constructors

Constructor	Description
MergeSettings()

Method Summary

Modifier and Type	Method	Description
Configuration.MergeSettings	setDisableOverlayAnnotations(Boolean disableOverlayAnnotations)	If set to false, the annotations from the documents to be merged will not be included in the final document.
Configuration.MergeSettings	setDocuments(Configuration.Resource... documents)	This method sets external PDF documents which will be merged with the PDF document generated by the HTML source.
Configuration.MergeSettings	setMode(Configuration.MergeMode value)	Sets the merge mode.
Configuration.MergeSettings	setOverlayContentDocument(Configuration.OverlayContentDocument value)	Determines whether the converted document or the specified PDF document(s) is the content document for overlaying.
Configuration.MergeSettings	setOverlayFit(Configuration.OverlayFit value)	Determines how overlay pages that have different dimensions from the pages they are overlaying should be resized.
Configuration.MergeSettings	setOverlayRepeat(Configuration.OverlayRepeat value)	If one of the documents of an overlay process is shorter than the other, this method allows repeating either its last page or all of its pages in order to overlay all pages of the longer document.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MergeSettings

public MergeSettings()

Method Details

setMode

public Configuration.MergeSettings setMode(Configuration.MergeMode value)

Sets the merge mode.

The following merge methods can be used:

• append (Configuration.MergeMode.APPEND)
• prepend (Configuration.MergeMode.PREPEND)
• overlay above the content of the generated PDF (Configuration.MergeMode.OVERLAY)
• overlay below the content of the generated PDF (Configuration.MergeMode.OVERLAY_BELOW)

The default value is Configuration.MergeMode.APPEND.

Returns:

The current Configuration.MergeSettings instance.

See Also:

• Configuration.MergeMode.APPEND
• Configuration.MergeMode.PREPEND
• Configuration.MergeMode.OVERLAY
• Configuration.MergeMode.OVERLAY_BELOW
• Configuration.MergeMode.APPEND

setDocuments

public Configuration.MergeSettings setDocuments(Configuration.Resource... documents)

This method sets external PDF documents which will be merged with the PDF document generated by the HTML source.

Parameters:

documents - The documents.

Returns:

The current Configuration.MergeSettings instance.

setOverlayRepeat

public Configuration.MergeSettings setOverlayRepeat(Configuration.OverlayRepeat value)

If one of the documents of an overlay process is shorter than the other, this method allows repeating either its last page or all of its pages in order to overlay all pages of the longer document.

Use one of the Configuration.OverlayRepeat constants to specify the overlay repeat. The default value is Configuration.OverlayRepeat.NONE.

Returns:

The current Configuration.MergeSettings instance.

See Also:

• Configuration.OverlayRepeat.NONE

setOverlayFit

public Configuration.MergeSettings setOverlayFit(Configuration.OverlayFit value)

Determines how overlay pages that have different dimensions from the pages they are overlaying should be resized.

Use one of the Configuration.OverlayFit constants to specify the overlay fit. The default value is is Configuration.OverlayFit.FILL.

Returns:

The current Configuration.MergeSettings instance.

See Also:

• Configuration.OverlayFit.FILL

setOverlayContentDocument

public Configuration.MergeSettings setOverlayContentDocument(Configuration.OverlayContentDocument value)

Determines whether the converted document or the specified PDF document(s) is the content document for overlaying. The size of each overlaid page is taken from the content document, while the other is fit to that. Also PDF tags, if any, are only taken from the content document.

Use one of the Configuration.OverlayContentDocument constants to specify the overlay content document. The default value is is Configuration.OverlayContentDocument.CONVERTED.

Returns:

The current Configuration.MergeSettings instance.

See Also:

• Configuration.OverlayContentDocument.CONVERTED

setDisableOverlayAnnotations

public Configuration.MergeSettings setDisableOverlayAnnotations(Boolean disableOverlayAnnotations)

If set to false, the annotations from the documents to be merged will not be included in the final document.

This is automatically disabled when a Conformance level other than Configuration.Conformance.PDF is specified

Returns:

The current Configuration.MergeSettings instance.

See Also:

• Configuration.Conformance