Package com.adobe.fd.output.api

Class PDFOutputOptions

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AcrobatVersion getAcrobatVersion()
      get minimum required version of the acrobat for the generated document
      java.lang.String getContentRoot()
      get location form where to resolve template resources
      java.lang.String getDebugDir()  
      boolean getEmbedFonts()  
      boolean getLinearizedPDF()
      get option to optimize pdf for web viewing
      java.lang.String getLocale()
      get locale in which pdf should be rendered
      boolean getRetainPDFFormState()  
      boolean getRetainUnsignedSignatureFields()  
      boolean getTaggedPDF()
      get option to make pdf accessible
      Document getXci()  
      void setAcrobatVersion​(AcrobatVersion acrobatVersion)
      set minimum required version of the acrobat for the generated document
      void setContentRoot​(java.lang.String url)
      set location from where to resolve template resources
      void setDebugDir​(java.lang.String debugDir)
      Sets the location of directory in which debug dumps are created; Debug dumps are created only if an existing directory is set in options
      void setEmbedFonts​(boolean embedFonts)
      Enables font embedding in output PDF document when true is passed as argument
      void setLinearizedPDF​(boolean linearizedPDF)
      set option to optimize pdf for web viewing
      void setLocale​(java.lang.String locale)
      set locale for the generated pdf
      void setRetainPDFFormState​(boolean retainFormState)
      Set true to retain PDF Form state while flattening PDF Form This parameter has effect only when input is a XFA PDF Form and no input data is provided
      void setRetainUnsignedSignatureFields​(boolean retainUnsignedSignatureFields)
      Set true to retain interactive unsigned signature fields in generated Flat PDF so that the Flat PDF can be signed
      void setTaggedPDF​(boolean isTagged)
      set option to make pdf accessible
      void setXci​(Document xci)
      allows setting a custom xci document which provides low level access for XFA to PDF conversion.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PDFOutputOptions

        public PDFOutputOptions()

    • Method Detail

      • getContentRoot

        public java.lang.String getContentRoot()
        get location form where to resolve template resources
        Returns:
        currently set content root

      • setContentRoot

        public void setContentRoot​(java.lang.String url)
        set location from where to resolve template resources
        Parameters:
        url -

      • getTaggedPDF

        public boolean getTaggedPDF()
        get option to make pdf accessible
        Returns:
        current setting of tagged pdf flag

      • setTaggedPDF

        public void setTaggedPDF​(boolean isTagged)
        set option to make pdf accessible
        Parameters:
        isTagged -

      • getLinearizedPDF

        public boolean getLinearizedPDF()
        get option to optimize pdf for web viewing
        Returns:
        current setting of linearized pdf flag

      • setLinearizedPDF

        public void setLinearizedPDF​(boolean linearizedPDF)
        set option to optimize pdf for web viewing
        Parameters:
        linearizedPDF -

      • getAcrobatVersion

        public AcrobatVersion getAcrobatVersion()
        get minimum required version of the acrobat for the generated document
        Returns:
        one of the acrobat version enum

      • setAcrobatVersion

        public void setAcrobatVersion​(AcrobatVersion acrobatVersion)
        set minimum required version of the acrobat for the generated document
        Parameters:
        acrobatVersion -

      • getLocale

        public java.lang.String getLocale()
        get locale in which pdf should be rendered
        Returns:
        get current locale

      • setLocale

        public void setLocale​(java.lang.String locale)
        set locale for the generated pdf
        Parameters:
        locale -

      • setXci

        public void setXci​(Document xci)
        allows setting a custom xci document which provides low level access for XFA to PDF conversion. Options specified in XCI document override those specified via API
        Parameters:
        xci -

      • getRetainUnsignedSignatureFields

        public boolean getRetainUnsignedSignatureFields()

      • setRetainUnsignedSignatureFields

        public void setRetainUnsignedSignatureFields​(boolean retainUnsignedSignatureFields)
        Set true to retain interactive unsigned signature fields in generated Flat PDF so that the Flat PDF can be signed
        Parameters:
        retainUnsignedSignatureFields -

      • getDebugDir

        public java.lang.String getDebugDir()

      • setDebugDir

        public void setDebugDir​(java.lang.String debugDir)
        Sets the location of directory in which debug dumps are created; Debug dumps are created only if an existing directory is set in options
        Parameters:
        debugDir -

      • setRetainPDFFormState

        public void setRetainPDFFormState​(boolean retainFormState)
        Set true to retain PDF Form state while flattening PDF Form This parameter has effect only when input is a XFA PDF Form and no input data is provided
        Parameters:
        retainFormState -

      • getRetainPDFFormState

        public boolean getRetainPDFFormState()

      • getEmbedFonts

        public boolean getEmbedFonts()

      • setEmbedFonts

        public void setEmbedFonts​(boolean embedFonts)
        Enables font embedding in output PDF document when true is passed as argument
        Parameters:
        embedFonts -