com.datalogics.PDFL

Enum OptimizerOption

java.lang.Object

java.lang.Enum<OptimizerOption>

com.datalogics.PDFL.OptimizerOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OptimizerOption>

public enum OptimizerOption
extends java.lang.Enum<OptimizerOption>

Select the optimization option to be set or obtained.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPRESS_DOCUMENT_STRUCTURE When this option is ON, compress the actual PDF object stream.
COMPRESS_STREAMS When this option is ON, any streams (of more than 20 bytes length) which are not compressed will be compressed using Flate.
DISCARD_ACROFORMS When this option is ON, All acroform structures will be removed from the document.
DISCARD_ALTERNATE_IMAGES When this option is ON, any Alternate Images defined for a given image (Images in different resolutions than the base image) will be discarded.
DISCARD_ANNOTATIONS When this option is ON, remove all annotations, of all types, from all pages.
DISCARD_ASCIIFILTERS When this option is ON, remove the ASCIIHex and ASCII85 filters from any streams that use these as their final filters.
DISCARD_BOOKMARKS When this option is ON, all bookmarks will be removed from the document.
DISCARD_COMMENTS When this option is ON, remove all annotations which are commentary to the content (All "Markup" annotations).
DISCARD_DOCUMENT_INFO When this option is ON, any Document Information, beyond the basic information supplied by APDFL, will be discarded.
DISCARD_DUPLICATE_FORMS When this option is ON, locate and remove duplicate copies of forms, using a single copy for all references to that form.
DISCARD_FILE_ATTACHMENTS When this option is ON, remove any document embedded in the PDF Document.
DISCARD_JAVA_SCRIPT_ACTIONS When this option is ON, remove all JavaScript actions in the document.
DISCARD_METADATA When this option is ON, any Metadata embedded in the document (Except for the document level Metadata) will be removed.
DISCARD_NAME_TRESS When this option is ON, discard any NameTrees in the document.
DISCARD_OUTPUT_INTENT When this option is ON, any OutputIntent structures in the document, along with their associated color profiles, will be removed.
DISCARD_PAGE_LABELS When this option is ON, discard any Page Label Trees embedded in the document This may cause a difference in the display and selection of pages in some viewers.
DISCARD_PIECE_DATA When this option is ON, remove any user supplied private PieceData embedded in the document.
DISCARD_STRUCTURE_TREES When this option is ON, discard any structure trees in the document.
DISCARD_THUMBNAILS When this option is ON, any thumbnails embedded in the document will be removed.
DISCARD_UNUSED_FONTS When this option is ON, remove any Fonts which are included in the document, but never used in the document.
DISCARD_UNUSED_FORMS When this option is ON, remove any Forms XObjects which are included in the document, but never displayed in the document.
DISCARD_UNUSED_IMAGES When this option is ON, remove any Image XObjects which are included in the document, but never displayed in the document.
DISCARD_XMPPADDING When this option is ON, remove from the XMP Metadata any padding areas, left to allow the XMP data to be updated.
DOWN_CONVERT_16_TO_8BPC_IMAGES When this option is ON, down-converts all 16 Bits Per Component images to 8 Bits Per Component.
DOWNSAMPLE_BW When this option is ON, Downsample all Black and White images above MAX DPI to ResetTo DPI.
DOWNSAMPLE_COLOR When this option is ON, Downsample all color images above MAX DPI to ResetTo DPI.
DOWNSAMPLE_GRAY When this option is ON, Downsample all gray scale images above MAX DPI to ResetTo DPI.
FLATTEN_OPTIONAL_CONTENT When this option is ON, Optional Content in the document is Flattened.
LINEARIZE When this option is ON, create the optimized document as Linearized (Optimized for Web Access).
MERGE_DUPLICATE_FONTS When this option is ON, the document will be searched for mutliple copies of the same font.
OPTIMIZE_CONTENT_STREAMS When this option is ON, attempt to find common segments of code at the start of page content, and share a single copy of such common code.
RE_SUBSET_ALL_SUBSET_FONTS When this option is ON, any fonts which are subset embedded, will be replaced with a newly subset font.
RECOMPRESS_BW When this option is ON, recompress all Black and White images which are compressed by a different scheme than one select by RecompressTo to RecompressTo.
RECOMPRESS_COLOR When this option is ON, recompress all color images which are compressed by a different scheme than one select by RecompressTo to RecompressTo.
RECOMPRESS_GRAY When this option is ON, recompress all gray scale images which are compressed by a different scheme than one select by RecompressTo to RecompressTo.
RECOMPRESS_ONLY_IF_SMALLER In all of the above Downsample and Recompress operations, if this option is ON, replace the image ONLY if the resultant compressed image is smaller than the original.
REMOVE_ALL_BASE_14_FONTS This will remove any embedded base 14 fonts.
REMOVE_ALL_EMBEDDED_FONTS When this option is ON, all embedded fonts will be removed.
REPLACE_LZW When this option is ON, any LZW Compressed streams will be recompressed using Flate.
SUBSET_ALL_EMBEDDED_FONTS When this option is ON, any fonts which are embedded, but not subset, will be replaced with subset fonts.

