com.qoppa.pdfPreflight.profiles

Class PDFXConversionOptions

java.lang.Object

com.qoppa.pdfPreflight.profiles.ConversionOptions

com.qoppa.pdfPreflight.profiles.PDFXConversionOptions

public class PDFXConversionOptions
extends ConversionOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PDFXConversionOptions.SubstituteFontRecord Defines a font substitution record.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CO_FLATE Compress image using Flate compression.
static int	CO_JPEG Compress image to JPEG.
static int	OPTION_DELETE Delete the objects when encountered.
static int	OPTION_FLATTEN Flatten Annotation.
static int	OPTION_NO_FLATTEN Do not flatten annotation.
static int	OPTION_OPAQUE Convert transparency to opaque.
static int	OPTION_WARN Add a warning record to the results when encountered.

Constructor Summary

Constructors

Constructor and Description
PDFXConversionOptions()

Method Summary

Modifier and Type	Method and Description
int	getEmbeddedFiles() Returns the option set to decide what to do with embedded files.
int	getImageCompression()
int	getInvalidAnnotations() Returns the option set to decide what to do with invalid annotations (generally due to being inside printable bounds).
Map<String,PDFXConversionOptions.SubstituteFontRecord>	getSubstituteFontsMap()
int	getTransparency() Returns the option set to decide what to do with transparency.
void	setEmbeddedFiles(int embeddedFiles) Set the option to decide what to do with embedded files.
void	setFontSubstitute(String origFontFamily, String substituteFontFamily, boolean preferSubstitute) Creates a SubstituteFontRecord instance and maps it to the origFontFamily see setSubstituteFontsMap(Map).
void	setImageCompression(int imageComp) Sets the image compression to use when an image has to be re-compressed.
void	setInvalidAnnotations(int invalidAnnotations) Set the option to decide what to do with invalid annotations.
void	setSubstituteFontsMap(Map<String,PDFXConversionOptions.SubstituteFontRecord> fontNameSubstitutions) Sets a map of font family names to substitute font family names.
void	setTransparency(int transparency) Set the option to decide what to do with transparecny.

Methods inherited from class com.qoppa.pdfPreflight.profiles.ConversionOptions

isClearSignatures, isClearUsageRights, setClearSignatures, setClearUsageRights

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_DELETE

public static final int OPTION_DELETE

Delete the objects when encountered.

See Also:

Constant Field Values

OPTION_WARN

public static final int OPTION_WARN

Add a warning record to the results when encountered.

See Also:

Constant Field Values

OPTION_OPAQUE

public static final int OPTION_OPAQUE

Convert transparency to opaque.

See Also:

Constant Field Values

OPTION_FLATTEN

public static final int OPTION_FLATTEN

Flatten Annotation. I.e., merge the annotations normal appearance stream with the page's appearance stream and remove the annotation.

See Also:

Constant Field Values

OPTION_NO_FLATTEN

public static final int OPTION_NO_FLATTEN

Do not flatten annotation.

See Also:

Constant Field Values

CO_JPEG

public static final int CO_JPEG

Compress image to JPEG.

See Also:

Constant Field Values

CO_FLATE

public static final int CO_FLATE

Compress image using Flate compression.

See Also:

Constant Field Values

Constructor Detail

PDFXConversionOptions

public PDFXConversionOptions()

Method Detail

setImageCompression

public void setImageCompression(int imageComp)

Sets the image compression to use when an image has to be re-compressed. This can happen when the image colors have to be converted, or when the image compression used is not valid for PDF/X. For images that do not have to be converted, the image is not modified and this setting is not used.

Parameters:

imageComp -

getImageCompression

public int getImageCompression()

getTransparency

public int getTransparency()

Returns the option set to decide what to do with transparency.

Returns:

The current value of the settings, can be OPTION_OPAQUE or OPTION_WARN.

setTransparency

public void setTransparency(int transparency)

Set the option to decide what to do with transparecny. Default is OPTION_OPAQUE.

Parameters:

transparency - Can be OPTION_OPAQUE or OPTION_WARN.

getInvalidAnnotations

public int getInvalidAnnotations()

Returns the option set to decide what to do with invalid annotations (generally due to being inside printable bounds).

Returns:

The current value of the settings, can be OPTION_DELETE, OPTION_FLATTEN, or OPTION_WARN.

setInvalidAnnotations

public void setInvalidAnnotations(int invalidAnnotations)

Set the option to decide what to do with invalid annotations. Default is OPTION_DELETE.

Parameters:

invalidAnnotations - Can be OPTION_DELETE, OPTION_FLATTEN, or OPTION_WARN.

setSubstituteFontsMap

public void setSubstituteFontsMap(Map<String,PDFXConversionOptions.SubstituteFontRecord> fontNameSubstitutions)

Sets a map of font family names to substitute font family names. The mapped font families are mapped to SubstituteFontRecord instances which specify both the substitute family name and whether the substitute should be preferred when both the original and the substitute fonts happen to be available on the local system. If the substitute font family is available on the local system and the original font family is not then the substitute will be used regardless of the isPreferred flag. If both fonts are available the substitute will only be used if the SubstituteFontRecord.isPreferred() returns true.
Among other cases, mapping substitute fonts can be especially useful on Linux or other non-Microsoft systems when converting Microsoft Office documents creating with proprietary Microsoft fonts by mapping Microsoft fonts to metric-compatible alternatives. For, the free open source font "Carlito" is a metric compatible alternative to the proprietary Microsoft font called "Calibri".

The String instances used in the Map should represent font family names, rather than full face names.

Parameters:

fontNameSubstitutions - - a Map where the key values are the fonts used in an Office document and the values are the respective fonts to be used in PDF conversion.

getSubstituteFontsMap

public Map<String,PDFXConversionOptions.SubstituteFontRecord> getSubstituteFontsMap()

Returns:

an unmodifiable view of the font substitution map

see setSubstituteFontsMap(Map).

setFontSubstitute

public void setFontSubstitute(String origFontFamily,
                              String substituteFontFamily,
                              boolean preferSubstitute)

Creates a SubstituteFontRecord instance and maps it to the origFontFamily
see setSubstituteFontsMap(Map).

Parameters:

origFontFamily - - should be the font family name of a font to set a SubstituteFontRecord for

substituteFontFamily - - should be the name of the substitute font family to use for origFontFamily

preferSubstitute - - whether the substitute should be used even if the origFontFamily is available

getEmbeddedFiles

public int getEmbeddedFiles()

Returns the option set to decide what to do with embedded files.

Returns:

The current value of the settings, can be OPTION_DELETE or OPTION_WARN.

setEmbeddedFiles

public void setEmbeddedFiles(int embeddedFiles)

Set the option to decide what to do with embedded files. Default is OPTION_DELETE.

Parameters:

embeddedFiles - Can be OPTION_DELETE or OPTION_WARN.