Package com.adobe.fd.output.api
Class PDFOutputOptions
- java.lang.Object
-
- com.adobe.fd.output.api.PDFOutputOptions
-
public class PDFOutputOptions extends java.lang.Object
Represents the set of options used to configure operations such asOutputService.generatePDFOutput(com.adobe.aemfd.docmanager.Document, com.adobe.aemfd.docmanager.Document, com.adobe.fd.output.api.PDFOutputOptions)
-
-
Constructor Summary
Constructors Constructor Description 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 documentjava.lang.String
getContentRoot()
get location form where to resolve template resourcesjava.lang.String
getDebugDir()
boolean
getEmbedFonts()
boolean
getLinearizedPDF()
get option to optimize pdf for web viewingjava.lang.String
getLocale()
get locale in which pdf should be renderedboolean
getRetainPDFFormState()
boolean
getRetainUnsignedSignatureFields()
boolean
getTaggedPDF()
get option to make pdf accessibleDocument
getXci()
void
setAcrobatVersion(AcrobatVersion acrobatVersion)
set minimum required version of the acrobat for the generated documentvoid
setContentRoot(java.lang.String url)
set location from where to resolve template resourcesvoid
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 optionsvoid
setEmbedFonts(boolean embedFonts)
Enables font embedding in output PDF document whentrue
is passed as argumentvoid
setLinearizedPDF(boolean linearizedPDF)
set option to optimize pdf for web viewingvoid
setLocale(java.lang.String locale)
set locale for the generated pdfvoid
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 providedvoid
setRetainUnsignedSignatureFields(boolean retainUnsignedSignatureFields)
Set true to retain interactive unsigned signature fields in generated Flat PDF so that the Flat PDF can be signedvoid
setTaggedPDF(boolean isTagged)
set option to make pdf accessiblevoid
setXci(Document xci)
allows setting a custom xci document which provides low level access for XFA to PDF conversion.
-
-
-
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
-
-
getXci
public Document getXci()
-
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 whentrue
is passed as argument- Parameters:
embedFonts
-
-
-