RenderOptionsSpec (Adobe LiveCycle ES3 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.adobe.livecycle.formsservice.client
Class RenderOptionsSpec

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

All Implemented Interfaces:: Serializable, Cloneable

public class RenderOptionsSpec
extends Object
implements Serializable, Cloneable
extends Object
implements Serializable, Cloneable

Enables you to define run-time options that control how the Forms service renders forms and handles form submissions. By setting members of this class, you can perform many tasks such as caching forms to improve the performance of the Forms service, rendering forms on a client, applying usage rights to the rendered form (requires that the Reader Extensions service is installed), and setting form guide options. An object of this type is passed to the FormsServiceClient object's processFormSubmission method. For information, see Rendering Forms.

See Also:: processFormSubmission(), Serialized Form

Constructor Summary
`RenderOptionsSpec()` A standard constructor.
RenderOptionsSpec(OutputType outputType, String charset, String locale, int pageNumber, Boolean cacheEnabled, Integer validationUI, Integer validationReporting, String validationBorder, String acrobatVersion, String pDFVersion, boolean xMLData, boolean taggedPDF, boolean linearizedPDF, boolean pDF2XDP, String seedPDF, String renderAtClient, String clientFrame, String imageURL, boolean clientCache, String exportDataFormat, boolean standAlone, String formModel, String xDCURI, String xCIURI, String fontMapURI, String xCI, String serviceId, String rootLocale, String digSigCSSURI, String toolbarMenu, boolean debugEnabled, String ifModifiedSince, String guideName, boolean guideRSL, boolean guidePDF, boolean guideAccessible, String guideCBURL, boolean cB, String guideStyle, boolean guideSubmitAll, boolean injectFormBridge, String reCredentialAlias, String reCredentialPassword, String reReaderMessage, boolean re2DBarcode, boolean reCommenting, boolean reCreatePages, boolean reDigSig, boolean reEmbeddedAttachments, boolean reExpImp, boolean reFillIn, boolean reFormFieldMod, boolean reOnlineCommenting, boolean reOnlineForms, boolean reStandaloneSubmit) A constructor that enables you to set all options.
`RenderOptionsSpec(String sOptions)` For internal use only.

Method Summary
`Object`	`clone()` Creates a copy of this object.
`String`	`getAcrobatVersion()` Gets the PDF version that the Forms service creates.
`Boolean`	`getCacheEnabled()` Specifies whether the Forms service caches a PDF form to boost performance.
`String`	`getCharset()` Gets the character set used to encode the output byte stream.
`String`	`getClientFrame()` Returns a string value that specifies the client frame to use for HTML transformations.
`String`	`getDigSigCSSURI()` Returns the `digSigCSSURI` value.
`String`	`getExportDataFormat()` Gets the format of the data that the Forms service exports to a client application.
`String`	`getFontMapURI()` Specifies the URI location of the font mapping file.
`String`	`getFormModel()` Gets the location to where the form is processed.
`String`	`getGuideCBURL()` Gets the value of the `guideCbUrl` option, which specifies a custom override implementation of a callback servlet.
`String`	`getGuideName()` Returns the name of the specific guide within a guided forms definition.
`String`	`getGuideStyle()` Returns the name of the style sheet used by guided forms.
`String`	`getIfModifiedSince()` For internal use only.
`String`	`getImageURL()` Returns the URL that receives image requests from the target device.
`boolean`	`getInjectFormBridge()` Returns a Boolean value that specifies whether the `injectFormBridge` option is set.
`String`	`getInternalOption(String key)` For internal use only.
`HashMap`	`getInternalOptionMap()` For internal use only.
`String`	`getLocale()` Gets a locale value that is used by the Forms service to send validation messsages to client devices, such as web browsers, as part of HTML transformations.
`String`	`getOptions()` For internal use only.
`String`	`getOptionsBean(String key)` For internal use only.
`OutputType`	`getOutputType()` Returns the output type value that specifies how a form that is rendered as HTML is displayed.
`int`	`getPageNumber()` The page number value specifies the initial page number to render in a multipage HTML form.
`String`	`getPDFVersion()` Gets the PDF version value that represents the PDF version to output.
`HashMap`	`getPropertyMap()` For internal use only.
`String`	`getReCredentialAlias()` Returns the alias value of the credential that grants usage rights.
`String`	`getReCredentialPassword()` Returns the credential password value that grants usage rights.
`String`	`getRenderAtClient()` Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later.
`String`	`getReReaderMessage()` Return a string value that represents the message that is displayed within Adobe Reader to inform users that the form contains usage rights.
`String`	`getRootLocale()` For internal use only.
`String`	`getSeedPDF()` Gets the seed PDF document value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery.
`String`	`getServiceId()` For internal use only.
`String`	`getToolbarMenu()` Used for HTML Toolbar Menu
`String`	`getValidationBorder()` Returns the validation border size in pixels when using frames.
`Integer`	`getValidationReporting()` Returns the position within the frame where validation reporting is displayed if the `ValidationUI` option is 0 (list).
`Integer`	`getValidationUI()` Returns the value of the `ValidationUI` option, which specifies how errors are displayed.
`String`	`getXCI()` Returns the XCI run-time options that represent entries in the XCI configuration file or options that are programmatically set.
`String`	`getXCIURI()` Gets the URI location of the XCI file used for rendering.
`String`	`getXDCURI()` Returns the URI location of an alternative XDC file that is used for rendering.
`Boolean`	`isCacheEnabled()` Specifies whether the Forms service caches a PDF form to boost performance.
`boolean`	`isCB()` Returns the value of the `Cb` option, which specifies the generation of HTML-template initiating content, or guided forms content.
`boolean`	`isClientCache()` Specifies whether the form is cached on the client.
`boolean`	`isDebugEnabled()` Specifies whether the `debugEnabled` option is enabled.
`boolean`	`isEnableViewerPreferences()` This returns the value that specifies whether the PDF Print Options specified during template design would be used or not.
`boolean`	`isGuideAccessible()` Returns the value of the `guideAccessible` option, which specifies whether guided forms compilation is accessible.
`boolean`	`isGuidePDF()` Returns the value of the `guidePDF` option, which specifies that the Forms service data output is rendered in both Flash and PDF.
`boolean`	`isGuideRSL()` Returns the value of the `guideRSL` option that specifies to use run-time shared libraries when compiling guided forms.
`boolean`	`isGuideSubmitAll()` Gets the value of the `GuideSubmitAll` option, which specifies whether guided forms submit all data including hidden panels.
`boolean`	`isLinearizedPDF()` Determines whether the Forms service produces a linearized PDF form (optimized for web applications).
`boolean`	`isPDF2XDP()` Returns the `setPDF2XDP` value.
`boolean`	`isRe2DBarcode()` Returns a Boolean value that specifies whether the `re2DBarcode` option is set.
`boolean`	`isReCommenting()` Returns a Boolean value that specifies whether the `reCommenting` option is set.
`boolean`	`isReCreatePages()` Returns a Boolean value that specifies whether the `reCreatePages` option is set.
`boolean`	`isReDigSig()` Returns a Boolean value that specifies whether the `reDigSig` option is set.
`boolean`	`isReEmbeddedAttachments()` Returns a Boolean value that specifies whether the `reEmbeddedAttachments` option is set.
`boolean`	`isReExpImp()` Returns a Boolean value that specifies whether the `reExpImp` option is set.
`boolean`	`isReFillIn()` Returns a Boolean value that specifies whether the `reFillIn` option is set.
`boolean`	`isReFormFieldMod()` Returns a Boolean value that specifies whether the `reFormFieldMod` option is set.
`boolean`	`isReOnlineCommenting()` Returns a Boolean value that specifies whether the `reOnlineCommenting` option is set.
`boolean`	`isReOnlineForms()` Returns a Boolean value that specifies whether the `reOnlineForms` option is set.
`boolean`	`isReStandaloneSubmit()` Returns a Boolean value that specifies whether the `reStandaloneSubmit` option is set.
`boolean`	`isStandAlone()` Specifies if the `standAlone` option is set to `true`, which results in a form being rendered without state information.
`boolean`	`isTaggedPDF()` Retrieves the value of the `taggedPDF` option, which specifies the use of tagged PDF files to output forms to make them accessible with the help of screen readers.
`boolean`	`isXMLData()` Returns a Boolean value that represents the `xmlData` option that specifies whether the Form service produces the form's XML data based on its current processing state.
`void`	`setAcrobatVersion(String acrobatVersion)` Sets the appropriate PDF version required for a client.
`void`	`setCacheEnabled(Boolean cacheEnabled)` Instructs the Forms service to cache a form in order to improve performance.
`void`	`setCB(boolean cB)` Sets the value of the `Cb` option, which specifies the generation of HTML-template initiating content, or guided forms content.
`void`	`setCharset(String charset)` Sets the character set used to encode the output byte stream.
`void`	`setClientCache(boolean clientCache)` Sets whether the form is cached in the client web browser cache.
`void`	`setClientFrame(String clientFrame)` Sets the client frame to use for HTML transformations.
`void`	`setDebugEnabled(boolean debugEnabled)` Sets the `debugEnabled` option.
`void`	`setDigSigCSSURI(String digSigCSSURI)` Sets the `digSigCSSURI` value.
`void`	`setEnableViewerPreferences(boolean enableViewerPreferences)` This sets the value that specifies whether the PDF Print Options specified during template design would be used or not.
`void`	`setExportDataFormat(String exportDataFormat)` Sets the data format value that controls the format of data that the Forms service exports to a client application.
`void`	`setFontMapURI(String fontMapURI)` Sets the URI location of the font mapping file.
`void`	`setFormModel(String formModel)` Sets the location to where the form is processed.
`void`	`setGuideAccessible(boolean guideAccessible)` Sets the value of the `guideAccessible` option, which specifies whether guided forms compilation is accessible.
`void`	`setGuideCBURL(String guideCBURL)` Sets the value of the `guideCBURL` option, which specifies a custom override implementation of a callback servlet.
`void`	`setGuideName(String guideName)` Sets the name of the specific guide within a guided forms definition.
`void`	`setGuidePDF(boolean guidePDF)` Sets the value of the `guidePDF` option, which specifies that the output is rendered in both Flash and PDF format.
`void`	`setGuideRSL(boolean guideRSL)` Sets the value of the `guideRSL` option that specifies to use run-time shared libraries when compiling guided forms.
`void`	`setGuideStyle(String guideStyle)` Sets the name of the style sheet used by a guided form.
`void`	`setGuideSubmitAll(boolean guideSubmitAll)` Sets the value of the `GuideSubmitAll` option, which specifies whether guided forms submit all data including hidden panels.
`void`	`setIfModifiedSince(String ifModifiedSince)` For internal use only.
`void`	`setImageURL(String imageURL)` Sets the URL that receives image requests from the target device.
`void`	`setInjectFormBridge(boolean injectFormBridge)` Sets the `injectFormBridge` option that specifies whether the Forms service inserts special javascript code into a PDF form.
`void`	`setInternalOption(String key, String val)` For internal use only.
`void`	`setLinearizedPDF(boolean linearizedPDF)` Sets the `linearizedPDF` property that results in the Forms service producing a linearized PDF form.
`void`	`setLocale(String locale)` Sets the locale value that the Forms service uses to send validation messsages to client devices, such as web browsers, when a HTML form is rendered.
`void`	`setOutputType(OutputType outputType)` Sets the output type value that is used by the Forms service to render a form as HTML.
`void`	`setPageNumber(int pageNumber)` The page number value specifies the initial page number to render in a multipage HTML form.
`void`	`setPDF2XDP(boolean pDF2XDP)` Sets the `setPDF2XDP` value.
`void`	`setPDFVersion(String pDFVersion)` Sets the PDF version value that represents the PDF version to output.
`void`	`setRe2DBarcode(boolean re2DBarcode)` Sets the `re2DBarcode` option that enables the Forms service to render forms that contain 2D barcodes and enables a user to fill in the form using Adobe Reader.
`void`	`setReCommenting(boolean reCommenting)` Sets the `reCommenting` option that enables the Forms service to render forms that allow users to add comments to the PDF form using Adobe Reader.
`void`	`setReCreatePages(boolean reCreatePages)` Sets the `reCreatePages` option that enables the Forms service to render forms that allow users to dynamically add pages within Adobe Reader.
`void`	`setReCredentialAlias(String reCredentialAlias)` Sets the alias value of the credential that grants usage rights.
`void`	`setReCredentialPassword(String reCredentialPassword)` Sets the credential password value that grants usage rights.
`void`	`setReDigSig(boolean reDigSig)` Sets the `reDigSig` option that enables the Forms service to render PDF forms that allow users to digitally sign the form using Adobe Reader.
`void`	`setReEmbeddedAttachments(boolean reEmbeddedAttachments)` Sets the `reEmbeddedAttachments` option that enables the Forms service to render PDF forms that allow users to add attachments to the form using Adobe Reader.
`void`	`setReExpImp(boolean reExpImp)` Sets the `reExpImp` option that enables the Forms service to render PDF forms that allow users to import and export form data using Adobe Reader.
`void`	`setReFillIn(boolean reFillIn)` Sets the `reFillIn` option that enables the Forms service to render PDF forms that allow users to fill in form fields and save the PDF form from within Adobe Reader.
`void`	`setReFormFieldMod(boolean reFormFieldMod)` Sets the `reFormFieldMod` option that enables the Forms service to render PDF forms that allow users to modify form fields and save the PDF form from within Adobe Reader.
`void`	`setRenderAtClient(String renderAtClient)` Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later.
`void`	`setReOnlineCommenting(boolean reOnlineCommenting)` Sets the `reOnlineCommenting` option that enables the Forms service to render PDF forms that allow users to add comments within Adobe Reader while online.
`void`	`setReOnlineForms(boolean reOnlineForms)` Sets the `reOnlineForms` option that enables the Forms service to render PDF forms that allow users to interact with a form while online from within Adobe Reader.
`void`	`setReReaderMessage(String reReaderMessage)` Sets the message that is displayed within Adobe Reader to inform users that the form contains usage rights.
`void`	`setReStandaloneSubmit(boolean reStandaloneSubmit)` Sets the `reStandaloneSubmit` option that enables the Forms service to render PDF forms that allows users to submit information from within Adobe Reader.
`void`	`setRootLocale(String rootLocale)` For internal use only.
`void`	`setSeedPDF(String seedPDF)` Sets the seed PDF value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery.
`void`	`setServiceId(String serviceId)` For internal use only.
`void`	`setStandAlone(boolean standAlone)` Sets the `standAlone` option.
`void`	`setTaggedPDF(boolean taggedPDF)` Sets the `taggedPDF` option that results in the Forms service creating a tagged PDF form.
`void`	`setToolbarMenu(String toolbarMenu)` Used for HTML Toolbar Menu
`void`	`setValidationBorder(String validationBorder)` Sets the validation border size in pixels when using frames.
`void`	`setValidationReporting(Integer validationReporting)` Sets the position within the frame where validation reporting is displayed if the `ValidationUI` option is 0 (list).
`void`	`setValidationUI(Integer validationUI)` Sets the value of the `ValidationUI` option, which specifies how errors are displayed.
`void`	`setXCI(String xCI)` Sets XCI run-time options that are executed when `processFormSubmission()` or one of the form rendering methods are invoked.
`void`	`setXCIURI(String xCIURI)` Sets the URI location of the XCI file used for rendering.
`void`	`setXDCURI(String xDCURI)` Sets the URI location of an alternative XDC file that is used for rendering.
`void`	`setXMLData(boolean xMLData)` Sets the `xmlData` option that instructs the Form service to produce the form's XML data based on its current processing state.
`String`	`toString()` For internal use only.
`void`	`updateOptionsBean(String options)` For internal purposes only.
`void`	`updateOptionsBean(String key, String value)` For internal purposes only.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

RenderOptionsSpec

public RenderOptionsSpec()

A standard constructor.

RenderOptionsSpec

public RenderOptionsSpec(String sOptions)
                  throws FormServerException

For internal use only. Do not invoke this method.

Throws:: FormServerException

RenderOptionsSpec

public RenderOptionsSpec(OutputType outputType,
                         String charset,
                         String locale,
                         int pageNumber,
                         Boolean cacheEnabled,
                         Integer validationUI,
                         Integer validationReporting,
                         String validationBorder,
                         String acrobatVersion,
                         String pDFVersion,
                         boolean xMLData,
                         boolean taggedPDF,
                         boolean linearizedPDF,
                         boolean pDF2XDP,
                         String seedPDF,
                         String renderAtClient,
                         String clientFrame,
                         String imageURL,
                         boolean clientCache,
                         String exportDataFormat,
                         boolean standAlone,
                         String formModel,
                         String xDCURI,
                         String xCIURI,
                         String fontMapURI,
                         String xCI,
                         String serviceId,
                         String rootLocale,
                         String digSigCSSURI,
                         String toolbarMenu,
                         boolean debugEnabled,
                         String ifModifiedSince,
                         String guideName,
                         boolean guideRSL,
                         boolean guidePDF,
                         boolean guideAccessible,
                         String guideCBURL,
                         boolean cB,
                         String guideStyle,
                         boolean guideSubmitAll,
                         boolean injectFormBridge,
                         String reCredentialAlias,
                         String reCredentialPassword,
                         String reReaderMessage,
                         boolean re2DBarcode,
                         boolean reCommenting,
                         boolean reCreatePages,
                         boolean reDigSig,
                         boolean reEmbeddedAttachments,
                         boolean reExpImp,
                         boolean reFillIn,
                         boolean reFormFieldMod,
                         boolean reOnlineCommenting,
                         boolean reOnlineForms,
                         boolean reStandaloneSubmit)

A constructor that enables you to set all options. For internal use only.

Method Detail

getAcrobatVersion

public String 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(String 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

isCacheEnabled

public Boolean isCacheEnabled()

Specifies whether the Forms service caches a PDF form to boost performance. Each form is cached after it is generated for the first time. On a subsequent render, if the cached form is newer than the form design's timestamp, the form is retrieved from the cache. The value true means that the form is cached.

Returns:: A Boolean value that specifies whether a form is cached.
See Also:: setCacheEnabled()

getCacheEnabled

public Boolean getCacheEnabled()

Returns:: A Boolean value that specifies whether a form is cached.
See Also:: setCacheEnabled()

setCacheEnabled

public void setCacheEnabled(Boolean cacheEnabled)

Instructs the Forms service to cache a form in order to improve performance. Each form is cached after it is generated for the first time. On a subsequent render, if the cached form is newer than the form design's timestamp, the form 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.

getCharset

public String getCharset()

Gets the character set used to encode the output byte stream. The Forms service supports character encoding values defined by the java.nio.charset package for HTML transformations.

Returns:: The character set used to encode the output byte stream.
See Also:: setCharset()

setCharset

public void setCharset(String charset)

Sets the character set used to encode the output byte stream. The Forms service supports character encoding values defined by the java.nio.charset package for HTML transformations.

Parameters:: charset - The character set used to encode the output byte stream.

isClientCache

public boolean isClientCache()

Specifies whether the form is cached on the client.

Returns:: A Boolean value that specifies whether the form is cached on the client.
See Also:: setClientCache()

setClientCache

public void setClientCache(boolean clientCache)

Sets whether the form is cached in the client web browser cache. Only forms that are rendered as interactive forms can be stored in the client web browser cache. When subsequent requests for the PDF form are made, a time stamp located in the cached PDF form is compared with the time stamp of the PDF form that is generated by the Forms service and stored in the server cache. If they are the same, the PDF form is retrieved from the client cache. This results in reduced bandwidth usage and improves performance because the Forms service does not have to redeliver the same content to the client web browser.

Parameters:: clientCache - A Boolean value that specifies whether the form is cached on the client.

isEnableViewerPreferences

public boolean isEnableViewerPreferences()

This returns the value that specifies whether the PDF Print Options specified during template design would be used or not. The options supplied during form design will override the default XCI options. But these options cannot override the PDF Print Options specified in customer user specified XCI.

Returns:: A boolean value

setEnableViewerPreferences

public void setEnableViewerPreferences(boolean enableViewerPreferences)

This sets the value that specifies whether the PDF Print Options specified during template design would be used or not. The options supplied during form design will override the default XCI options. But these options cannot override the PDF Print Options specified in customer user specified XCI.

Parameters:: enableViewerPreferences - A Boolean value that specifies whether to enable Viewer Preferences or not.

getClientFrame

public String getClientFrame()

Returns a string value that specifies the client frame to use for HTML transformations. This value is not applicable for PDF forms.

Returns:: The client frame to use.
See Also:: setClientFrame()

setClientFrame

public void setClientFrame(String clientFrame)

Sets the client frame to use for HTML transformations. This value is not applicable for PDF forms.

Parameters:: clientFrame - The client frame to use.

isDebugEnabled

public boolean isDebugEnabled()

Specifies whether the debugEnabled option is enabled.

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

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.

getExportDataFormat

public String getExportDataFormat()

Gets the format of the data that the Forms service exports to a client application. The following values are supported:

XDP - returns the data with xdp packaging.
XDP.toXFAData - returns the data with xdp packaging and data in the xfa:datasets packet (xfdf is converted to xfa data).
XDP.DataOnly - xdp format but without embedded PDF or XFA template packet.
XMLData - returns the data without XDP or xfa:datasets packaging.
Auto - automatically determines the format based on the submitted data.

Returns:: The export data format value.

setExportDataFormat

public void setExportDataFormat(String exportDataFormat)

Sets the data format value that controls the format of data that the Forms service exports to a client application. This method sets the data format value to one of the following values:

XDP - returns the data with xdp packaging.
XDP.toXFAData - returns the data with xdp packaging and data in the xfa:datasets packet (xfdf is converted to xfa data).
XDP.DataOnly - xdp format but without embedded PDF or XFA template packet.
XMLData - returns the data without XDP or xfa:datasets packaging.
Auto - automatically determines the format based on the submitted data.

If XDP is submitted, then XDP.toXFAData is returned. If XMLData is submitted, then XMLData is returned. If URL encoded data is submitted, then XMLData is returned.

Parameters:: exportDataFormat - The export data format value to set.

getFontMapURI

public String getFontMapURI()

Specifies the URI location of the font mapping file. Font mapping defines which fonts are used in a form if a specified font is not available. That is, you can specify which font to substitute for an unavailable font. If the root is not specified, the file is assumed to reside in the LiveCycle.ear file.

Returns:: The location of the font mapping file.

setFontMapURI

public void setFontMapURI(String fontMapURI)

Sets the URI location of the font mapping file. Font mapping defines which fonts are used in a form if a specified font is not available. That is, you can specify which font to substitute for an unavailable font.

Parameters:: fontMapURI - The URI location of the font mapping file to use.

getFormModel

public String getFormModel()

Gets the location to where the form is processed. The following values are supported:

auto
servercode
client
both

Returns:: A value that specifies where the form is processed.
See Also:: setFormModel()

setFormModel

public void setFormModel(String formModel)

Sets the location to where the form is processed. If this value is set to client, the form is passed to the client device without processing. The following values are supported:

auto
servercode
client
both

Parameters:: formModel - The location to where the form is processed.

getImageURL

public String getImageURL()

Returns the URL that receives image requests from the target device. This URL is inserted into the transformed output to facilitate retrieval of embedded images (for example, images embedded within an XDP form). This is only required in cases where authentication is required to retrieve the images. If not an absolute value, the sApplicationWebRoot value is combined with this value to construct an absolute URL.

Returns:: The URL value that receives image requests from target devices.
See Also:: setImageURL()

setImageURL

public void setImageURL(String imageURL)

Sets the URL that receives image requests from the target device. This URL is inserted into the transformed output to facilitate retrieval of embedded images (for example, images embedded within an XDP form). This is only required in cases where authentication is required to retrieve the images. If not an absolute value, the sApplicationWebRoot value is combined with this value to construct an absolute URL.

Parameters:: imageURL - The URL that receives image requests from the target device.

isLinearizedPDF

public boolean isLinearizedPDF()

Determines whether the Forms service produces a linearized PDF form (optimized for web applications). 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 Booelan value that specifies whether the forms service produces a linearized PDF form.

setLinearizedPDF

public void setLinearizedPDF(boolean linearizedPDF)

Sets the linearizedPDF property that results in the Forms service producing a linearized PDF form. 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 Forms service producing a linearized PDF form.

getLocale

public String getLocale()

Gets a locale value that is used by the Forms service to send validation messsages to client devices, such as web browsers, as part of HTML transformations.

Returns:: A string value that represents the locale value.
See Also:: setLocale()

setLocale

public void setLocale(String locale)

Sets the locale value that the Forms service uses to send validation messsages to client devices, such as web browsers, when a HTML form is rendered.

Parameters:

locale - The locale value to set. The following table lists valid values:

Locale	Description
`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)

getOutputType

public OutputType getOutputType()

Returns the output type value that specifies how a form that is rendered as HTML is displayed. The following values are valid:

0 - The form is rendered within full HTML tags (a complete HTML page).
1 - The form is rendered within body tags (not a complete HTML page).

Returns:: Returns the output type value that is used by the Forms service.
See Also:: setOutputType()

setOutputType

public void setOutputType(OutputType outputType)

Sets the output type value that is used by the Forms service to render a form as HTML. An output type value specifies how a form that is rendered as HTML is displayed. The following values are valid:

0 - The form is rendered within full HTML tags (a complete HTML page).
1 - The form is rendered within body tags (not a complete HTML page).

Parameters:: outputType - The output type value to set.

getPageNumber

public int getPageNumber()

The page number value specifies the initial page number to render in a multipage HTML form. This option is not applicable to PDF forms.

Returns:: The initial page number to render in a multipage HTML form.
See Also:: setPageNumber()

setPageNumber

public void setPageNumber(int pageNumber)

The page number value specifies the initial page number to render in a multipage HTML form. This option is not applicable to PDF forms.

Parameters:: pageNumber - The page number value to set.

isPDF2XDP

public boolean isPDF2XDP()

Returns the setPDF2XDP value. This value instructs the Forms service to produce XDP output from submitted PDF content. By default, the Forms service returns the PDF that is submited. The XDP will contain a PDF packet (base64-encoded). A datasets packet contains form data if the PDF is XFA-based. An XFDF packet stores annotations (annots). The XFDF packet contains (fields) elements if the PDF is an Acrobat form.

Returns:: The setPDF2XDP value.
See Also:: setPDF2XDP()

setPDF2XDP

public void setPDF2XDP(boolean pDF2XDP)

Sets the setPDF2XDP value. Setting this value to true instructs the Forms service to produce XDP output from submitted PDF content. By default, the Forms service returns the PDF that is submited. The XDP will contain a PDF packet (base64-encoded). A datasets packet contains form data if the PDF is XFA-based. An XFDF packet stores annotations (annots). The XFDF packet contains (fields) elements if the PDF is an Acrobat form.

Parameters:: pDF2XDP - A Boolean value that sets the setPDF2XDP value.

getPDFVersion

public String getPDFVersion()

Gets the PDF version value that represents the PDF version to output. Acrobat 6.0 supports PDF version 1.5, Acrobat 7.0 or later supports PDF version 1.6, and Acrobat 8.0 or later supports PDF version 1.7. The following values are valid:

1.5
1.6
1.7

Returns:: The PDF version value.

setPDFVersion

public void setPDFVersion(String pDFVersion)

Sets the PDF version value that represents the PDF version to output. Acrobat 6.0 supports PDF version 1.5, Acrobat 7.0 or later supports PDF version 1.6, and Acrobat 8.0 or later supports PDF version 1.7. The following values are valid:

1.5
1.6
1.7

Parameters:: pDFVersion - The PDF version value.

getRenderAtClient

public String getRenderAtClient()

auto - Instructs the Forms 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.
See Also:: setRenderAtClient()

setRenderAtClient

public void setRenderAtClient(String renderAtClient)

Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later. Client-side rendering improves the performance of the Forms service and only applies to PDFForm, or PDFMerge transformations. When set to auto and AcrobatVersion is set to acrobat7.0.5 (or later), then a form is rendered to a client once, which improves the performance of the Form service. The rendered form behaves as a non-interactive form. The following renderAtClient values are valid:

auto - Instructs the Forms 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.

getSeedPDF

public String getSeedPDF()

Gets the seed PDF document value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery. The seed PDF document specifies a customized PDF document (contains only fonts) that is appended with a form design and data. The form is rendered by Acrobat 7.0 or later and applies to PDFForm transformations.

Returns:: The name of the PDF document that represents the seed PDF document.
See Also:: setSeedPDF()

setSeedPDF

public void setSeedPDF(String seedPDF)

Sets the seed PDF value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery. The seed PDF document specifies a customized PDF document (contains only fonts) that is appended with a form design and data. The form is rendered by Acrobat 7.0 or later and applies to PDFForm transformations.

Parameters:: seedPDF - The name and location of the PDF document that represents the seed PDF document.

isStandAlone

public boolean isStandAlone()

Specifies if the standAlone option is set to true, which results in a form being rendered without state information. State information is used to render an interactive form to an end user who then enters information into the form and submits the form back to the Form service. The Form service then performs a calculation operation and renders the form back to the user with the results displayed in the form.

In an HTML transformation, javascript is embedded instead of linked content so that it can be used while disconnected from the Form service. Set this option to true if you are using the Form service for rendering purposes and are running scripts that are located within the form while disconnected from the Form service.

Returns:: The value of the standAlone option.
See Also:: setStandAlone()

setStandAlone

public void setStandAlone(boolean standAlone)

Sets the standAlone option. If set to true, a form is rendered without state information. State information is used to render an interactive form to an end user who then enters information into the form and submits the form back to the Form service. The Form service then performs a calculation operation and renders the form back to the user with the results displayed in the form.

Parameters:: standAlone - The value of standAlone option.

isTaggedPDF

public boolean isTaggedPDF()

Retrieves the value of the taggedPDF option, which specifies the use of tagged PDF files to output forms to make them accessible with the help of screen readers. Tagged PDF files are not supported in PDF versions prior to version 1.4. The following values are valid:

0 - false
1 - true

Returns:: The value of the taggedPDF option.
See Also:: setTaggedPDF()

setTaggedPDF

public void setTaggedPDF(boolean taggedPDF)

Sets the taggedPDF option that results in the Forms service creating a tagged PDF form. A tagged PDF form 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 (accessible with the help of screen readers).

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 Forms service producing a tagged PDF form.

getValidationBorder

public String getValidationBorder()

Returns the validation border size in pixels when using frames.

Returns:: The size of the validation border.

setValidationBorder

public void setValidationBorder(String validationBorder)

Sets the validation border size in pixels when using frames.

Parameters:: validationBorder - The validation border size in pixels.

getValidationReporting

public Integer getValidationReporting()

Returns the position within the frame where validation reporting is displayed if the ValidationUI option is 0 (list). The following values are supported:

0 - FrameLeft
1 - FrameRight
2 - FrameTop
3 - FrameBottom
4 - NoFrameLeft
5 - NoFrameRight
6 - NoFrameTop
7 - NoFrameBottom
8 - None
9 - NoUI
10-NoUIWithForm

Returns:: The position within the frame where validation reporting is displayed.
See Also:: setValidationReporting()

setValidationReporting

public void setValidationReporting(Integer validationReporting)

Sets the position within the frame where validation reporting is displayed if the ValidationUI option is 0 (list). By setting this value, you specify whether the list appears within a frame, and the location of the list relative to the form. This option is valid for forms that are rendered as HTML. The following values are valid:

0 - FrameLeft
1 - FrameRight
2 - FrameTop
3 - FrameBottom
4 - NoFrameLeft
5 - NoFrameRight
6 - NoFrameTop
7 - NoFrameBottom
8 - None
9 - NoUI
10-NoUIWithForm

Parameters:: validationReporting - The position within the frame where validation reporting is displayed.

getValidationUI

public Integer getValidationUI()

Returns the value of the ValidationUI option, which specifies how errors are displayed. These values are valid:

0 - list
1 - message box

Returns:: The value of the ValidationUI option.

setValidationUI

public void setValidationUI(Integer validationUI)

Sets the value of the ValidationUI option, which specifies how errors are displayed. These values are valid:

0 - list
1 - message box

Parameters:: validationUI - The value of the ValidationUI option.

getXCI

public String getXCI()

Returns the XCI run-time options that represent entries in the XCI configuration file or options that are programmatically set.

Returns:: A string value that represents XCI run-time values.
See Also:: setXCI()

setXCI

public void setXCI(String xCI)

Sets XCI run-time options that are executed when processFormSubmission() or one of the form rendering methods are invoked. By setting XCI run-time options, you can change configuration values that are located within the XCI configuration file that the Forms service uses. The ability to set XCI run-time options is optional. You define XCI run-time options by passing the following string value to this method:

XCI=[path-expression]=[value];[path-expression]=[value];...[path-expression]=[value];

[path-expression] is an XPath expression that is relative to the configuration root element representing the element to update, and [value] is the value to assign to the path expression. If the value is omitted, the element is cleared. Only simple XPath expressions that contain "/" and "@" characters are supported.

The following example changes the default typeface to MyriadPro:

XCI=present/pdf/fontInfo/defaultTypeface=MyriadPro

Setting XCI options can affect the resulting PDF form. For example, consider the following XCI options:

XCI=present/pdf/fontInfo/embed=1&PDFVersion=1.6 XCI=present/pdf/fontInfo/embed=1

The size of the resulting files is different. When you set the PDF version to 1.6, the Forms service embeds the fonts as a subset. When you do not set the PDF version, the Forms service fully embeds the font. The one that contains the fully embedded font is at least twice as large as the file that has the fonts embedded as subset. Specify the PDF version to embed the font as a subset.

Parameters:

xCI - The XCI run-time value to set. The following table lists XCI run-time options.

XCI Expression	Element Name	Description
`acrobat.acrobat7.dynamicRender`	`dynamicRender`	Specifies whether the form can be dynamically rendered in Acrobat. Valid values are `required` or `forbidden`.
`data.outputXSL.uri`	`uri` (child of `outputXSL` element)	Specifies the fully qualified path or URL of an XSLT script. When specified, this option invokes an XSLT interpreter to process the supplied data before loading it into the XML Forms Architecture Data DOM. For example: `data.outputXSL.uri=http://www.mysite.com/xsl/data/loan.xsl`
`data.range`	`range`	Controls which records are processed. The range option specifies the records that are to be processed. The value of `range` is a comma-separated list of one or more record numbers and/or record number ranges. A record number is a non-negative decimal integer, where `0` (zero) indicates the first record. A record number range is a record number, followed by a dash (`-`) character, followed by another record number which is numerically equal to or greater than the other record number. Record number ranges and record numbers can overlap, as in the following example: `data.range=3-5,9,4,5-6` This causes records 3, 4, 5, 6, and 9 to be processed, and all other records to be ignored.
`data.record`	`record`	Controls the division of the document into records. Records are processed sequentially as separate documents. The value of record is either an integer or a tag name. If the value of `record` is an integer, it specifies the level in the tree at which the LiveCycle Forms treats each node as the root of a record. `0` represents the root of the whole XML Data DOM. For example, if the value is `2`, each element that is two levels in from the outermost element is considered as enclosing a record. If the value of `record` is not an integer, it is interpreted as a tag name. The first element in the XML data file with a tag matching the value of `record` determines the level of a record within the tree. LiveCycle Forms processes nodes as records in the XML Forms Architecture Data DOM that correspond to the same level and have a name matching the value of record as root nodes. By default, LiveCycle Forms considers the document range to enclose one record of data represented by the first (top-level) data group within the document range. For example, the following XML data file contains a single record, which is the element <order>, and represents the top-level data group within the document range: `<order> <number>1</number> <shipto> <customer>c001</customer> </shipto> <item> <book> <ISBN>15536455</ISBN> <title>Introduction to XML</title> <quantity>1</quantity> <unitprice>55.00</unitprice> </book> </item> <item> <book> <ISBN>15536456</ISBN> <title>Advanced XML</title> <quantity>1</quantity> <unitprice>75.00</unitprice> </book> </item> </order>` To nominate the item elements as records, specify `data.record=item`. LiveCycle Forms processes each record in the XML data file as a separate document. To nominate only the second item element as a record, specify `data.record=2`. LiveCycle Forms processes only the second item element in the XML data file.
`data.startNode`	`startNode`	Identifies the root of the subtree that is processed. LiveCycle Forms does not process any data outside the subtree. The expression in the startNode element is restricted to a fully qualified path of element types (tag names), starting with the root of the XML data document and referring to a single element. This option affects processing during every phase. For example, consider this XML data file: `<order> <number>1</number> <shipto> <customer>c001</customer> </shipto> <item> <book> <ISBN>15536455</ISBN> <title>Introduction to XML</title> <quantity>1</quantity> <unitprice>55.00</unitprice> </book> </item> <item> <book> <ISBN>15536456</ISBN> <title>Advanced XML</title> <quantity>1</quantity> <unitprice>75.00</unitprice> </book> </item> </order>` To process only the first item, specify `data.startNode="xfasom(order.item)"`. To process only the second item, specify `data.startNode="xfasom(order.item[2].book)"`.
`data.xsl.debug.uri`	`uri` (child of `debug` element; descendant of `data` element)	Specifies the fully qualified path or URL where LiveCycle Forms saves a copy of the preprocessed XML data after the XSLT interpreter has created it. It is intended for debugging the XSLT script. This option takes effect during the data loading phase. For example: `data.xsl.debug.uri=http://www.mysite.com/xsl/debug/loan.xdp`.
`data.xsl.uri`	`uri` (child of `xsl` element; descendant of `data` element)	Specifies the fully qualified path or URL of an XSLT script. When specified, this option invokes an XSLT interpreter to process the supplied XML data before loading it into the XML Forms Architecture Data DOM. This option takes effect during the data loading phase. For example: `data.xsl.uri=http://www.mysite.com/xsl/loan.xsl`.
`destination`	`destination`	Specifies the output format when rendering documents.
`fontInfo.defaultTypeface`	`defaultTypeface`	Sets a default font to use when the font is not available.
`locale`	`locale`	Specifies the locale to use when rendering documents. For a listing, see Developing Applications Using LiveCycle ES APIs.
`pdf.compression.compressLogicalStructure`	`compressLogicalStructure`	Used to generate PDF documents with the logical structure compressed. Normally, the structure is not compressed and therefore increases the size of the document. This feature was introduced by Acrobat 6. The default value is off (`0`) for LiveCycle Forms, but it is defaulted to on (`1`) when a form author saves a PDF from Designer. If you use this option to compress the logical structure, that logical structure cannot be used by Acrobat 5 or earlier versions. The PDF will still open in Acrobat 5; however, to users, it will look as if the document has no logical structure (used for accessibility and tabbing order). These values are acceptable: `0` - Do not compress the logical structure. `1` - Compress the logical structure.
`pdf.compression.level`	`level`	When `destination` is `pdf`, it specifies the degree of compression to use when generating a file. These values are acceptable: `0` - Disable compression. `1-9` - Enable compression. The value `1` represents the best speed, and the value `9` represents the best compression. The default compression level is `6`.
`pdf.compression.type`	`type`	When `destination` is `pdf`, it specifies the type of compression to apply to a file. The following values are valid: `none` - Does not compress the output. This value is the default. `ccittfax3` - CCITT T.4 bi-level encoding. It only works for monochrome TIFF images. `ccittfax4` - CCITT T.6 bi-level encoding. It offers better compression than `ccittfax3` and is only for monochrome TIFF images. `ccittr1e` - A run length compression that is used only for monochrome TIFF image files. `packbit` - A run length compression scheme that works for monochrome or color image files.
`pdf.encryption.encrypt`	`encrypt`	Determines whether the output document is encrypted. The following values are valid: `0` - Do not encrypt. This value is the default. `1` - Encrypt.
`pdf.encryption.encryptionLevel`	`encryptionLevel`	Specifies the length of the encryption key to use. The default and only acceptable value is `40bit`.
`pdf.encryption.masterPassword`	`masterPassword`	Specifies the password (as a string) required to open an encrypted PDF document that has unlimited access rights.
`pdf.encryption.permissions.accessibleContent`	`accessibleContent`	Controls the ability of accessibility aids to copy text or graphics from the document. Accessibility aids such as screen readers need to copy text from the document into their own buffers. This options sets a permission flag that controls the ability of programs to extract text or graphics from the document. Once extracted, the data may be used for any purpose. This permission flag applies only when an encrypted PDF document is opened using the user password. No restrictions apply if the document is not encrypted or if it is opened using the master password. The following values are valid: `0` - Disable copying to accessibility aids. This value is the default. `1` - Enable copying to accessibility aids.
`pdf.encryption.permissions.contentCopy`	`contentCopy`	Enables or disables the user's ability to copy text or graphics from the document. This option applies only when an encrypted PDF document is opened using the user password. No restrictions apply if the document is not encrypted or if it is opened using the master password. These values are acceptable: `0` - Disable copying. This value is the default. `1` - Enable copying.
`pdf.encryption.permissions.documentAssembly`	`documentAssembly`	Controls the user's ability to reassemble the PDF document. This option controls whether the user has the right to insert, delete, or rotate pages, and create navigation elements such as bookmarks and thumbnail images. If permission is granted, the user has these rights, even if the document is encrypted or if it is opened using the master password. These values are acceptable: `0` - Disable insertion, deletion, or rotation of pages, and creation of navigation elements. `1` - Enable insertion, deletion, or rotation of pages, and creation of navigation elements.
`pdf.encryption.permissions.formFieldFilling`	`formFieldFilling`	Controls the user's ability to enter data into existing form fields. This option sets a permission flag that controls the user's ability to fill in form fields, including signature fields. If permission is granted, the user can fill in fields regardless of the content of the `pdf.encryption.permissions.modifyAnnots` option. This permission flag applies only when an encrypted PDF document is opened using the user password. No restrictions apply if the document is not encrypted or if it is opened using the master password. The following values are valid: `0` - Disable filling in form fields. This value is the default. `1` - Enable filling in form fields.
`pdf.encryption.permissions.modifyAnnots`	`modifyAnnots`	Controls the user's ability to modify the annotation layer of the document. This option sets a permission flag that grants the user the ability to add or modify text annotations and, if the change option grants permission, to create or modify interactive form fields (including signature fields). This option can also grant the user the ability to fill in existing fields of a form, but that permission can also be granted independently by the `pdf.encryption.permissions.formFieldFilling` option. The following values are valid: `0` - Disable modification of the annotation layer. This value is the default. `1` - Enable modification of the annotation layer.
`pdf.encryption.permissions.plaintextMetadata`	`plaintextMetadata`	Decrypts the metadata in the output PDF document. Document metadata is represented by an XML stream contained within the output PDF document. However, if the document is encrypted, the metadata is also encrypted by default. This option decrypts the metadata stream even if the rest of the document is encrypted. The following values are valid: `0` - Encrypt the metadata if the rest of the document is encrypted. This value is the default. `1` - Do not encrypt the metadata even if the rest of the document is encrypted.
`pdf.encryption.permissions.print`	`print`	Controls the user's ability to print the PDF document. The printed copy may be degraded in appearance compared to the original, depending on the content of the `pdf.encryption.permissions.printHighQuality` option. This permission flag applies only when an encrypted PDF document is opened using the user password. No restrictions apply if the document is not encrypted or if it is opened using the master password. The following values are valid: `0` - Disable printing. This value is the default. `1` - Enable printing.
`pdf.encryption.permissions.printHighQuality`	`printHighQuality`	Controls the user's ability to print the PDF document with high fidelity and as much detail as the original document. This permission flag applies only when an encrypted PDF document is opened using the user password. No restrictions apply if the document is not encrypted or if it is opened using the master password. The following values are valid: `0` - Disable high-fidelity printing. This value is the default. `1` - Enable high-fidelity printing.
`pdf.encryption.permissions.change`	`change`	Controls the user's ability to make changes to the PDF document. This option controls the permission flag that grants the user permission to modify the contents of the document by any means not controlled by the `pdf.encryption.permissions.modifyAnnots` option, the `pdf.encryption.permissions.formFieldFilling` option, or the `pdf.encryption.permissions.documentAssembly` option. For example, this option controls the user's ability to edit the boilerplate. The following values are valid: `0` - Disable changes. This value is the default. `1` - Enable changes.
`pdf.encryption.userPassword`	`userPassword`	Specifies the password (as a string) required to open an encrypted PDF document that has user access rights.
`pdf.fontInfo.embed`	`embed`	Controls the embedding of fonts in the output document. If the fonts are not embedded, the client computer or printer may not be able to reproduce the text properly. Particular fonts may have license restrictions that prohibit embedding. The following values are valid: `0` - Do not embed the fonts in the output document, except where overridden by the `alwaysEmbed` element. This value is the default. `1` - Embed whatever fonts can be embedded in the output document.
`pdf.fontInfo.encodingSupport`	`encodingSupport`	Specifies a list of non-Unicode character encodings. Defining the list in advance may improve performance. When not specified, encoding tables are initialized when first encountering a non-Unicode encoding. For a complete list, see Developing Applications Using LiveCycle ES APIs.
`pdf.fontInfo.map.equate`	`equate`	Supplies mappings from one specified typeface to another during the rendering of a document. Use this option to deal with typefaces specified in the XDC file that are not available on the printer or display device, as in the following example: `<equate from="Arial_normal_normal", to="Arial_bold_italic">` The example changes the font for text that is specified as plain Arial to bold, italicized Arial in the generated output.
`pdf.fontInfo.subsetBelow`	`subsetBelow`	Specifies a usage threshold below which an embedded font is reduced to the subset of symbols that are actually used. A font is sometimes used only for a few characters in a document. It is not necessary to embed the entire font if only a portion of it is used. This option sets a usage threshold below which only the used subset is embedded. Above the threshold, the entire font is embedded, if possible. This option has no effect for fonts that are used in data entry fields. If the font is embedded, it is embedded in its entirety. This option does not apply to fonts that are not embedded. Embedded fonts are controlled by the `pdf.fontInfo.embed` and `alwaysEmbed` options. This option has no effect for fonts that are used in data entry fields. If the font is embedded, it is embedded in its entirety. The value is a positive integer from `0` to `100`, inclusive. The default value for this option is `100`, which subsets all embedded fonts that are not used in data entry fields.
`pdf.interactive`	`interactive`	Specifies whether a PDF form should be generated as a flat form for printing or as an interactive form for online use. There are two ways to use a PDF document. One is to print it. The other is to use client software with a user interface that enables interaction with the document. The content of this option indicates which way the output document is used. The following values are valid: `0` - The form is printed for filling off-line. Interactive user interface objects such as fields and radio buttons are rendered as boilerplate, and the annotation layer is empty. This value is the default. `1` - The form is filled online using a suitable client program. Interactive user interface objects are placed into the annotation layer.
`pdf.openAction.destination`	`destination`	Specifies the action to be performed when opening the document in an interactive client. The following values are valid: `none` - No special action is performed. The document is displayed using default behavior. This value is the default. `pageFit` - The document is resized to fit the window.
`pdf.submitFormat`	`submitFormat`	Specifies the format in which the form data is sent to the server. This option applies only to interactive PDF documents. The content of the `submitFormat` element determines the settings for bits 3 (ExportFormat), 9 (SubmitPDF), and 6 (XFDF) in the submit-form action as described in the PDF 1.5 specification. The following values are valid: `html` - The data is submitted in HTML. `delegate` - The format is determined by the server and client at run time. `fdf` - The data is submitted in XFDF. `xml` - The data is submitted in XML. `pdf` - The data is submitted in PDF.
`pdf.tagged`	`tagged`	Controls whether tags are included in the output PDF document. Tags, in the context of PDF, are additional information included in a document to expose the logical structure of the document. Tags assist accessibility aids and reformatting. For example, a page number may be tagged as an `"artifact"` so that a screen reader does not enunciate it in the middle of the text. Although tags make a document more useful, they also increase the size of the document and the processing time to create it. The following values are valid: `0` - Do not insert tags. This value is the default. `1` - Insert tags.
`pdf.xdc.uri`	`uri`	Specifies the path of the XDC file, `acrobat7.xdc`, which is deployed in the same directory as the LiveCycle Forms during the installation. The XDC file contains information such as the available fonts. LiveCycle Forms uses the device control information in the current directory to render PDF documents, as in the following example: `form.setConfigValue("pdf.xdc.uri", "acrobat7.xdc")`
`present.pdf.linearized`	`linearized`	Allows the PDF to be linearized which means it's saved for faster web viewing.
`present.pdf.renderPolicy`	`renderPolicy`	Indicates whether the form is to be rendered on the server or on the client. Valid values are `server` and `client`.
`temp.uri`	`uri` (descendant of `pdf` element)	Specifies the location of temporary files. When specified, it overrides the system default location for temporary files.
`template.base`	`base` (descendant of `temp` element)	Specifies the base location for URIs in the form design. When this option is not specified, the location of the form design is used as the base. The value is a URI that specifies the fully qualified path pointing to the location of include files. This option can be set by a separate document (or even a script).

getXCIURI

public String getXCIURI()

Gets the URI location of the XCI file used for rendering. If the root is not specified, the file is assumed to reside in the LiveCycle.ear file.

Returns:: The URI location of the XCI file.

setXCIURI

public void setXCIURI(String xCIURI)

Sets the URI location of the XCI file used for rendering. If the root is not specified, the file is assumed to reside in the LiveCycle.ear file.

Parameters:: xCIURI - The URI location of the XCI file.

getXDCURI

public String getXDCURI()

Returns the URI location of an alternative XDC file that is used for rendering. The option can be set to a valid URI, an absolute URI with protocols, or a file location.

Returns:: The URI location of an alternative XDC file.
See Also:: setXDCURI()

setXDCURI

public void setXDCURI(String xDCURI)

Sets the URI location of an alternative XDC file that is used for rendering. The option can be set to a valid URI, an absolute URI with protocols, or a file location. An alternative XDC file is used in situations where the Forms service cannot locate an XDC file (for example, there may be a network issue).

Parameters:: xDCURI - The URI location of an alternative XDC file.

isXMLData

public boolean isXMLData()

Returns a Boolean value that represents the xmlData option that specifies whether the Form service produces the form's XML data based on its current processing state.

Returns:: A Booelan value that specifies whether the xmlData option is set.
See Also:: setXMLData()

setXMLData

public void setXMLData(boolean xMLData)

Sets the xmlData option that instructs the Form service to produce the form's XML data based on its current processing state.

Parameters:: xMLData - A Boolean value that represents the xmlData option.

getServiceId

public String getServiceId()

For internal use only.

setServiceId

public void setServiceId(String serviceId)

For internal use only.

getRootLocale

public String getRootLocale()

For internal use only.

setRootLocale

public void setRootLocale(String rootLocale)

For internal use only.

getDigSigCSSURI

public String getDigSigCSSURI()

Returns the digSigCSSURI value. This value specifies a custom stylesheet for a digital signature user interface in HTML forms.

Returns:: A string value that represents the digSigCSSURI value.

setDigSigCSSURI

public void setDigSigCSSURI(String digSigCSSURI)

Sets the digSigCSSURI value. This value specifies a custom stylesheet for a digital signature user interface in HTML forms.

Parameters:: digSigCSSURI - A string value that represents the digSigCSSURI value.

getToolbarMenu

public String getToolbarMenu()

Used for HTML Toolbar Menu

setToolbarMenu

public void setToolbarMenu(String toolbarMenu)

Used for HTML Toolbar Menu

getIfModifiedSince

public String getIfModifiedSince()

For internal use only.

setIfModifiedSince

public void setIfModifiedSince(String ifModifiedSince)

For internal use only.

getGuideName

public String getGuideName()

Returns the name of the specific guide within a guided forms definition.

Returns:: The name of the specific guide within a guided forms definition.

setGuideName

public void setGuideName(String guideName)

Sets the name of the specific guide within a guided forms definition.

Parameters:: guideName - The name of the specific guide within a guided forms definition.

isGuideRSL

public boolean isGuideRSL()

Returns the value of the guideRSL option that specifies to use run-time shared libraries when compiling guided forms. The following values are valid:

0 - false
1 - true

Returns:: The value of the guideRSL option.

setGuideRSL

public void setGuideRSL(boolean guideRSL)

Sets the value of the guideRSL option that specifies to use run-time shared libraries when compiling guided forms. The following values are valid:

0 - false
1 - true

Parameters:: guideRSL - A Boolean value that specifies the value of the guideRSL option.

isGuidePDF

public boolean isGuidePDF()

Returns the value of the guidePDF option, which specifies that the Forms service data output is rendered in both Flash and PDF. The following values are valid:

0 - false
1 - true

Returns:: The value of the guidePDF option.
See Also:: setGuidePDF()

setGuidePDF

public void setGuidePDF(boolean guidePDF)

Sets the value of the guidePDF option, which specifies that the output is rendered in both Flash and PDF format. The following values are valid:

0 - false
1 - true

Parameters:: guidePDF - A Boolean value that specifies the value of the guidePDF option.

isGuideAccessible

public boolean isGuideAccessible()

Returns the value of the guideAccessible option, which specifies whether guided forms compilation is accessible. The following values are valid:

0 - false
1 - true

Returns:: The value of the guideAccessible option.
See Also:: setGuideAccessible()

setGuideAccessible

public void setGuideAccessible(boolean guideAccessible)

Sets the value of the guideAccessible option, which specifies whether guided forms compilation is accessible. The following values are valid:

0 - false
1 - true

Parameters:: guideAccessible - The value of the guideAccessible option.

getGuideCBURL

public String getGuideCBURL()

Gets the value of the guideCbUrl option, which specifies a custom override implementation of a callback servlet.

Returns:: The guideCBURL option.

setGuideCBURL

public void setGuideCBURL(String guideCBURL)

Sets the value of the guideCBURL option, which specifies a custom override implementation of a callback servlet.

Parameters:: guideCBURL - The guideCBURL option.

isCB

public boolean isCB()

Returns the value of the Cb option, which specifies the generation of HTML-template initiating content, or guided forms content. The following values are valid:

0 - false
1 - true

Returns:: The value of the Cb option.

setCB

public void setCB(boolean cB)

Sets the value of the Cb option, which specifies the generation of HTML-template initiating content, or guided forms content. The following values are valid:

0 - false
1 - true

Parameters:: cB - The value of the Cb option.

getGuideStyle

public String getGuideStyle()

Returns the name of the style sheet used by guided forms. The style sheet is also embedded in the application. The application container may contain the style sheet or the style sheet can be referenced.

Returns:: The name of the style sheet used by guided forms.

setGuideStyle

public void setGuideStyle(String guideStyle)

Sets the name of the style sheet used by a guided form. The style sheet is also embedded in the application. The application container may contain the style sheet or the style sheet can be referenced.

Parameters:: guideStyle - The name of the style sheet used by guided forms.

isGuideSubmitAll

public boolean isGuideSubmitAll()

Gets the value of the GuideSubmitAll option, which specifies whether guided forms submit all data including hidden panels.

Returns:: A Boolean value that specifies the value of the guideSubmitAll option.
See Also:: setGuideSubmitAll()

setGuideSubmitAll

public void setGuideSubmitAll(boolean guideSubmitAll)

Sets the value of the GuideSubmitAll option, which specifies whether guided forms submit all data including hidden panels. The followiing values are valid:

0 - false
1 - true

Parameters:: guideSubmitAll - The value of the GuideSubmitAll option.

getInjectFormBridge

public boolean getInjectFormBridge()

Returns a Boolean value that specifies whether the injectFormBridge option is set. This option specifies whether the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms.

Returns:: A Boolean value that specifies whether the injectFormBridge option is set. The value true means that this option is set.
See Also:: setInjectFormBridge()

setInjectFormBridge

public void setInjectFormBridge(boolean injectFormBridge)

Sets the injectFormBridge option that specifies whether the Forms service inserts special javascript code into a PDF form. The javascript performs operations on a PDF form when rendering guided forms. This value is set to true when you set the guidePDF option to true. For information about rendering guided forms, see Rendering Forms.

Parameters:: injectFormBridge - A Boolean value that sets the injectFormBridge option.
See Also:: setGuidePDF()

getPropertyMap

public HashMap getPropertyMap()

For internal use only. Do not use.

getInternalOptionMap

public HashMap getInternalOptionMap()

For internal use only. Do not use.

isRe2DBarcode

public boolean isRe2DBarcode()

Returns a Boolean value that specifies whether the re2DBarcode option is set.

Returns:: A Boolean value that specifies whether the re2DBarcode option is set.
See Also:: setRe2DBarcode()

setRe2DBarcode

public void setRe2DBarcode(boolean re2DBarcode)

Sets the re2DBarcode option that enables the Forms service to render forms that contain 2D barcodes and enables a user to fill in the form using Adobe Reader. When a user fills in an interactive form that contains a barcoded, the barcode is updated automatically to encode the user-supplied data. For information, see Working With the Barcoded Forms Service. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: re2DBarcode - A Boolean value that sets the re2DBarcode option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReCommenting

public boolean isReCommenting()

Returns a Boolean value that specifies whether the reCommenting option is set.

Returns:: A Boolean value that specifies whether the reCommenting option is set.
See Also:: setReCommenting()

setReCommenting

public void setReCommenting(boolean reCommenting)

Sets the reCommenting option that enables the Forms service to render forms that allow users to add comments to the PDF form using Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reCommenting - A Boolean value that sets the reCommenting option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReCreatePages

public boolean isReCreatePages()

Returns a Boolean value that specifies whether the reCreatePages option is set.

Returns:: A Boolean value that specifies whether the reCreatePages option is set.
See Also:: setReCreatePages()

setReCreatePages

public void setReCreatePages(boolean reCreatePages)

Sets the reCreatePages option that enables the Forms service to render forms that allow users to dynamically add pages within Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reCreatePages - A Boolean value that sets the reCreatePages option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

getReCredentialAlias

public String getReCredentialAlias()

Returns the alias value of the credential that grants usage rights. In order to set Reader Extensions usage rights, you must specify the alias of a Reader Entensions credential.

Returns:: A string value that specifies the alias value of the credential that grants usage rights.
See Also:: setReCredentialAlias()

setReCredentialAlias

public void setReCredentialAlias(String reCredentialAlias)

Sets the alias value of the credential that grants usage rights. In order to set Reader Extensions usage rights, you must specify the alias of a Reader Entensions credential. For information, see Applying Usage Rights.

Parameters:: reCredentialAlias - A string value that specifies the alias value of the credential that grants usage rights.

getReCredentialPassword

public String getReCredentialPassword()

Returns the credential password value that grants usage rights. In order to set Reader Extensions usage rights, you must specify a valid credential password value.

Returns:: A string value that specifies a valid credential password value.
See Also:: setReCredentialPassword()

setReCredentialPassword

public void setReCredentialPassword(String reCredentialPassword)

Sets the credential password value that grants usage rights. In order to set Reader Extensions usage rights, you must specify a valid credential password value.

Parameters:: reCredentialPassword - A string value that specifies a valid credential password value.

isReDigSig

public boolean isReDigSig()

Returns a Boolean value that specifies whether the reDigSig option is set.

Returns:: A Boolean value that specifies whether the reDigSig option is set.
See Also:: setReDigSig()

setReDigSig

public void setReDigSig(boolean reDigSig)

Sets the reDigSig option that enables the Forms service to render PDF forms that allow users to digitally sign the form using Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reDigSig - A Boolean value that sets the reDigSig option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReEmbeddedAttachments

public boolean isReEmbeddedAttachments()

Returns a Boolean value that specifies whether the reEmbeddedAttachments option is set.

Returns:: A Boolean value that specifies whether the reEmbeddedAttachments option is set.
See Also:: setReEmbeddedAttachments()

setReEmbeddedAttachments

public void setReEmbeddedAttachments(boolean reEmbeddedAttachments)

Sets the reEmbeddedAttachments option that enables the Forms service to render PDF forms that allow users to add attachments to the form using Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reEmbeddedAttachments - A Boolean value that sets the reEmbeddedAttachments option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReExpImp

public boolean isReExpImp()

Returns a Boolean value that specifies whether the reExpImp option is set.

Returns:: A Boolean value that specifies whether the reExpImp option is set.
See Also:: setReExpImp()

setReExpImp

public void setReExpImp(boolean reExpImp)

Sets the reExpImp option that enables the Forms service to render PDF forms that allow users to import and export form data using Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reExpImp - A Boolean value that sets the reExpImp option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReFillIn

public boolean isReFillIn()

Returns a Boolean value that specifies whether the reFillIn option is set.

Returns:: A Boolean value that specifies whether the reFillIn option is set.
See Also:: setReFillIn()

setReFillIn

public void setReFillIn(boolean reFillIn)

Sets the reFillIn option that enables the Forms service to render PDF forms that allow users to fill in form fields and save the PDF form from within Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reFillIn - A Boolean value that sets the reFillIn option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReFormFieldMod

public boolean isReFormFieldMod()

Returns a Boolean value that specifies whether the reFormFieldMod option is set.

Returns:: A Boolean value that specifies whether the reFormFieldMod option is set.
See Also:: setReFormFieldMod()

setReFormFieldMod

public void setReFormFieldMod(boolean reFormFieldMod)

Sets the reFormFieldMod option that enables the Forms service to render PDF forms that allow users to modify form fields and save the PDF form from within Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reFormFieldMod - A Boolean value that sets the reFormFieldMod option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReOnlineCommenting

public boolean isReOnlineCommenting()

Returns a Boolean value that specifies whether the reOnlineCommenting option is set.

Returns:: A Boolean value that specifies whether the reOnlineCommenting option is set.
See Also:: setReOnlineCommenting()

setReOnlineCommenting

public void setReOnlineCommenting(boolean reOnlineCommenting)

Sets the reOnlineCommenting option that enables the Forms service to render PDF forms that allow users to add comments within Adobe Reader while online. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reOnlineCommenting - A Boolean value that sets the reOnlineCommenting option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

isReOnlineForms

public boolean isReOnlineForms()

Returns a Boolean value that specifies whether the reOnlineForms option is set.

Returns:: A Boolean value that specifies whether the reOnlineForms option is set.
See Also:: setReOnlineForms()

setReOnlineForms

public void setReOnlineForms(boolean reOnlineForms)

Sets the reOnlineForms option that enables the Forms service to render PDF forms that allow users to interact with a form while online from within Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reOnlineForms - A Boolean value that sets the reOnlineForms option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

getReReaderMessage

public String getReReaderMessage()

Return a string value that represents the message that is displayed within Adobe Reader to inform users that the form contains usage rights.

Returns:: A string value that represents the message that is displayed within Adobe Reader.
See Also:: RenderOptionsSpec.setReReaderMessage(String)

setReReaderMessage

public void setReReaderMessage(String reReaderMessage)

Sets the message that is displayed within Adobe Reader to inform users that the form contains usage rights.

Parameters:: reReaderMessage - A string value that represents the message that is displayed within Adobe Reader.

isReStandaloneSubmit

public boolean isReStandaloneSubmit()

Returns a Boolean value that specifies whether the reStandaloneSubmit option is set.

Returns:: A Boolean value that specifies whether the reStandaloneSubmit option is set.
See Also:: setReStandaloneSubmit()

setReStandaloneSubmit

public void setReStandaloneSubmit(boolean reStandaloneSubmit)

Sets the reStandaloneSubmit option that enables the Forms service to render PDF forms that allows users to submit information from within Adobe Reader. In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters:: reStandaloneSubmit - A Boolean value that sets the reStandaloneSubmit option.
See Also:: setReCredentialAlias(), setReCredentialPassword()

getOptions

public String getOptions()

For internal use only. Do not use.

getOptionsBean

public String getOptionsBean(String key)

For internal use only. Do not use.

updateOptionsBean

public void updateOptionsBean(String key,
                              String value)
                       throws FormServerException

For internal purposes only. Do not invoke this method.

Throws:: FormServerException

updateOptionsBean

public void updateOptionsBean(String options)
                       throws FormServerException

For internal purposes only. Do not invoke this method.

Throws:: FormServerException

toString

public String toString()

For internal use only. Do not use.

Overrides:: toString in class Object

getInternalOption

public String getInternalOption(String key)

For internal use only. Do not use.

setInternalOption

public void setInternalOption(String key,
                              String val)

For internal use only. Do not use.

clone

public Object clone()

Creates a copy of this object.

Overrides:: clone in class Object

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

[an error occurred while processing this directive] [an error occurred while processing this directive]

com.adobe.livecycle.formsservice.client Class RenderOptionsSpec

RenderOptionsSpec

RenderOptionsSpec

RenderOptionsSpec

getAcrobatVersion

setAcrobatVersion

isCacheEnabled

getCacheEnabled

setCacheEnabled

getCharset

setCharset

isClientCache

setClientCache

isEnableViewerPreferences

setEnableViewerPreferences

getClientFrame

setClientFrame

isDebugEnabled

setDebugEnabled

getExportDataFormat

setExportDataFormat

getFontMapURI

setFontMapURI

getFormModel

setFormModel

getImageURL

setImageURL

isLinearizedPDF

setLinearizedPDF

getLocale

setLocale

getOutputType

setOutputType

getPageNumber

setPageNumber

isPDF2XDP

setPDF2XDP

getPDFVersion

setPDFVersion

getRenderAtClient

setRenderAtClient

getSeedPDF

setSeedPDF

isStandAlone

setStandAlone

isTaggedPDF

setTaggedPDF

getValidationBorder

setValidationBorder

getValidationReporting

setValidationReporting

getValidationUI

setValidationUI

getXCI

setXCI

getXCIURI

setXCIURI

getXDCURI

setXDCURI

isXMLData

setXMLData

getServiceId

setServiceId

getRootLocale

setRootLocale

getDigSigCSSURI

setDigSigCSSURI

getToolbarMenu

setToolbarMenu

getIfModifiedSince

setIfModifiedSince

getGuideName

setGuideName

isGuideRSL

setGuideRSL

isGuidePDF

setGuidePDF

isGuideAccessible

setGuideAccessible

getGuideCBURL

com.adobe.livecycle.formsservice.client
Class RenderOptionsSpec