com.adobe.livecycle.formsservice.client.PDFFormRenderSpec (Livecycle)

	Method	Defined by
		PDFFormRenderSpec() A standard constructor that does not set options.	PDFFormRenderSpec
		PDFFormRenderSpec(Boolean cacheEnabled, PDFVersion pDFVersion, boolean taggedPDF, boolean linearizedPDF, String seedPDF, AcrobatVersion acrobatVersion, String xCIURI, String charset, RenderAtClient renderAtClient, String locale, boolean standAlone, FormModel formModel, boolean xMLData) A constructor that enables you to set all options.	PDFFormRenderSpec
		AcrobatVersion getAcrobatVersion() Gets the Acrobat version that is required to view the PDF form that the Forms service renders.	PDFFormRenderSpec
		String getCharset() Gets the character set used to encode the output byte stream.	PDFFormRenderSpec
		FormModel getFormModel() Gets the location to where the form is processed.	PDFFormRenderSpec
		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.	PDFFormRenderSpec
		PDFVersion getPDFVersion() Gets the PDF version of the PDF form that is rendered.	PDFFormRenderSpec
		RenderAtClient getRenderAtClient() Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later.	PDFFormRenderSpec
		String getSeedPDF() Gets the seed PDF document value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery.	PDFFormRenderSpec
		String getXCIURI() Gets the URI location of the XCI file used for rendering.	PDFFormRenderSpec
		Boolean isCacheEnabled() Specifies whether the Forms service caches a PDF form to boost performance.	PDFFormRenderSpec
		boolean isLinearizedPDF() Determines whether the Forms service produces a linearized PDF form (optimized for web applications).	PDFFormRenderSpec
		boolean isStandAlone() Specifies if the `standAlone` option is set to `true`, which results in a form being rendered without state information.	PDFFormRenderSpec
		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.	PDFFormRenderSpec
		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.	PDFFormRenderSpec
		void setAcrobatVersion(AcrobatVersion acrobatVersion) Sets the Acrobat version that is required to view the PDF form that the Forms service renders.	PDFFormRenderSpec
		void setCacheEnabled(Boolean cacheEnabled) Instructs the Forms service to cache a form in order to improve performance.	PDFFormRenderSpec
		void setCharset(String charset) Sets the character set used to encode the output byte stream.	PDFFormRenderSpec
		void setFormModel(FormModel formModel) Sets the location to where the form and its scripts are processed.	PDFFormRenderSpec
		void setLinearizedPDF(boolean linearizedPDF) Sets the `linearizedPDF` property that results in the Forms service producing a linearized PDF form.	PDFFormRenderSpec
		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.	PDFFormRenderSpec
		void setPDFVersion(PDFVersion pDFVersion) Sets the PDF version of the PDF form that is rendered.	PDFFormRenderSpec
		void setRenderAtClient(RenderAtClient renderAtClient) Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later.	PDFFormRenderSpec
		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.	PDFFormRenderSpec
		void setStandAlone(boolean standAlone) Sets the `standAlone` option.	PDFFormRenderSpec
		void setTaggedPDF(boolean taggedPDF) Sets the `taggedPDF` option that results in the Forms service creating a tagged PDF form.	PDFFormRenderSpec
		void setXCIURI(String xCIURI) Sets the URI location of the XCI file used for rendering.	PDFFormRenderSpec
		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.	PDFFormRenderSpec

Constructor Detail

PDFFormRenderSpec

()

public PDFFormRenderSpec()

A standard constructor that does not set options.

PDFFormRenderSpec

()

public PDFFormRenderSpec(Boolean cacheEnabled, PDFVersion pDFVersion, boolean taggedPDF, boolean linearizedPDF, String seedPDF, AcrobatVersion acrobatVersion, String xCIURI, String charset, RenderAtClient renderAtClient, String locale, boolean standAlone, FormModel formModel, boolean xMLData)

A constructor that enables you to set all options.

Parameters

	`cacheEnabled`

	`pDFVersion`

	`taggedPDF`

	`linearizedPDF`

	`seedPDF`

	`acrobatVersion`

	`xCIURI`

	`charset`

	`renderAtClient`

	`locale`

	`standAlone`

	`formModel`

	`xMLData`

Method Detail

getAcrobatVersion

()

public AcrobatVersion getAcrobatVersion()

Gets the Acrobat version that is required to view the PDF form that the Forms service renders.

Returns

An AcrobatVersion object that specifies the Acrobat version that is required to view the PDF form that the Forms service renders.

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()

getFormModel

()

public FormModel getFormModel()

Gets the location to where the form is processed.

Returns

A value that specifies where the form is processed.

See also

setFormModel()

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()

getPDFVersion

()

public PDFVersion getPDFVersion()

Gets the PDF version of the PDF form that is rendered.

Returns

A PDFVersion object that specifies the PDF version.

See also

PDFVersion

getRenderAtClient

()

public RenderAtClient getRenderAtClient()

Returns

The renderAtClient value.

See also

setRenderAtClient()

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()

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.

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()

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.

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()

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()

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()

setAcrobatVersion

()

public void setAcrobatVersion(AcrobatVersion acrobatVersion)

Sets the Acrobat version that is required to view the PDF form that the Forms service renders.

Parameters

acrobatVersion — An AcrobatVersion object that specifies the Acrobat version that is required to view the PDF form that the Forms service renders.

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.

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.

setFormModel

()

public void setFormModel(FormModel formModel)

Sets the location to where the form and its scripts are processed. If this value is set to FormModel.client, the form is passed to the client device without processing. A form design contains a setting named runAt that controls where a script is processed. If these two values conflict, (for example, the runAt setting is client and this setting is FormModel.server), then the form may not render properly and a warning is entered into log file that belong to the J2EE application server hosting LiveCycle.

Parameters

formModel — A FormModel enum value that specifies the location to where the form and its scripts are processed.

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.

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)

setPDFVersion

()

public void setPDFVersion(PDFVersion pDFVersion)

Sets the PDF version of the PDF form that is rendered.

Parameters

pDFVersion — A PDFVersion object that specifies the PDF version to set.

See also

PDFVersion

setRenderAtClient

()

public void setRenderAtClient(RenderAtClient 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.

Parameters

renderAtClient — The renderAtClient value to set.

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.

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. 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.

Parameters

standAlone — The value of standAlone option.

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.

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.

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.

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/formsservice/client/PDFFormRenderSpec.html

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class PDFFormRenderSpec	Methods

Package	com.adobe.livecycle.formsservice.client
Class	public class PDFFormRenderSpec
Inheritance	PDFFormRenderSpec Object