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

	Method	Defined by
		HTMLRenderSpec() A standard constructor.	HTMLRenderSpec
		HTMLRenderSpec(OutputType outputType, String charset, int pageNumber, String locale, Boolean cacheEnabled, boolean xMLData, boolean standAlone, FormModel formModel, String xCIURI, String digSigCSSURI, HTMLToolbar htmlToolbar, String toolbarURI, String fontMapURI) A constructor that enables you to set all options.	HTMLRenderSpec
		String getCharset() Gets the character set used to encode the output byte stream.	HTMLRenderSpec
		String getDigSigCSSURI() Returns the `digSigCSSURI` value.	HTMLRenderSpec
		String getFontMapURI() Specifies the URI location of the font mapping file.	HTMLRenderSpec
		FormModel getFormModel() Gets the location to where the form is processed.	HTMLRenderSpec
		HTMLToolbar getHTMLToolbar() Gets the HTML toolbar that is rendered with an HTML form.	HTMLRenderSpec
		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.	HTMLRenderSpec
		OutputType getOutputType() Returns the output type value that specifies how a form that is rendered as HTML is displayed.	HTMLRenderSpec
		int getPageNumber() The page number value specifies the initial page number to render in a multipage HTML form.	HTMLRenderSpec
		String getToolbarURI() Returns a string value that represents a URI location to where custom collateral required for a toolbar is located.	HTMLRenderSpec
		String getXCIURI() Gets the URI location of the XCI file used for rendering.	HTMLRenderSpec
		Boolean isCacheEnabled() Specifies whether the Forms service caches a PDF form to boost performance.	HTMLRenderSpec
		boolean isStandAlone() Specifies if the `standAlone` option is set to `true`, which results in a form being rendered without state information.	HTMLRenderSpec
		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.	HTMLRenderSpec
		void setCacheEnabled(Boolean cacheEnabled) Instructs the Forms service to cache a form in order to improve performance.	HTMLRenderSpec
		void setCharset(String charset) Sets the character set used to encode the output byte stream.	HTMLRenderSpec
		void setDigSigCSSURI(String digSigCSSURI) Sets the `digSigCSSURI` value.	HTMLRenderSpec
		void setFontMapURI(String fontMapURI) Sets the URI location of the font mapping file.	HTMLRenderSpec
		void setFormModel(FormModel formModel) Sets the location to where the form and its scripts are processed.	HTMLRenderSpec
		void setHTMLToolbar(HTMLToolbar htmlToolbar) Sets the HTML toolbar that is rendered with an HTML form.	HTMLRenderSpec
		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.	HTMLRenderSpec
		void setOutputType(OutputType outputType) Sets the output type value that is used by the Forms service to render a form as HTML.	HTMLRenderSpec
		void setPageNumber(int pageNumber) The page number value specifies the initial page number to render in a multipage HTML form.	HTMLRenderSpec
		void setStandAlone(boolean standAlone) Sets the `standAlone` option.	HTMLRenderSpec
		void setToolbarURI(String toolbarURI) Sets a URL value that represents a location to where custom collateral required for a toolbar is located.	HTMLRenderSpec
		void setXCIURI(String xCIURI) Sets the URI location of the XCI file used for rendering.	HTMLRenderSpec
		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.	HTMLRenderSpec

Constructor Detail

HTMLRenderSpec

()

public HTMLRenderSpec()

A standard constructor.

HTMLRenderSpec

()

public HTMLRenderSpec(OutputType outputType, String charset, int pageNumber, String locale, Boolean cacheEnabled, boolean xMLData, boolean standAlone, FormModel formModel, String xCIURI, String digSigCSSURI, HTMLToolbar htmlToolbar, String toolbarURI, String fontMapURI)

A constructor that enables you to set all options.

Parameters

	`outputType`

	`charset`

	`pageNumber`

	`locale`

	`cacheEnabled`

	`xMLData`

	`standAlone`

	`formModel`

	`xCIURI`

	`digSigCSSURI`

	`htmlToolbar`

	`toolbarURI`

	`fontMapURI`

Method Detail

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

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.

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.

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

getHTMLToolbar

()

public HTMLToolbar getHTMLToolbar()

Gets the HTML toolbar that is rendered with an HTML form.

Returns

An HTMLToolbar enum value that specifies the HTML toolbar.

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

getOutputType

()

public OutputType getOutputType()

Returns the output type value that specifies how a form that is rendered as HTML is displayed.

Returns

Returns the output type value that is used by the Forms service.

See also

setOutputType()

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

getToolbarURI

()

public String getToolbarURI()

Returns a string value that represents a URI location to where custom collateral required for a toolbar is located. Custom collateral includes XML JS, and CSS files. If you are using the default toolbar, then you do not need to supply custom collateral.

Returns

A string value that represents a URI location to where custom collateral required for a toolbar is located.

getXCIURI

()

public String getXCIURI()

Gets the URI location of the XCI file used for rendering.

Returns

A string value that specifies 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()

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

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

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.

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.

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.

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. Form developers specify where scripts are processed by specifying a value in the Run At drop-down list in LiveCycle Designer ES. If the value of the Run At drop-down list and the value of this setting conflict, (for example, if the value of Run At is Server or Both and this setting is FormModel.Client), then the form may not render properly and a warning is entered into log file that belongs 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.

setHTMLToolbar

()

public void setHTMLToolbar(HTMLToolbar htmlToolbar)

Sets the HTML toolbar that is rendered with an HTML form.

Parameters

htmlToolbar — An HTMLToolbar enum value that specifies the HTML toolbar.

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)

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.

Parameters

outputType — The output type value to set.

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.

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.

The Forms service will not render an HTML form when this option is true and the application web root value references a server that is not the J2EE application server hosting LiveCycle. The application web root value is set by invoking the URLSpec object's setApplicationWebRoot() method.

Parameters

standAlone — The value of standAlone option.

setToolbarURI

()

public void setToolbarURI(String toolbarURI)

Sets a URL value that represents a location to where custom collateral required for a toolbar is located. Custom collateral includes XML JS, and CSS files. If you are using the default toolbar, then you do not need to supply custom collateral.

Parameters

toolbarURI — A string value that represents a URI location to where custom collateral required for a toolbar is located.

setXCIURI

()

public void setXCIURI(String xCIURI)

Sets the URI location of the XCI file used for rendering.

Parameters

xCIURI — A string value that specifies 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/HTMLRenderSpec.html

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

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