|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.output.client.PrintedOutputOptionsSpec
public class PrintedOutputOptionsSpec
Simplifies the creation and data retrieval of a print specification XML file.
A print specification contains information that is required by the Output service during each invocation request.
By configuring a print specification, you can instruct the Output service to perform tasks such as sending a print stream to a network
printer, or to write a print stream to a file, such as a PostScript file.
An object of this type is passed to the
OutputClient
object's generatePrintedDocument
method.
For information, see the Creating Document Output Streams section in Programming with Adobe Experience Manager forms.
generatePrintedOutput()
,
Serialized FormConstructor Summary | |
---|---|
PrintedOutputOptionsSpec()
A constructor that that does not set print specification options. |
|
PrintedOutputOptionsSpec(java.lang.String serverPrintSpec,
java.lang.String recordName,
int recordLevel,
int lookAhead,
java.util.List rules,
java.lang.String XCIURI,
int copies,
java.lang.String printerURI,
java.lang.String fileURI,
boolean generateManyFiles,
Pagination pagination,
Staple staple,
java.lang.String pageOffsetX,
java.lang.String pageOffsetY,
java.lang.String outputBin,
OutputJog outputJog,
java.lang.String metaDataSpecFile,
boolean recordLevelMetaData,
java.lang.String recordIdField,
java.lang.String lpdURI,
java.lang.String printerQueueName,
java.lang.String charset,
java.lang.String locale)
A constructor that sets all print specification options. |
|
PrintedOutputOptionsSpec(java.lang.String serverPrintSpec,
java.lang.String recordName,
int recordLevel,
int lookAhead,
java.util.List rules,
java.lang.String XCIURI,
int copies,
java.lang.String printerURI,
java.lang.String fileURI,
boolean generateManyFiles,
Pagination pagination,
Staple staple,
java.lang.String pageOffsetX,
java.lang.String pageOffsetY,
java.lang.String outputBin,
OutputJog outputJog,
java.lang.String metaDataSpecFile,
boolean recordLevelMetaData,
java.lang.String recordIdField,
java.lang.String lpdURI,
java.lang.String printerQueueName,
java.lang.String charset,
java.lang.String locale,
ResourcesInPDF useResourcesInPDF)
A constructor that sets all print specification options. |
Method Summary | |
---|---|
int |
getAuditLog()
Get Audit Log Configuration value |
java.lang.String |
getCharset()
Gets the character set used to encode the output byte stream. |
int |
getCopies()
Returns the number of copies that the Output service prints. |
int |
getDebug()
Gets the value of the debug flag. |
java.lang.String |
getFileURI()
Returns a file URI value that the Output service uses to write the output stream to a file. |
java.lang.Boolean |
getLazyLoading()
Decides whether Lazy Loading is set. |
java.lang.String |
getLocale()
Gets a locale value. |
int |
getLookAhead()
Returns the lookahead bytes used for the search rules. |
java.lang.String |
getLpdURI()
Returns the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running. |
java.lang.String |
getMetaDataSpecFile()
Returns the metaDataSpecFile value. |
java.lang.String |
getOutputBin()
Gets the outputBin XCI value. |
OutputJog |
getOutputJog()
Gets the Jog XCI value. |
java.lang.String |
getPageOffsetX()
Gets the pageOffsetX XCI value. |
java.lang.String |
getPageOffsetY()
Gets the pageOffsetY XCI value. |
Pagination |
getPagination()
Returns the pagination XCI value. |
java.lang.String |
getPrinterQueueName()
Returns the name of the printer queue that is used with the Line Printer Daemon (LPD) URI. |
java.lang.String |
getPrinterURI()
Returns the destination for the print output. |
java.lang.String |
getRecordIdField()
Returns the identifier value for the batch record by using the Xpath value that is located in the input XML data. |
int |
getRecordLevel()
Returns the element level (located within the input data file) that contains data records where the root is level 1. |
java.lang.String |
getRecordName()
Returns the element name (located within the input data file) that identifies the beginning of a batch of records. |
java.util.List |
getRules()
Returns a list of search rules that scan the input data file for a pattern and associates the data with a specific form design. |
java.lang.String |
getServerPrintSpec()
Returns the print specification name. |
Staple |
getStaple()
Returns the staple XCI value. |
ResourcesInPDF |
getUseResourcesInPDF()
This is used for determining the types of resources which need to be retrieved from the pdf form for re-rendering |
java.lang.String |
getXCIURI()
Returns the XCI file to use when generating a document output stream. |
boolean |
isGenerateManyFiles()
Returns whether the Output service creates a single or multiple output streams. |
boolean |
isRecordLevelMetaData()
Returns true if the recordLevelMetaData value is set. |
boolean |
isRetainPDFFormState()
This returns the value which specifies whether the form state is retained or not during the operation. |
void |
setAuditLog(int auditLog)
Set Audit Log Configuration value |
void |
setCharset(java.lang.String charset)
Sets the character set used to encode the output byte stream. |
void |
setCopies(int copies)
Sets the number of copies to print. |
void |
setDebug(int debugval)
Sets the value of the debug flag. |
void |
setFileURI(java.lang.String fileURI)
Sets a file URI value that the Output service uses to write the output stream to a file. |
void |
setGenerateManyFiles(boolean generateManyFiles)
Specifies whether the Output service creates a single or multiple output streams. |
void |
setLazyLoading(java.lang.Boolean lazyLoading)
Sets the Lazy Loading parameter |
void |
setLocale(java.lang.String locale)
Sets the locale value. |
void |
setLookAhead(int lookAhead)
Sets the lookahead bytes used for the search rules. |
void |
setLpdURI(java.lang.String lpdURI)
Sets the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running. |
void |
setMetaDataSpecFile(java.lang.String metaDataSpecFile)
Sets the metaDataSpecFile value. |
void |
setOutputBin(java.lang.String outputBin)
Sets the outputBin XCI value that is used to enable the print driver to select
the appropriate output bin. |
void |
setOutputJog(OutputJog outputJog)
Sets the Jog XCI value that is used to set what output pages are physically
shifted in the output tray. |
void |
setPageOffsetX(java.lang.String pageOffsetX)
Sets the pageOffsetX XCI value. |
void |
setPageOffsetY(java.lang.String pageOffsetY)
Sets the pageOffsetY XCI value. |
void |
setPagination(Pagination pagination)
Sets the pagination XCI value. |
void |
setPrinterQueueName(java.lang.String printerQueueName)
Sets the name of the printer queue that is used with the Line Printer Daemon (LPD) URI. |
void |
setPrinterURI(java.lang.String printerURI)
Sets the destination for the print output. |
void |
setRecordIdField(java.lang.String recordIdField)
Sets the identifier value for the batch record. |
void |
setRecordLevel(int recordLevel)
Sets the element level (located within the input data file) that contains data records where the root is level 1. |
void |
setRecordLevelMetaData(boolean recordLevelMetaData)
Sets the recordLevelMetaData value. |
void |
setRecordName(java.lang.String recordName)
Sets the element name (located within the input data file) that identifies the beginning of a record. |
void |
setRetainPDFFormState(boolean retainPDFFormState)
This sets the value which specifies whether the form state is retained or not during the operation. |
void |
setRules(java.util.List rules)
Sets a list of search rules that scan the input data file for a pattern and associates the data with a specific form design. |
void |
setServerPrintSpec(java.lang.String serverPrintSpec)
Sets the print specification name. |
void |
setStaple(Staple staple)
Sets the staple XCI value that is set when a stapler is used. |
void |
setUseResourcesInPDF(ResourcesInPDF useResourcesInPDF)
This is used for setting the types of resources which need to be retrieved from the pdf form for re-rendering |
void |
setXCIURI(java.lang.String XCIURI)
Sets the XCI file to use when generating a document output stream. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrintedOutputOptionsSpec()
public PrintedOutputOptionsSpec(java.lang.String serverPrintSpec, java.lang.String recordName, int recordLevel, int lookAhead, java.util.List rules, java.lang.String XCIURI, int copies, java.lang.String printerURI, java.lang.String fileURI, boolean generateManyFiles, Pagination pagination, Staple staple, java.lang.String pageOffsetX, java.lang.String pageOffsetY, java.lang.String outputBin, OutputJog outputJog, java.lang.String metaDataSpecFile, boolean recordLevelMetaData, java.lang.String recordIdField, java.lang.String lpdURI, java.lang.String printerQueueName, java.lang.String charset, java.lang.String locale, ResourcesInPDF useResourcesInPDF)
public PrintedOutputOptionsSpec(java.lang.String serverPrintSpec, java.lang.String recordName, int recordLevel, int lookAhead, java.util.List rules, java.lang.String XCIURI, int copies, java.lang.String printerURI, java.lang.String fileURI, boolean generateManyFiles, Pagination pagination, Staple staple, java.lang.String pageOffsetX, java.lang.String pageOffsetY, java.lang.String outputBin, OutputJog outputJog, java.lang.String metaDataSpecFile, boolean recordLevelMetaData, java.lang.String recordIdField, java.lang.String lpdURI, java.lang.String printerQueueName, java.lang.String charset, java.lang.String locale)
Method Detail |
---|
public int getAuditLog()
public void setAuditLog(int auditLog)
auditLog
- An integer that specifies the audit log configurationpublic boolean isRetainPDFFormState()
public void setRetainPDFFormState(boolean retainPDFFormState)
supportFormState
- public ResourcesInPDF getUseResourcesInPDF()
public void setUseResourcesInPDF(ResourcesInPDF useResourcesInPDF)
public int getCopies()
public void setCopies(int copies)
To see this method used in a code example, see the Sending a print stream to a network printer using the Java API quick start in Programming with Adobe Experience Manager forms.
copies
- The number of copies to print.public java.lang.String getPrinterURI()
\\PrintServer\Print1
.
public void setPrinterURI(java.lang.String printerURI)
\\PrintServer\Print1
.
printerURI
- A string value that specifies a destination for the print output.public java.lang.String getFileURI()
c:/save/output.pcl
.
public void setFileURI(java.lang.String fileURI)
c:/save/output.pcl
.
In this situation, the Output service writes the output stream to a file named output.pcl
that is located in c:/save
.
To see this method used in a code example, see the Printing to a file using the Java API quick start in Programming with Adobe Experience Manager forms.
fileURI
- A string value that represents the file URI location.public boolean isGenerateManyFiles()
public void setGenerateManyFiles(boolean generateManyFiles)
generateManyFiles
- A boolean value that specifies whether the Output service creates a single output stream or multiple output streams.public java.lang.String getServerPrintSpec()
public void setServerPrintSpec(java.lang.String serverPrintSpec)
serverPrintSpec
- A string value that represents the print specification name.public java.lang.String getRecordName()
recordLevel
value.
Returns A string value that represents the element name that identifies the beginning of a batch of records.
public void setRecordName(java.lang.String recordName)
recordLevel
value.
To see this method used in a code example, see the Creating multiple PDF files using the Java API quick start in Programming with Adobe Experience Manager forms.
recordName
- A string value that represents the element name that identifies the beginning of a batch of records.public int getRecordLevel()
recordName
value.
Returns The batch record level.
public void setRecordLevel(int recordLevel)
recordName
value.
recordLevel
- The batch record level.public java.lang.String getXCIURI()
public void setXCIURI(java.lang.String XCIURI)
XCIURI
- A string value that specifies the XCI file to use.public Pagination getPagination()
pagination
XCI value.
Pagination
enumeration value that represents the pagination
XCI value.public void setPagination(Pagination pagination)
pagination
XCI value.
pagination
- A Pagination
enumeration value that represents the pagination
XCI value.public Staple getStaple()
staple
XCI value. This XCI option is set when a stapler is used. This
option can be specified in the configuration model by the staple element and is only used
for PS and PCL printers.
staple
enumeration value that represents the XCI value.public void setStaple(Staple staple)
staple
XCI value that is set when a stapler is used. This
option can be specified in the configuration model by the staple element and is only used
for PS and PCL printers.
staple
- A staple
enumeration value that represents the XCI value.public OutputJog getOutputJog()
Jog
XCI value. This XCI option is set when output pages should be jogged
(physically shifted in the output tray). This option is for PS and PCL printers only.
Jog
enumeration value that represents the Jog
XCI value.public void setOutputJog(OutputJog outputJog)
Jog
XCI value that is used to set what output pages are physically
shifted in the output tray.
This option is for PS and PCL printers only.
outputJog
- A Jog
enumeration value that represents the Jog
XCI value.public java.lang.String getOutputBin()
outputBin
XCI value. This value is used to enable the print driver to select
the appropriate output bin.
outputBin
enumeration value that represents the outputBin
XCI value.public void setOutputBin(java.lang.String outputBin)
outputBin
XCI value that is used to enable the print driver to select
the appropriate output bin.
outputBin
- An outputBin
enumeration value that represents the outputBin
XCI value.public java.lang.String getPageOffsetX()
pageOffsetX
XCI value. This value is set when you want to print the job on
pre-printed paper and you want to change the origin (for example, the default page
offsets for that particular job). This value overrides the page offsets defined in the
XDC file which represents non-printable area for any PCL device. This option is for PCL
devices only.
pageOffsetX
enumeration value that represents the pageOffsetX
XCI value.public void setPageOffsetX(java.lang.String pageOffsetX)
pageOffsetX
XCI value. This value is set when you want to print the job on
pre-printed paper and you want to change the origin (for example, the default page
offsets for that particular job). This value overrides the page offsets defined in the
XDC file which represents non-printable area for any PCL device. This option is for PCL
devices only.
pageOffsetX
- A pageOffsetX
enumeration value that represents the pageOffsetX
XCI value.public java.lang.String getPageOffsetY()
pageOffsetY
XCI value. This value is set when you want to print the job on
pre-printed paper and you want to change the origin (for example, the default page
offsets for that particular job). This value overrides the page offsets defined in the
XDC file which represents non-printable area for any PCL device. This option is for PCL
devices only.
pageOffsetY
enumeration value that represents the pageOffsetY
XCI value.public void setPageOffsetY(java.lang.String pageOffsetY)
pageOffsetY
XCI value. This value is set when you want to print the job on
pre-printed paper and you want to change the origin (for example, the default page
offsets for that particular job). This value overrides the page offsets defined in the
XDC file which represents non-printable area for any PCL device. This option is for PCL
devices only.
pageOffsetY
- A pageOffsetY
enumeration value that represents the pageOffsetY
XCI value.public int getLookAhead()
public void setLookAhead(int lookAhead)
To see this method used in a code example, see the Creating search rules using the Java API quick start in Programming with Adobe Experience Manager forms.
lookAhead
- The number of bytes to use from the beginning of the input data file to scan for the pattern strings.public java.util.List getRules()
public void setRules(java.util.List rules)
To see this method used in a code example, see the Creating search rules using the Java API quick start in Programming with Adobe Experience Manager forms.
rules
- A list of search rules.public java.lang.String getMetaDataSpecFile()
metaDataSpecFile
value. This value is used to
generate metadata.
metaDataSpecFile
value.public void setMetaDataSpecFile(java.lang.String metaDataSpecFile)
metaDataSpecFile
value. This value is used to
generate metadata.
metaDataSpecFile
- A string value that represents the metaDataSpecFile
value.public boolean isRecordLevelMetaData()
recordLevelMetaData
value is set.
recordLevelMetaData
value is set.public void setRecordLevelMetaData(boolean recordLevelMetaData)
recordLevelMetaData
value. This value is used to
generate metadata.
recordLevelMetaData
- A Boolean value that specifies whether the recordLevelMetaData
value is set.public java.lang.String getRecordIdField()
public void setRecordIdField(java.lang.String recordIdField)
recordIdField
- A string value that represents the identifier value for the batch record.public java.lang.String getLpdURI()
lPRPrint
public void setLpdURI(java.lang.String lpdURI)
lpdURI
- A string value that represents the LPD URI.lPRPrint
public java.lang.String getPrinterQueueName()
lPRPrint
public void setPrinterQueueName(java.lang.String printerQueueName)
printerQueueName
- A string value that represents the name of the printer queue.lPRPrint
public java.lang.String getCharset()
setCharset()
public void setCharset(java.lang.String charset)
charset
- The character set used to encode the output byte stream.public int getDebug()
setDebug()
public void setDebug(int debugval)
debugval
- The debug information detail level.public void setLazyLoading(java.lang.Boolean lazyLoading)
lazyloading
- true
if the lazy loading is set, false
otherwise.public java.lang.Boolean getLazyLoading()
public java.lang.String getLocale()
setLocale()
public void setLocale(java.lang.String locale)
locale
- The locale value to set. The following table lists valid values:
zh_CN | Chinese, Simplified (P.R.C.) |
zh_TW | Chinese, Traditional (Taiwan |
zh_HK | Chinese, Traditional with HKSCS-2001 Extensions (Hong Kong) |
hr_HR | Croatian (Republic of Croatia) |
cs_CZ | Czech (Czech Republic) |
da_DK | Danish (Denmark) |
nl_BE | Dutch (Belgium) |
nl_NL | Dutch (Netherlands) |
en_AU | English (Australia) |
en_CA | English (Canada) |
en_IN | English (India) |
en_IE | English (Ireland) |
en_NZ | English (New Zealand) |
en_ZA | English (South Africa) |
en_GB | English (United Kingdom) |
en_EN | English (United Kingdom, Euro Currency) |
en_US | English (United States) |
fi_FI | Finnish (Finland) |
fr_BE | French (Belgium) |
fr_CA | French (Canada) |
fr_FR | French (France) |
fr_LU | French (Luxembourg) |
fr_CH | French (Switzerland) |
de_AT | German (Austria) |
de_DE | German (Germany) |
de_LU | German (Luxembourg) |
de_CH | German (Switzerland) |
el_GR | Greek (Greece) |
hu_HU | Hungarian (Hungary) |
it_IT | Italian (Italy) |
it_CH | Italian (Switzerland) |
ja_JP | Japanese (Japan) |
ko_KR | Korean (Korea) |
no_NO | Norwegian (Norway) |
no_NO_NY | Norwegian (Norway, Nynorsk) |
pl_PL | Polish (Poland) |
pt_BR | Portuguese (Brazil) |
pt_PT | Portuguese (Portugal) |
ro_RO | Romanian (Romania) |
sh_BA | Serbo-Croatian (Bosnia and Herzegovina) |
sh_HR | Serbo-Croatian (Croatia) |
sh_CS | Serbo-Croatian (Republic of Serbia and Montenegro) |
sk_SK | Slovak (Slovak Republic) |
es_AR | Spanish (Argentina) |
da_DK | Spanish (Bolivia) |
es_CL | Spanish (Chile) |
es_CO | Spanish (Costa Rica) |
es_DO | Spanish (Dominican Republic) |
es_EC | Spanish (Ecuador) |
es_SV | Spanish (El Salvador) |
es_GT | Spanish (Guatemala) |
es_HN | Spanish (Honduras) |
es_MX | Spanish (Mexico) |
es_NI | Spanish (Nicaragua) |
es_PA | Spanish (Panama) |
es_PY | Spanish (Paraguay) |
es_PE | Spanish (Peru) |
es_PR | Spanish (Puerto Rico) |
es_ES | Spanish (Spain) |
es_UY | Spanish (Uruguay |
es_VE | Spanish (Venezuela) |
sv_SE | Swedish (Sweden) |
tr_TR | Turkish (Turkey) |
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |