Package com.adobe.fd.forms.api

Class PDFFormRenderOptions

  • public class PDFFormRenderOptions
extends java.lang.Object
    Represents a set of options configurable in renderPDFForm operation of FormsService

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AcrobatVersion getAcrobatVersion()
      get the get acrobat version of generated PDF Form
      CacheStrategy getCacheStrategy()
      Return the caching strategy to use
      java.lang.String getContentRoot()  
      java.lang.String getDebugDir()  
      boolean getEmbedFonts()  
      java.lang.String getLocale()  
      RenderAtClient getRenderAtClient()  
      java.util.List<java.lang.String> getSubmitUrls()  
      boolean getTaggedPDF()
      get if generated PDF Form is tagged
      Document getXci()  
      void setAcrobatVersion​(AcrobatVersion acrobatVersion)
      set version of acrobat for which PDF Form should be generated
      void setCacheStrategy​(CacheStrategy strategy)
      set the caching strategy to use for PDF Forms rendition one of the enums in CacheStrategy default is CacheStrategy.AGGRESSIVE As Caching Strategy can also be configure via Config Manager When value specified using Config Manager is different from the one specified via this API then final Caching Strategy is calculated as follows Value in Config ManagerValue via APIFinal Value AggressiveConservativeConservative AggressiveNoneNone ConservativeAggressiveConservative ConservativeNoneNone NoneAggressiveNone NoneConservativeNone
      void setContentRoot​(java.lang.String url)
      set content url
      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 Form document when true is passed as argument
      void setLocale​(java.lang.String locale)
      Set locale to use for rendering
      void setRenderAtClient​(RenderAtClient renderAtClient)
      this option is used to generate static pdf form passing RenderAtClient#NO to this method causes form to be pre rendered on the server passing RenderAtClient#AUTO to this method causes to use value set using Form Designer default is RenderAtClient#YES
      void setSubmitUrls​(java.util.List<java.lang.String> urls)
      set submit url
      void setTaggedPDF​(boolean isTagged)
      set if pdf form should be tagged
      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

      • PDFFormRenderOptions

        public PDFFormRenderOptions()

    • Method Detail

      • setRenderAtClient

        public void setRenderAtClient​(RenderAtClient renderAtClient)
        this option is used to generate static pdf form passing RenderAtClient#NO to this method causes form to be pre rendered on the server passing RenderAtClient#AUTO to this method causes to use value set using Form Designer default is RenderAtClient#YES
        Parameters:
        renderAtClient -

      • getCacheStrategy

        public CacheStrategy getCacheStrategy()
        Return the caching strategy to use
        Returns:
        currently set CacheStrategy

      • setCacheStrategy

        public void setCacheStrategy​(CacheStrategy strategy)
        set the caching strategy to use for PDF Forms rendition one of the enums in CacheStrategy default is CacheStrategy.AGGRESSIVE As Caching Strategy can also be configure via Config Manager When value specified using Config Manager is different from the one specified via this API then final Caching Strategy is calculated as follows
        Value in Config ManagerValue via APIFinal Value
        AggressiveConservativeConservative
        AggressiveNoneNone
        ConservativeAggressiveConservative
        ConservativeNoneNone
        NoneAggressiveNone
        NoneConservativeNone
        Parameters:
        strategy -

      • getContentRoot

        public java.lang.String getContentRoot()

      • setContentRoot

        public void setContentRoot​(java.lang.String url)
        set content url
        Parameters:
        url -

      • getTaggedPDF

        public boolean getTaggedPDF()
        get if generated PDF Form is tagged
        Returns:
        current setting of taggedPDF

      • setTaggedPDF

        public void setTaggedPDF​(boolean isTagged)
        set if pdf form should be tagged
        Parameters:
        isTagged -

      • getAcrobatVersion

        public AcrobatVersion getAcrobatVersion()
        get the get acrobat version of generated PDF Form
        Returns:
        current accrobat version

      • setAcrobatVersion

        public void setAcrobatVersion​(AcrobatVersion acrobatVersion)
        set version of acrobat for which PDF Form should be generated
        Parameters:
        acrobatVersion -

      • getLocale

        public java.lang.String getLocale()

      • setLocale

        public void setLocale​(java.lang.String locale)
        Set locale to use for rendering
        Parameters:
        locale -

      • getSubmitUrls

        public java.util.List<java.lang.String> getSubmitUrls()

      • setSubmitUrls

        public void setSubmitUrls​(java.util.List<java.lang.String> urls)
        set submit url
        Parameters:
        urls -

      • 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 -

      • 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 -

      • getEmbedFonts

        public boolean getEmbedFonts()

      • setEmbedFonts

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