Method Summary

Modifier and Type	Method and Description
static OptimizerOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OptimizerOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOWNSAMPLE_COLOR

public static final OptimizerOption DOWNSAMPLE_COLOR

When this option is ON, Downsample all color images above MAX DPI to ResetTo DPI. Default is ON.

RECOMPRESS_COLOR

public static final OptimizerOption RECOMPRESS_COLOR

When this option is ON, recompress all color images which are compressed by a different scheme than one select by RecompressTo to RecompressTo. Default is ON.

DOWNSAMPLE_GRAY

public static final OptimizerOption DOWNSAMPLE_GRAY

When this option is ON, Downsample all gray scale images above MAX DPI to ResetTo DPI. Default is ON.

RECOMPRESS_GRAY

public static final OptimizerOption RECOMPRESS_GRAY

When this option is ON, recompress all gray scale images which are compressed by a different scheme than one select by RecompressTo to RecompressTo. Default is ON.

DOWNSAMPLE_BW

public static final OptimizerOption DOWNSAMPLE_BW

When this option is ON, Downsample all Black and White images above MAX DPI to ResetTo DPI. Default is ON.

RECOMPRESS_BW

public static final OptimizerOption RECOMPRESS_BW

When this option is ON, recompress all Black and White images which are compressed by a different scheme than one select by RecompressTo to RecompressTo. Default is ON.

RECOMPRESS_ONLY_IF_SMALLER

public static final OptimizerOption RECOMPRESS_ONLY_IF_SMALLER

In all of the above Downsample and Recompress operations, if this option is ON, replace the image ONLY if the resultant compressed image is smaller than the original. Default is ON.

DISCARD_ALTERNATE_IMAGES

public static final OptimizerOption DISCARD_ALTERNATE_IMAGES

When this option is ON, any Alternate Images defined for a given image (Images in different resolutions than the base image) will be discarded. Default is ON.

SUBSET_ALL_EMBEDDED_FONTS

public static final OptimizerOption SUBSET_ALL_EMBEDDED_FONTS

When this option is ON, any fonts which are embedded, but not subset, will be replaced with subset fonts. This can save considerable space in a document, but does so at the risk of preventing future edits to the document. Default is ON.

RE_SUBSET_ALL_SUBSET_FONTS

public static final OptimizerOption RE_SUBSET_ALL_SUBSET_FONTS

When this option is ON, any fonts which are subset embedded, will be replaced with a newly subset font. This will generally only happen if the document has been edited since it was created, or the document contains only a subset of the page that it originally contained. NOTE: This can only REMOVE glyphs from the subset font. It cannot add glyphs that were not present int he original subset. Default is ON.

REMOVE_ALL_EMBEDDED_FONTS

public static final OptimizerOption REMOVE_ALL_EMBEDDED_FONTS

When this option is ON, all embedded fonts will be removed. If this is done, the document can only be viewed on platforms which contain all of the fonts required. Generally, you would want to do this only in very tightly controlled circumstances. Default is OFF.

REMOVE_ALL_BASE_14_FONTS

public static final OptimizerOption REMOVE_ALL_BASE_14_FONTS

This will remove any embedded base 14 fonts. Generally, it is safe to remove these fonts, as any platform that supports PDF should have locally available copies of them. However, there is still some risk that the embedded fonts are not identical to the actual base14 fonts, and hence may render differently. Default is OFF.

MERGE_DUPLICATE_FONTS

public static final OptimizerOption MERGE_DUPLICATE_FONTS

When this option is ON, the document will be searched for mutliple copies of the same font. These will then be combined into a single font. Default is ON.

DISCARD_BOOKMARKS

public static final OptimizerOption DISCARD_BOOKMARKS

When this option is ON, all bookmarks will be removed from the document. Note that this information cannot be reconstructed. Default is OFF.

DISCARD_ACROFORMS

public static final OptimizerOption DISCARD_ACROFORMS

When this option is ON, All acroform structures will be removed from the document. NOTE: Filled in fields, if any, will be left in the document. So the content of those fields will continue to display. Default is ON.

DISCARD_OUTPUT_INTENT

public static final OptimizerOption DISCARD_OUTPUT_INTENT

When this option is ON, any OutputIntent structures in the document, along with their associated color profiles, will be removed. This may cause color shifting, when rendering the document. Default is OFF.

DISCARD_THUMBNAILS

public static final OptimizerOption DISCARD_THUMBNAILS

When this option is ON, any thumbnails embedded in the document will be removed. Default is ON.

DISCARD_PAGE_LABELS

public static final OptimizerOption DISCARD_PAGE_LABELS

When this option is ON, discard any Page Label Trees embedded in the document This may cause a difference in the display and selection of pages in some viewers. Default is ON.

