PDFOptimizer Class Documentation

class PDFOptimizer

Namespace:com::datalogics::PDFL

Detailed Description

Implementation of the PDF Optimizer function. Use the PDFOptimizer object to accumulate options for the Optimization, and to Optimize documents.

Constructor & Destructor Documentation

PDFOptimizer

PDFOptimizer()

Construct a CPDFOptimizer, with default Options.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getCompressionQuality

CompressQuality getCompressionQuality(CompressImageType type)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to query.

Returns:

CompressQuality

The compression quality level for the specified color model.

Get the value of the Compression Quality for a given color model.

getMajorVersion

short getMajorVersion()

Returns:

short

The major PDF version number, or 0 if the Optimizer will decide.

Get the value of the Major Version of the optimized document.

getMaxResolution

int getMaxResolution(CompressImageType type)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to query.

Returns:

int

The maximum resolution in DPI above which images will be downsampled.

Get the value of the Max DPI for a given color model.

getMinorVersion

short getMinorVersion()

Returns:

short

The minor PDF version number.

Get the value of the Minor Version of the optimized document.

getObjectCompression

ObjectCompressionType getObjectCompression()

Returns:

ObjectCompressionType

The current object compression type setting.

Get the value of the Object Compression of the optimized document.

getOption

boolean getOption(OptimizerOption option)

Parameters

option: OptimizerOption

The optimization option to query.

Returns:

boolean

true if the option is enabled, false if it is disabled.

Get the value of a single Optimizer Option.

getRecompressionType

CompressionType getRecompressionType(CompressImageType type)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to query.

Returns:

CompressionType

The compression type that will be applied to images of the specified color model.

Get the value of the Recompression Type for a given color model.

getResampleToResolution

int getResampleToResolution(CompressImageType type)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to query.

Returns:

int

The target resolution in DPI to which images will be downsampled.

Get the value of the Resample To DPI for a given color model.

optimize

void optimize(Document doc, javax.imageio.stream.ImageOutputStream stream)

Parameters

doc: Document
stream: javax.imageio.stream.ImageOutputStream

Returns:

void

optimize

void optimize(Document document, JavaStreamFile dest)

Parameters

document: Document

The document to optimize.

dest: JavaStreamFile

The stream file handle to write the optimized document to.

Returns:

void

Perform the Optimization of a single document, saving the result to a stream.

optimize

void optimize(Document document, JavaStreamFile dest, ProgressMonitor progressMonitor, CancelProc cancelProc)

Parameters

document: Document

The document to optimize.

dest: JavaStreamFile

The stream file handle to write the optimized document to.

progressMonitor: ProgressMonitor

An optional progress monitor callback, or NULL.

cancelProc: CancelProc

An optional cancellation callback, or NULL.

Returns:

void

Perform the Optimization of a single document, saving the result to a stream.

optimize

void optimize(Document document, String newPath)

Parameters

document: Document

The document to optimize.

newPath: String

The file system path where the optimized document will be saved.

Returns:

void

Perform the Optimization of a single document, saving the result in a new file.

optimize

void optimize(Document document, String newPath, ProgressMonitor progressMonitor, CancelProc cancelProc)

Parameters

document: Document

The document to optimize.

newPath: String

The file system path where the optimized document will be saved.

progressMonitor: ProgressMonitor

An optional progress monitor callback, or NULL.

cancelProc: CancelProc

An optional cancellation callback, or NULL.

Returns:

void

Perform the Optimization of a single document, saving the result in a new file.

setCompressionQuality

void setCompressionQuality(CompressImageType type, CompressQuality value)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to set.

value: CompressQuality

The compression quality level to apply.

Returns:

void

Set the value for the Compression Quality for a given color model. Any image that recompressed, regardless of the reason, will use this Quality for the Quality value of the specific compression type.

setMajorVersion

void setMajorVersion(short major)

Parameters

major: short

The major PDF version number.

Returns:

void

Set the value for the Major Version for the optimized document.

setMaxResolution

void setMaxResolution(CompressImageType type, int value)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to set.

value: int

The maximum resolution in DPI.

Returns:

void

Set the value for the Max DPI for a given color model. Any image above this resolution will be down sampled, if the Downsampling option is true for this color model.

setMinorVersion

void setMinorVersion(short minor)

Parameters

minor: short

The minor PDF version number.

Returns:

void

Set the value for the Minor Version for the optimized document.

setObjectCompression

void setObjectCompression(ObjectCompressionType objectCompression)

Parameters

objectCompression: ObjectCompressionType

The desired object compression type.

Returns:

void

Set the value for the Object Compression for the optimized document.

setOption

void setOption(OptimizerOption option, boolean value)

Parameters

option: OptimizerOption

The optimization option to set.

value: boolean

true to enable the option, false to disable it.

Returns:

void

Set the value of a single Optimizer option.

setRecompressionType

void setRecompressionType(CompressImageType type, CompressionType value)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to set.

value: CompressionType

The compression type to apply.

Returns:

void

Set the value for the recompression Type for a given color model. Any image that is downsampled will be compressed using this method, if the Downsampling option is true for this color model. Any image that is not downsampled, will be converted to this compression type, if it is not already compressed in this type, and the Recompression option for this color model is true.

setResampleToResolution

void setResampleToResolution(CompressImageType type, int value)

Parameters

type: CompressImageType

The image color type (Color, Gray, or BW) to set.

value: int

The target resolution in DPI.

Returns:

void

Set the value for the Resample To DPI for a given color model. Any image will be downsampled to this resolution, if the Downsampling option is true for this color model.