Package com.adobe.fd.output.api
Class PrintedOutputOptions
- java.lang.Object
-
- com.adobe.fd.output.api.PrintedOutputOptions
-
public class PrintedOutputOptions extends java.lang.Object
Represents the set of options used to configure operations such asOutputService.generatePrintedOutput(com.adobe.aemfd.docmanager.Document, com.adobe.aemfd.docmanager.Document, com.adobe.fd.output.api.PrintedOutputOptions)
-
-
Constructor Summary
Constructors Constructor Description PrintedOutputOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getContentRoot()
get location resolve document resourcesint
getCopies()
Returns the number of copies that the Output service prints.java.lang.String
getDebugDir()
java.lang.String
getLocale()
get locale to render documentPaginationOverride
getPaginationOverride()
Option to configure if printing should be one sided or two sidedPrintConfig
getPrintConfig()
Document
getXci()
void
setContentRoot(java.lang.String url)
set Location to resolve document resourcesvoid
setCopies(int copies)
Sets the number of copies to print.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 optionsvoid
setLocale(java.lang.String locale)
Set locale to render documentvoid
setPaginationOverride(PaginationOverride paginationOverride)
Option to configure if printing should be one sided or two sidedvoid
setPrintConfig(PrintConfig printConfig)
This is a required parameter.void
setXci(Document xci)
allows setting a custom xci document which provides low level access for XFA to print document conversion.
-
-
-
Method Detail
-
getPaginationOverride
public PaginationOverride getPaginationOverride()
Option to configure if printing should be one sided or two sided- Returns:
- PaginationOverride type
-
setPaginationOverride
public void setPaginationOverride(PaginationOverride paginationOverride)
Option to configure if printing should be one sided or two sided- Parameters:
paginationOverride
-
-
getContentRoot
public java.lang.String getContentRoot()
get location resolve document resources- Returns:
- current content root
-
setContentRoot
public void setContentRoot(java.lang.String url)
set Location to resolve document resources- Parameters:
url
-
-
getLocale
public java.lang.String getLocale()
get locale to render document- Returns:
- get current locale
-
setLocale
public void setLocale(java.lang.String locale)
Set locale to render document- Parameters:
locale
-
-
getCopies
public int getCopies()
Returns the number of copies that the Output service prints.- Returns:
- An integer value that represents the number of copies.
-
setCopies
public void setCopies(int copies)
Sets the number of copies to print. The default value is 1.- Parameters:
copies
- An integer value that represents the number of copies.
-
getPrintConfig
public PrintConfig getPrintConfig()
-
setPrintConfig
public void setPrintConfig(PrintConfig printConfig)
This is a required parameter. This is used to specify printer specific language of output document using predefined constants inPrintConfig
class This option can also be used to provide custom XDC files by creating a custom instance of usingPrintConfig.Custom(String, RenderType)
method- Parameters:
printConfig
-
-
getXci
public Document getXci()
-
setXci
public void setXci(Document xci)
allows setting a custom xci document which provides low level access for XFA to print document 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
-
-
-