com.adobe.livecycle.output.client
Class RenderOptionsSpec

java.lang.Object
  com.adobe.livecycle.output.client.RenderOptionsSpec

All Implemented Interfaces:

java.io.Serializable

public class RenderOptionsSpec
extends java.lang.Object
implements java.io.Serializable

Enables you to define run-time options that control how the Output service generates document output streams. By setting members of this class, you can perform tasks such as setting XCI options or caching form designs in order to improve performance. An object of this type is passed to the OutputClient object's generatePDFOutput method.

See Also:

generatePDFOutput(), Serialized Form

Constructor Summary

RenderOptionsSpec()
A constructor that does not set any run-time options.

RenderOptionsSpec(java.lang.Boolean cacheEnabled, java.lang.String pdfVersion, boolean taggedPDF, boolean linearizedPDF, boolean debugEnabled, java.lang.String renderAtClient, PDFARevisionNumber pDFARevisionNumber, java.lang.String pDFAAmendment, PDFAConformance pDFAConformance)
A constructor that sets all run-time options.

RenderOptionsSpec(java.lang.String sOptions)
A constructor that accepts a string that contains various run-time options.

Method Summary

AcrobatVersion	getAcrobatVersion() Gets the PDF version that the Forms service creates.
java.lang.Boolean	getCacheEnabled() Specifies whether the Output service caches a form to boost performance.
java.lang.String	getInternalOptions(java.lang.String key) For internal use only.
java.lang.String	getOptions() Returns a string representation of the options that are set.
java.lang.String	getOptionsBean(java.lang.String key) Returns the value of the specified option.
java.lang.String	getPDFAAmendment() Returns the PDF/A amendment value.
PDFAConformance	getPDFAConformance() Returns the PDF/A conformance level as specified in the PDF/A-1 ISO specification.
PDFARevisionNumber	getPDFARevisionNumber() Returns the revision number of a PDF/A document.
java.lang.String	getPdfVersion() Deprecated. Use getAcrobatVersion()
java.lang.String	getRenderAtClient() Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later.
RetainSignatureField	getRetainSignatureField() Signature fields to be retained on flattening.
java.lang.Boolean	isCacheEnabled() Specifies whether the Output service caches a form to boost performance.
boolean	isDebugEnabled() Specifies whether the debugEnabled option is enabled.
boolean	isLinearizedPDF() Specifies whether the linearizedPDF option is enabled.
boolean	isTaggedPDF() Specifies whether the Output service creates a tagged PDF document.
void	setAcrobatVersion(AcrobatVersion acrobatVersion) Sets the appropriate PDF version required for a client.
void	setCacheEnabled(java.lang.Boolean cacheEnabled) Instructs the Output service to cache a form design in order to improve performance.
void	setDebugEnabled(boolean debugEnabled) Sets the debugEnabled option.
void	setInternalOptions(java.lang.String key, java.lang.String val) For internal use only.
void	setLinearizedPDF(boolean linearizedPDF) Sets the linearizedPDF option that results in the Output service producing a linearized PDF document.
void	setPDFAAmendment(java.lang.String pDFAAmendment) Sets the PDF/A document amendment value.
void	setPDFAConformance(PDFAConformance pDFAConformance) Sets a string value that specifies the PDF/A conformance level as specified in the PDF/A-1 ISO specification.
void	setPDFARevisionNumber(PDFARevisionNumber pDFARevisionNumber) Sets the revision number of a PDF/A document.
void	setPdfVersion(java.lang.String pdfVersion) Deprecated. Use setAcrobatVersion()
void	setRenderAtClient(java.lang.String renderAtClient) Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later.
void	setRetainSignatureField(RetainSignatureField retainSignatureField) Signature fields to be retained on flattening.
void	setTaggedPDF(boolean taggedPDF) Sets the taggedPDF option that results in the Output service creating a tagged PDF document.
java.lang.String	toString() Creates a string represenation of this class.
void	updateOptionsBean(java.lang.String options) For internal use only.
void	updateOptionsBean(java.lang.String key, java.lang.String value) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderOptionsSpec

public RenderOptionsSpec()

A constructor that does not set any run-time options.

RenderOptionsSpec

public RenderOptionsSpec(java.lang.String sOptions)
                  throws OutputException

A constructor that accepts a string that contains various run-time options. The format of this string must be a standard query string, as shown in the following example: taggedPDF=false&cacheEnabled=false.

Throws:

OutputException

RenderOptionsSpec

public RenderOptionsSpec(java.lang.Boolean cacheEnabled,
                         java.lang.String pdfVersion,
                         boolean taggedPDF,
                         boolean linearizedPDF,
                         boolean debugEnabled,
                         java.lang.String renderAtClient,
                         PDFARevisionNumber pDFARevisionNumber,
                         java.lang.String pDFAAmendment,
                         PDFAConformance pDFAConformance)

A constructor that sets all run-time options.

Method Detail

getRenderAtClient

public java.lang.String getRenderAtClient()

Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later. The following renderAtClient values are valid:

