Foxit PDF SDK

Public Member Functions | Static Public Attributes | List of all members
com.foxit.sdk.addon.compliance.PDFXCompliance Class Reference
Inheritance diagram for com.foxit.sdk.addon.compliance.PDFXCompliance:

## Public Member Functions
| PDFXCompliance ()
| Constructor.
| PDFXCompliance (PDFXCompliance other)
| Constructor, with another PDF/X compliance object. More...
ResultInformation | convertPDFFile (String src_pdf_path, String saved_pdf_path, int convert_to_version, int view_or_print_condition, boolean to_convert_rgb_or_lab, boolean to_decalibrate_gray_or_cmyk, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
| Convert a PDF file with specified PDF/X version. More...
synchronized void | delete ()
| Clean up related C++ resources immediately. More...
boolean | isEmpty ()
| Check whether current object is empty or not. More...
ResultInformation | verify (int verify_version, String src_pdf_path, int first_page_index, int last_page_index, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
| Verify a PDF file with specified PDF/X version. More...

## Static Public Attributes
static final int | e_VersionPDFX1a = 0
| PDF/X-1a.
static final int | e_VersionPDFX1aCoatedGRACoL2006 = 4
| PDF/X-1a (Coated GRACoL 2006).
static final int | e_VersionPDFX1aISOCoatedv2ECI = 5
| PDF/X-1a (ISO Coated v2 (ECI)).
static final int | e_VersionPDFX1aJapanColor2001Coated = 6
| PDF/X-1a (Japan Color 2001 Coated).
static final int | e_VersionPDFX1aPSOCoatedv3ECI = 7
| PDF/X-1a (PSO Coated v3 (ECI)).
static final int | e_VersionPDFX3 = 1
| PDF/X-3.
static final int | e_VersionPDFX3CoatedGRACoL2006 = 8
| PDF/X-3 (Coated GRACoL 2006).
static final int | e_VersionPDFX3ISOCoatedv2ECI = 9
| PDF/X-3 (ISO Coated v2 (ECI)).
static final int | e_VersionPDFX3JapanColor2001Coated = 10
| PDF/X-3 (Japan Color 2001 Coated).
static final int | e_VersionPDFX3PSOCoatedv3ECI = 11
| PDF/X-3 (PSO Coated v3 (ECI)).
static final int | e_VersionPDFX4 = 2
| PDF/X-4.
static final int | e_VersionPDFX4AndCLLVISOCoatedv2ECI = 16
| PDF/X-4 and create language layer views (ISO Coated v2 (ECI))).
static final int | e_VersionPDFX4CoatedGRACoL2006 = 12
| PDF/X-4 (Coated GRACoL 2006).
static final int | e_VersionPDFX4ISOCoatedv2ECI = 13
| PDF/X-4 (ISO Coated v2 (ECI)).
static final int | e_VersionPDFX4JapanColor2001Coated = 14
| PDF/X-4 (Japan Color 2001 Coated).
static final int | e_VersionPDFX4p = 3
| PDF/X-4p.
static final int | e_VersionPDFX4PSOCoatedv3ECI = 15
| PDF/X-4 (PSO Coated v3 (ECI)).

## Detailed Description

This class can be used for PDF/X compliance verification or converting a PDF file to a PDF/X format. Please ensure ComplianceEngine has been initialized successfully.

See also
  ComplianceEngine

## Constructor & Destructor Documentation

## ◆ PDFXCompliance()

com.foxit.sdk.addon.compliance.PDFXCompliance.PDFXCompliance | ( | PDFXCompliance | other | ) |

Constructor, with another PDF/X compliance object.

Parameters

  [in] | other | Another PDF/X compliance object.

## Member Function Documentation

## ◆ convertPDFFile()

ResultInformation com.foxit.sdk.addon.compliance.PDFXCompliance.convertPDFFile | ( | String | src_pdf_path,
|  | String | saved_pdf_path,
|  | int | convert_to_version,
|  | int | view_or_print_condition,
|  | boolean | to_convert_rgb_or_lab,
|  | boolean | to_decalibrate_gray_or_cmyk,
|  | ProgressCallback | progress_callback
| ) |  | throws com.foxit.sdk.PDFException

Convert a PDF file with specified PDF/X version.

Parameters

  [in] | src_pdf_path | A complete path of source PDF file to be converted. This should not be an empty string.
  [in] | saved_pdf_path | A complete path for saving the converted PDF file. This should not be an empty string.
  [in] | convert_to_version | PDF/X version to convert. Please refer to values starting from com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1a and this should be one of these values.
  [in] | view_or_print_condition | Viewing or printing condition. Please refer to values starting from com.foxit.sdk.addon.compliance.ComplianceEngine.e_ViewOrPrintConditionAuto and this should be one of these values.
  [in] | to_convert_rgb_or_lab | Whether to convert device independ RGB or Lab color into destination color space. true means to convert, false means not to convert. It only works if convert_to_version is not com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1a , com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1aCoatedGRACoL2006 , com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1aISOCoatedv2ECI , com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1aJapanColor2001Coated and com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1aPSOCoatedv3ECI .
  [in] | to_decalibrate_gray_or_cmyk | Whether to decalibrate device independent Gray or CMYK. true means to decalibrate, false means not to decalibrate.
  [in] | progress_callback | Progress callback which is implemented by user and can be used to get progress data. This can be null. Default value: null.

Returns
  A ResultInformation object.

## ◆ delete()

synchronized void com.foxit.sdk.addon.compliance.PDFXCompliance.delete | ( |  | ) |

Clean up related C++ resources immediately.

Returns
  None.

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

Reimplemented from com.foxit.sdk.common.Base.

## ◆ isEmpty()

boolean com.foxit.sdk.addon.compliance.PDFXCompliance.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.

## ◆ verify()

ResultInformation com.foxit.sdk.addon.compliance.PDFXCompliance.verify | ( | int | verify_version,
|  | String | src_pdf_path,
|  | int | first_page_index,
|  | int | last_page_index,
|  | ProgressCallback | progress_callback
| ) |  | throws com.foxit.sdk.PDFException

Verify a PDF file with specified PDF/X version.

Parameters

  [in] | verify_version | PDF/X version to verify. Please refer to values starting from com.foxit.sdk.addon.compliance.PDFXCompliance.e_VersionPDFX1a to object.