Package com.pdftools.pdf

Class OutputOptions

java.lang.Object

com.pdftools.internal.NativeBase

com.pdftools.internal.NativeObject

com.pdftools.pdf.OutputOptions

Direct Known Subclasses:

OutputOptions

public class OutputOptions
extends NativeObject

The parameters for document-level features of output PDFs

Output options are used in many operations that create PDF documents.

Constructor Summary

Constructors

Constructor	Description
OutputOptions()

Method Summary

Modifier and Type	Method	Description
Encryption	getEncryption()	The parameters to encrypt output PDFs (Getter)
boolean	getLinearize()	Whether to linearize the output document (Getter)
MetadataSettings	getMetadataSettings()	Default: null, metadata are copied to the output document.
void	setEncryption(Encryption value)	The parameters to encrypt output PDFs (Setter)
void	setLinearize(boolean value)	Whether to linearize the output document (Setter)
void	setMetadataSettings(MetadataSettings value)	Default: null, metadata are copied to the output document.

Methods inherited from class com.pdftools.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputOptions

public OutputOptions()

Method Detail

getEncryption

public Encryption getEncryption()

The parameters to encrypt output PDFs (Getter)

If null, no encryption is used.

Encryption is not allowed by the PDF/A ISO standards. For that reason, it is recommended to use null when processing PDF/A documents. Otherwise, most operations will remove PDF/A conformance from the output document. More details can be found in the documentation of the operation.

Default: null, no encryption is used.

setEncryption

public void setEncryption(Encryption value)

The parameters to encrypt output PDFs (Setter)

If null, no encryption is used.

Encryption is not allowed by the PDF/A ISO standards. For that reason, it is recommended to use null when processing PDF/A documents. Otherwise, most operations will remove PDF/A conformance from the output document. More details can be found in the documentation of the operation.

Default: null, no encryption is used.

getMetadataSettings

public MetadataSettings getMetadataSettings()

Default: null, metadata are copied to the output document.

setMetadataSettings

public void setMetadataSettings(MetadataSettings value)

Default: null, metadata are copied to the output document.

getLinearize

public boolean getLinearize()

Whether to linearize the output document (Getter)

If true, the output document is written in a linearized form ("Fast Web View"), so that a conforming viewer can display the first page before the entire file has been loaded.

Note: This property is applied by operations that write the output PDF, such as pdftools.documentassembly.DocumentAssembler.assemble, pdftools.optimization.Optimizer.optimizeDocument and pdftools.pdfa.conversion.Converter.convert. The signing operations of pdftools.sign.Signer apply it where supported, but not when existing signatures must be preserved: such documents are signed using an incremental update, which is incompatible with linearization. The property has no effect for other operations, such as image-to-PDF conversion (pdftools.image2pdf.Converter) and optical character recognition (pdftools.ocr.Processor).

Default: false

setLinearize

public void setLinearize(boolean value)

Whether to linearize the output document (Setter)

If true, the output document is written in a linearized form ("Fast Web View"), so that a conforming viewer can display the first page before the entire file has been loaded.

Note: This property is applied by operations that write the output PDF, such as pdftools.documentassembly.DocumentAssembler.assemble, pdftools.optimization.Optimizer.optimizeDocument and pdftools.pdfa.conversion.Converter.convert. The signing operations of pdftools.sign.Signer apply it where supported, but not when existing signatures must be preserved: such documents are signed using an incremental update, which is incompatible with linearization. The property has no effect for other operations, such as image-to-PDF conversion (pdftools.image2pdf.Converter) and optical character recognition (pdftools.ocr.Processor).

Default: false