DISCARD_NAME_TRESS

public static final OptimizerOption DISCARD_NAME_TRESS

When this option is ON, discard any NameTrees in the document. This may cause issues with links within the document. Default is ON.

DISCARD_STRUCTURE_TREES

public static final OptimizerOption DISCARD_STRUCTURE_TREES

When this option is ON, discard any structure trees in the document. Default is OFF.

DISCARD_FILE_ATTACHMENTS

public static final OptimizerOption DISCARD_FILE_ATTACHMENTS

When this option is ON, remove any document embedded in the PDF Document. Default is ON.

DISCARD_XMPPADDING

public static final OptimizerOption DISCARD_XMPPADDING

When this option is ON, remove from the XMP Metadata any padding areas, left to allow the XMP data to be updated. Default is ON.

DISCARD_UNUSED_FORMS

public static final OptimizerOption DISCARD_UNUSED_FORMS

When this option is ON, remove any Forms XObjects which are included in the document, but never displayed in the document. Default is ON.

DISCARD_PIECE_DATA

public static final OptimizerOption DISCARD_PIECE_DATA

When this option is ON, remove any user supplied private PieceData embedded in the document. This will never effect appearance, but may limit the use of special processing by the application that provided this data. Default is ON.

COMPRESS_STREAMS

public static final OptimizerOption COMPRESS_STREAMS

When this option is ON, any streams (of more than 20 bytes length) which are not compressed will be compressed using Flate. Default is ON.

REPLACE_LZW

public static final OptimizerOption REPLACE_LZW

When this option is ON, any LZW Compressed streams will be recompressed using Flate. Default is ON.

DISCARD_METADATA

public static final OptimizerOption DISCARD_METADATA

When this option is ON, any Metadata embedded in the document (Except for the document level Metadata) will be removed. Default is OFF.

DISCARD_DOCUMENT_INFO

public static final OptimizerOption DISCARD_DOCUMENT_INFO

When this option is ON, any Document Information, beyond the basic information supplied by APDFL, will be discarded. Note that this will also remove that information from the document level Metadata. Default is OFF.

OPTIMIZE_CONTENT_STREAMS

public static final OptimizerOption OPTIMIZE_CONTENT_STREAMS

When this option is ON, attempt to find common segments of code at the start of page content, and share a single copy of such common code. Default is ON.

LINEARIZE

public static final OptimizerOption LINEARIZE

When this option is ON, create the optimized document as Linearized (Optimized for Web Access). Default is OFF.

COMPRESS_DOCUMENT_STRUCTURE

public static final OptimizerOption COMPRESS_DOCUMENT_STRUCTURE

When this option is ON, compress the actual PDF object stream. This should not be used for documents which must be rendered on older PDF rendering engines. Default is ON.

DISCARD_DUPLICATE_FORMS

public static final OptimizerOption DISCARD_DUPLICATE_FORMS

When this option is ON, locate and remove duplicate copies of forms, using a single copy for all references to that form. Default is ON.

DISCARD_ASCIIFILTERS

public static final OptimizerOption DISCARD_ASCIIFILTERS

When this option is ON, remove the ASCIIHex and ASCII85 filters from any streams that use these as their final filters. These have historically been used to render data safe in a 7 bit data channel, or for debugging purposes Default is ON.

DISCARD_COMMENTS

public static final OptimizerOption DISCARD_COMMENTS

When this option is ON, remove all annotations which are commentary to the content (All "Markup" annotations). Default is OFF.

DISCARD_ANNOTATIONS

public static final OptimizerOption DISCARD_ANNOTATIONS

When this option is ON, remove all annotations, of all types, from all pages. This may result in visible loss of information in the rendered pages. Default is OFF.

DISCARD_JAVA_SCRIPT_ACTIONS

public static final OptimizerOption DISCARD_JAVA_SCRIPT_ACTIONS

When this option is ON, remove all JavaScript actions in the document. Default is OFF.

FLATTEN_OPTIONAL_CONTENT

public static final OptimizerOption FLATTEN_OPTIONAL_CONTENT

When this option is ON, Optional Content in the document is Flattened. Default is OFF.

DOWN_CONVERT_16_TO_8BPC_IMAGES

public static final OptimizerOption DOWN_CONVERT_16_TO_8BPC_IMAGES

When this option is ON, down-converts all 16 Bits Per Component images to 8 Bits Per Component. Default is ON.

DISCARD_UNUSED_IMAGES

public static final OptimizerOption DISCARD_UNUSED_IMAGES

When this option is ON, remove any Image XObjects which are included in the document, but never displayed in the document. Default is ON.

DISCARD_UNUSED_FONTS

public static final OptimizerOption DISCARD_UNUSED_FONTS

When this option is ON, remove any Fonts which are included in the document, but never used in the document. Default is ON.

Method Detail

values

public static OptimizerOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OptimizerOption c : OptimizerOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OptimizerOption valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null