• auto - Instructs the Output service to observe the form design's dynamicRender configuration value.
• true - Client-side rendering occurs within Acrobat 7.0 or later.
• false - Client-side rendering is not enabled.

Returns:

The renderAtClient value.

setRenderAtClient

public void setRenderAtClient(java.lang.String renderAtClient)

Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later. The following renderAtClient values are valid:

• auto - Instructs the Output service to observe the form design's dynamicRender configuration value.
• true - Client-side rendering occurs within Acrobat 7.0 or later.
• false - Client-side rendering is not enabled.

Parameters:

renderAtClient - The renderAtClient value to set.

getPDFAAmendment

public java.lang.String getPDFAAmendment()

Returns the PDF/A amendment value. For information about the PDF/A document amendment value, see the PDF/A-1 ISO specification that is titled ISO 19005-1 Document management.

Returns:

A string value that represents the PDF/A amendment value.

See Also:

transformPDF

setPDFAAmendment

public void setPDFAAmendment(java.lang.String pDFAAmendment)

Sets the PDF/A document amendment value. Typically, this value is set when you invoke the transformPDF method. For information about the PDF/A document amendment value, see the PDF/A-1 ISO specification that is titled ISO 19005-1 Document management.

Parameters:

pDFAAmendment - A string value that represents the PDF/A amendment value. This value also specifies the year which is separated from the amendment identifier value by a colon.

getPDFAConformance

public PDFAConformance getPDFAConformance()

Returns the PDF/A conformance level as specified in the PDF/A-1 ISO specification. The default value is A. The conformance level refers to how a PDF document adheres to requirements that specify how long-term electronic documents are preserved. For information about level A and B conformance, see the PDF/A-1 ISO specification that is titled ISO 19005-1 Document management.

Returns:

A string value that specifies the PDF/A conformance level.

setPDFAConformance

public void setPDFAConformance(PDFAConformance pDFAConformance)

Sets a string value that specifies the PDF/A conformance level as specified in the PDF/A-1 ISO specification. The default value is A. The conformance level refers to how a PDF document adheres to requirements that specify how long-term electronic documents are preserved. For information about level A and B conformance, see the PDF/A-1 ISO specification that is titled ISO 19005-1 Document management.

Parameters:

pDFAConformance - The PDF/A conformance level to set. Valid values are A or B.

getPDFARevisionNumber

public PDFARevisionNumber getPDFARevisionNumber()

Returns the revision number of a PDF/A document. The default value is 1. For information about the revision number of a PDF/A document, see the PDF/A-1 ISO specification that is titled ISO 19005-1 Document management.

Returns:

An integer value that specifies the revision number of the PDF/A document.

setPDFARevisionNumber

public void setPDFARevisionNumber(PDFARevisionNumber pDFARevisionNumber)

Sets the revision number of a PDF/A document. For information about the revision number of a PDF/A document, see the PDF/A-1 ISO specification that is titled ISO 19005-1 Document management.

Parameters:

pDFARevisionNumber - An integer value that specifies the revision number of a PDF/A document.

isCacheEnabled

public java.lang.Boolean isCacheEnabled()

Specifies whether the Output service caches a form to boost performance. A form design is cached the first time it is used to generate a document output stream. The next time that the form design is used to generate a document output stream, the Output service determines if the cached form design is newer than the non-cached form design by comparing timestamps. If the cached form design is newer, then it is retrieved from the cache. This option only works in conjunction with the form design's caching property. For information, see LiveCycle Designer Help.

Returns:

A Boolean value that specifies whether a form is cached. The value true means that the form is cached.

getCacheEnabled

public java.lang.Boolean getCacheEnabled()

Specifies whether the Output service caches a form to boost performance. A form design is cached the first time it is used to generate a document output stream. The next time that the form design is used to generate a document output stream, the Output service determines if the cached form design is newer than the non-cached form design by comparing timestamps. If the cached form design is newer, then it is retrieved from the cache. This option only works in conjunction with the form design's caching property. For information, see LiveCycle Designer Help.

Returns:

A Boolean value that specifies whether a form is cached. The value true means that the form is cached.

setCacheEnabled

public void setCacheEnabled(java.lang.Boolean cacheEnabled)

Instructs the Output service to cache a form design in order to improve performance. A form design is cached the first time it is used to generate a document output stream. The next time that the form design is used to generate a document output stream, the Output service determines if the cached form design is newer than the non-cached form design by comparing timestamps. If the cached form design is newer, then it is retrieved from the cache. This option only works in conjunction with the form design's caching property. For information, see LiveCycle Designer Help.

Parameters:

cacheEnabled - A Boolean value that specifies whether to cache a form. The value true means that a form is cached.

isDebugEnabled

public boolean isDebugEnabled()

Specifies whether the debugEnabled option is enabled. This option provides more information in the J2EE application server's log file.

Returns:

A Boolean value that specifies whether the debugEnabled option is enabled.

See Also:

setDebugEnabled()

setDebugEnabled

public void setDebugEnabled(boolean debugEnabled)

Sets the debugEnabled option. Pass the value true to enable debug logging, which provides more information in the J2EE application server's log file.

