Foxit PDF SDK
com.foxit.sdk.addon.optimization.OptimizerSettings Class Reference
Inheritance diagram for com.foxit.sdk.addon.optimization.OptimizerSettings:
com.foxit.sdk.common.Base

Public Member Functions

 OptimizerSettings ()
 Constructor. More...
 
 OptimizerSettings (OptimizerSettings other)
 Constructor, with another result information object. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
void setCleanUpOptions (int clean_up_options) throws com.foxit.sdk.PDFException
 Set optimization related options for cleaning up. More...
 
void setColorGrayImageSettings (ImageSettings settings) throws com.foxit.sdk.PDFException
 Set optimization related settings for color/gray image. More...
 
void setDiscardObjectsOptions (int discard_objects_options) throws com.foxit.sdk.PDFException
 Set optimization related options for discarding objects. More...
 
void setDiscardUserDataOptions (int discard_userdata_options) throws com.foxit.sdk.PDFException
 Set optimization related options for discarding user data. More...
 
void setMonoImageSettings (MonoImageSettings settings) throws com.foxit.sdk.PDFException
 Set optimization related settings for monochrome image. More...
 
void setOptimizerOptions (int optimize_options) throws com.foxit.sdk.PDFException
 Set options to decide which kind of optimizer setting will be used for optimizing PDF document. More...
 
void setUnembeddedFontSettings (UnembeddedFontSettings settings) throws com.foxit.sdk.PDFException
 Set optimization related settings for unembedding fonts. More...
 
- Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void delete ()
 Clean up related resources immediately. More...
 

Static Public Attributes

static final int e_CleanUpRemoveInvalidBookmarks = 0x04
 Remove invalid bookmarks.
 
static final int e_CleanUpRemoveInvalidLinks = 0x08
 Remove invalid links.
 
static final int e_CleanUpUseFlateForNonEncodedStream = 0x01
 Use Flate to encode streams that are not encoded.
 
static final int e_CleanUpUseFlateInsteadOfLZW = 0x02
 In streams that use LZW encoding, use Flate instead.
 
static final int e_DiscardObjectsAlternateImages = 0x40
 Discard all alternate images. More...
 
static final int e_DiscardObjectsBookmarks = 0x20
 Discard bookmarks.
 
static final int e_DiscardObjectsDocumentTags = 0x80
 Discard document tags.
 
static final int e_DiscardObjectsEmbeddedPageThumbnails = 0x08
 Discard embedded page thumbnails.
 
static final int e_DiscardObjectsEmbeddedPrintSettings = 0x10
 Discard embedded print settings.
 
static final int e_DiscardObjectsEmbeddedSearchIndex = 0x100
 Discard embedded search index.
 
static final int e_DiscardObjectsFlattenFormFields = 0x02
 Flatten form fields.
 
static final int e_DiscardObjectsFormActions = 0x01
 Discard all form submission, import and reset actions.
 
static final int e_DiscardObjectsJavaScriptActions = 0x04
 Discard all JavaScript actions. More...
 
static final int e_DiscardUserDataAllAnnotsFormsAndMultimedia = 0x01
 Discard all annotations, forms and multimedia.
 
static final int e_DiscardUserDataDocumentInfoAndMetaData = 0x04
 Discard document information and metadata.
 
static final int e_DiscardUserDataExternalCrossReferences = 0x02
 Discard external cross references.
 
static final int e_DiscardUserDataFileAttchments = 0x08
 Discard file attachments.
 
static final int e_DiscardUserDataLayer = 0x20
 Discard hidden layer content and flatten visible layers.
 
static final int e_DiscardUserDataPrivateDataOfOtherApp = 0x10
 Discard private data of other applications.
 
static final int e_OptimizerCleanUp = 0x02
 Optimize PDF document by cleaning up.
 
static final int e_OptimizerCompressImages = 0x01
 Optimize PDF document by compressing images.
 
static final int e_OptimizerDiscardObjects = 0x04
 Optimize PDF document by discarding objects.
 
static final int e_OptimizerDiscardUserData = 0x10
 Optimize PDF document by discarding user data.
 
static final int e_OptimizerUnembeddedFonts = 0x08
 Optimize PDF document by unembedding some embedded fonts.
 

Detailed Description

This class represents settings for optimizing a PDF document. It would be used in class Optimizer .

See also
Optimizer

Constructor & Destructor Documentation

◆ OptimizerSettings() [1/2]

com.foxit.sdk.addon.optimization.OptimizerSettings.OptimizerSettings ( )

Constructor.

This constructor is to construct a optimizer settings object with default setting options. User can also calling "set" methods in this class to change setting options. Please refer to comment in other settings class (which can be set to current object) for more details about what default setting options are.

◆ OptimizerSettings() [2/2]

com.foxit.sdk.addon.optimization.OptimizerSettings.OptimizerSettings ( OptimizerSettings  other)

Constructor, with another result information object.

Parameters
[in]otherAnother optimizer settings object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.addon.optimization.OptimizerSettings.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ isEmpty()

boolean com.foxit.sdk.addon.optimization.OptimizerSettings.isEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ setCleanUpOptions()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setCleanUpOptions ( int  clean_up_options) throws com.foxit.sdk.PDFException

Set optimization related options for cleaning up.

For a newly constructed object, if this function is not called to set any clean-up options, that means not to do clean- up optimization. Clean-up options set by this function are useful only when option value com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerCleanUp is set by function OptimizerSettings.setOptimizerOptions .

Parameters
[in]clean_up_optionsOptimization related options for cleaning up. 0 means not to do clean-up optimization. Please refer to values starting from com.foxit.sdk.addon.optimization.OptimizerSettings.e_CleanUpUseFlateForNonEncodedStream and this can be one or a combination of these values.
Returns
None.

◆ setColorGrayImageSettings()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setColorGrayImageSettings ( ImageSettings  settings) throws com.foxit.sdk.PDFException

Set optimization related settings for color/gray image.

For a newly constructed object, if this function is not called to set any color/gray image settings, that means to use default color/gray image settings. Please refer to comment in class ImageSettings for default values.
ImageSettings set by this function is useful only when option value com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerCompressImages is set by function OptimizerSettings.setOptimizerOptions .

Parameters
[in]settingsOptimization related settings for color and grayscale images.
Returns
None.

◆ setDiscardObjectsOptions()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setDiscardObjectsOptions ( int  discard_objects_options) throws com.foxit.sdk.PDFException

Set optimization related options for discarding objects.

For a newly constructed object, if this function is not called to set any discard-objects options, that means not to do discard-objects optimization. Discard-objects options set by this function are useful only when option value com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerDiscardObjects is set by function OptimizerSettings.setOptimizerOptions .

Parameters
[in]discard_objects_optionsOptimization related options for discarding objects. 0 means not to do discarding-objects optimization. Please refer to values starting from com.foxit.sdk.addon.optimization.OptimizerSettings.e_DiscardObjectsFormActions and this can be one or a combination of these values.
Returns
None.

◆ setDiscardUserDataOptions()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setDiscardUserDataOptions ( int  discard_userdata_options) throws com.foxit.sdk.PDFException

Set optimization related options for discarding user data.

For a newly constructed object, if this function is not called to set any discard-userdata options, that means not to do discard-userdata optimization. Discard-userdata options set by this function are useful only when option value com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerDiscardUserData is set by function OptimizerSettings.setOptimizerOptions .

Parameters
[in]discard_userdata_optionsOptimization related options for discarding user data. 0 means not to do discarding-userdata optimization. Please refer to values starting from com.foxit.sdk.addon.optimization.OptimizerSettings.e_DiscardUserDataAllAnnotsFormsAndMultimedia and this can be one or a combination of these values.
Returns
None.

◆ setMonoImageSettings()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setMonoImageSettings ( MonoImageSettings  settings) throws com.foxit.sdk.PDFException

Set optimization related settings for monochrome image.

For a newly constructed object, if this function is not called to set any monochrome image settings, that means to use default monochrome image settings. Please refer to comment in class MonoImageSettings for detail values.
MonoImageSettings set by this function is useful only when option value com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerCompressImages is set by function OptimizerSettings.setOptimizerOptions .

Parameters
[in]settingsOptimization related settings for monochrome images.
Returns
None.

◆ setOptimizerOptions()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setOptimizerOptions ( int  optimize_options) throws com.foxit.sdk.PDFException

Set options to decide which kind of optimizer setting will be used for optimizing PDF document.

For a newly constructed object, if this function is not called to set any optimizer options, that means no optimizer setting is useful.

Parameters
[in]optimize_optionsThe options to decide which kind of optimizer setting will be used for optimizing PDF document. 0 means no optimizer setting of any kind is useful. Please refer to values starting from com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerCompressImages and this can be one or a combination of these values.
Returns
None.

◆ setUnembeddedFontSettings()

void com.foxit.sdk.addon.optimization.OptimizerSettings.setUnembeddedFontSettings ( UnembeddedFontSettings  settings) throws com.foxit.sdk.PDFException

Set optimization related settings for unembedding fonts.

For a newly constructed object, if this function is not called to set any unembedded fonts settings, that means to no font is to be unembedded. UnembeddedFontSettings set by this function is useful only when option value com.foxit.sdk.addon.optimization.OptimizerSettings.e_OptimizerUnembeddedFonts is set by function OptimizerSettings.setOptimizerOptions .

Parameters
[in]settingsOptimization related settings for unembedding fonts.
Returns
None.

Member Data Documentation

◆ e_DiscardObjectsAlternateImages

final int com.foxit.sdk.addon.optimization.OptimizerSettings.e_DiscardObjectsAlternateImages = 0x40
static

Discard all alternate images.

Some PDF documents include multiple versions of the same image for different purposes, such as low-resolution on-screen viewing and high-resolution printing. If this option value is set to be used, that means to remove all versions of an image except the one destined for on-screen viewing.

◆ e_DiscardObjectsJavaScriptActions

final int com.foxit.sdk.addon.optimization.OptimizerSettings.e_DiscardObjectsJavaScriptActions = 0x04
static

Discard all JavaScript actions.

Currently, it can not remove the javascript action in "OpenAction" of catalog.