Package com.datalogics.PDFL

Class PDFXConvertParams

java.lang.Object
com.datalogics.PDFL.PDFXConvertParams
public class PDFXConvertParams extends Object
Parameters for converting a document to PDF/X compliance. These parameters control how a Document is converted to the PDF/X standard.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PDFXConvertParams()
    Parameters for converting to PDF/X.
    PDFXConvertParams(boolean RemoveAllAnnotations, boolean AbortIfXFAIsPresent)
    Parameters for converting to PDF/X.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
     
    boolean
    getAbortIfXFAIsPresent()
    Presence of XFA can result in some loss of data in output PDF/X file as the Library does not support XFA.
    String
    getProfileDesc()
    The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3.
    boolean
    getRemoveAllAnnotations()
    Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.
    void
    setAbortIfXFAIsPresent(boolean theSetting)
    Presence of XFA can result in some loss of data in output PDF/X file as the Library does not support XFA.
    void
    setProfileDesc(String profile)
    The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3.
    void
    setRemoveAllAnnotations(boolean theSetting)
    Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PDFXConvertParams

      public PDFXConvertParams()
      Parameters for converting to PDF/X.

      Parameters:
      RemoveAllAnnotations - Remove all annotations whether legal or illegal. Default is false.
      AbortIfXFAIsPresent - Abort when XFA is present. Default is false.

    • PDFXConvertParams

      public PDFXConvertParams(boolean RemoveAllAnnotations, boolean AbortIfXFAIsPresent)
      Parameters for converting to PDF/X.

      Parameters:
      RemoveAllAnnotations - Remove all annotations whether legal or illegal.
      AbortIfXFAIsPresent - Abort when XFA is present.

  • Method Details

    • delete

      public void delete()

    • getRemoveAllAnnotations

      public boolean getRemoveAllAnnotations()
      Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

      By default we will filter all illegal Annotations and Actions.

      If false we will filter out all illegal Annotations and Actions (according to the standard being used) while retaining the legal ones. If true this will remove all the Annotations and Actions from the output PDF/X compliant file.

    • setRemoveAllAnnotations

      public void setRemoveAllAnnotations(boolean theSetting)
      Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

      By default we will filter all illegal Annotations and Actions.

      If false we will filter out all illegal Annotations and Actions (according to the standard being used) while retaining the legal ones. If true this will remove all the Annotations and Actions from the output PDF/X compliant file.

    • getAbortIfXFAIsPresent

      public boolean getAbortIfXFAIsPresent()
      Presence of XFA can result in some loss of data in output PDF/X file as the Library does not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true.

      By default we will not abort if XFA is present.

      If false we will convert even if we detect the XFA form entry in PDDoc If true we will abort the process.

    • setAbortIfXFAIsPresent

      public void setAbortIfXFAIsPresent(boolean theSetting)
      Presence of XFA can result in some loss of data in output PDF/X file as the Library does not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true.

      By default we will not abort if XFA is present.

      If false we will convert even if we detect the XFA form entry in PDDoc If true we will abort the process.

    • setProfileDesc

      public void setProfileDesc(String profile)
      The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3. This parameter allows the user to specify a particular profile for this conversion by description. When this parameter is not present, the profile "U.S. Web Coated (SWOP) v2" will be used for both.

      If this description is present, and specifies a profile of the wrong color family, or specifies a profile which cannot be located in resources, an exception will be raised.

    • getProfileDesc

      public String getProfileDesc()
      The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3. This parameter allows the user to specify a particular profile for this conversion by description. When this parameter is not present, the profile "U.S. Web Coated (SWOP) v2" will be used for both.

      If this description is present, and specifies a profile of the wrong color family, or specifies a profile which cannot be located in resources, an exception will be raised.