Parameters:

debugEnabled - A Boolean value that sets the debugEnabled option.

isLinearizedPDF

public boolean isLinearizedPDF()

Specifies whether the linearizedPDF option is enabled. A linearized PDF document is organized to enable incremental access in a network environment. For example, a linearized PDF document can be displayed in a web browser before the entire PDF document is downloaded. For more information about a linearized PDF document, see the PDF Reference guide.

Returns:

A Boolean value that specifies whether the Output service produces a linearized PDF document.

See Also:

setLinearizedPDF()

setLinearizedPDF

public void setLinearizedPDF(boolean linearizedPDF)

Sets the linearizedPDF option that results in the Output service producing a linearized PDF document. A linearized PDF document is organized to enable incremental access in a network environment. For example, a linearized PDF document can be displayed in a web browser before the entire PDF document is downloaded. For more information about a linearized PDF document, see the PDF Reference guide.

Parameters:

linearizedPDF - A Boolean value that when set to true, results in the Output service producing a linearized PDF document.

getPdfVersion

public java.lang.String getPdfVersion()

Deprecated. Use getAcrobatVersion()

Gets the PDF version that is generated by the Output service. Acrobat 6.0 supports PDF version 1.5 and Acrobat 7.0 or later supports PDF version 1.6.

The following values are valid:

• 1.5
• 1.6

Returns:

A string value that specifies the PDF version value.

See Also:

setPdfVersion()

setPdfVersion

public void setPdfVersion(java.lang.String pdfVersion)

Deprecated. Use setAcrobatVersion()

Sets the PDF version to generate. Acrobat 6.0 supports PDF version 1.5 and Acrobat 7.0 or later supports PDF version 1.6.

The following values are valid:

• 1.5
• 1.6

Parameters:

pdfVersion - A string value that specifies the PDF version value.

See Also:

RenderOptionsSpec.getPdfVersion()

isTaggedPDF

public boolean isTaggedPDF()

Specifies whether the Output service creates a tagged PDF document.

Returns:

A Boolean value that specifies whether the Output service produces a tagged PDF document.

See Also:

setTaggedPDF()

setTaggedPDF

public void setTaggedPDF(boolean taggedPDF)

Sets the taggedPDF option that results in the Output service creating a tagged PDF document. A tagged PDF document defines a set of standard structure types and attributes that allow page content (text, graphics, and images) to be extracted and reused for other purposes.

It is intended for use by tools that perform the following types of operations:

• Simple extraction of text and graphics for pasting into other applications.
• Automatic reflow of text and associated graphics to fit a page of a different size than was assumed for the original layout.
• Processing text for such purposes as searching, indexing, and spell-checking.
• Conversion to other common file formats (such as HTML, XML, and RTF) with document structure and basic styling information preserved.
• Making content accessible to users with visual impairments.

Tagged PDF files are not supported in PDF versions prior to version 1.4. For more information about tagged PDF documents, see the PDF Reference guide.

Parameters:

taggedPDF - A Boolean value that when set to true, results in the Output service producing a tagged PDF document.

getOptions

public java.lang.String getOptions()

Returns a string representation of the options that are set.

Returns:

A string representation of the options that are set.

getOptionsBean

public java.lang.String getOptionsBean(java.lang.String key)

Returns the value of the specified option.

Parameters:

key - A string value that specifies the name of the option.

Returns:

A string value that specifies the value of the option.

updateOptionsBean

public void updateOptionsBean(java.lang.String key,
                              java.lang.String value)
                       throws OutputException

For internal use only. Do not use.

Throws:

OutputException

updateOptionsBean

public void updateOptionsBean(java.lang.String options)
                       throws OutputException

For internal use only. Do not use.

Throws:

OutputException

toString

public java.lang.String toString()

Creates a string represenation of this class.

Overrides:

toString in class java.lang.Object

Returns:

A string represenation of this class.

getInternalOptions

public java.lang.String getInternalOptions(java.lang.String key)

For internal use only. Do not use. Instead invoke the getOptionsBean method.

See Also:

getOptionsBean()

setInternalOptions

public void setInternalOptions(java.lang.String key,
                               java.lang.String val)

For internal use only. Instead invoke the updateOptionsBean method.

See Also:

updateOptionsBean()

getAcrobatVersion

public AcrobatVersion getAcrobatVersion()

Gets the PDF version that the Forms service creates.

Returns:

One of the following values:

• acrobat6
• acrobat7.0
• acrobat7.0.5
• acrobat8

setAcrobatVersion

public void setAcrobatVersion(AcrobatVersion acrobatVersion)

Sets the appropriate PDF version required for a client.

Parameters:

acrobatVersion - The PDF version to set and must be one of the following values:

• acrobat6
• acrobat7.0
• acrobat7.0.5
• acrobat8

getRetainSignatureField

public RetainSignatureField getRetainSignatureField()

Signature fields to be retained on flattening.

setRetainSignatureField

public void setRetainSignatureField(RetainSignatureField retainSignatureField)

Signature fields to be retained on flattening.