com.adobe.livecycle.formsservice.client
Class HTMLRenderSpec

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

All Implemented Interfaces:

java.io.Serializable

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

Allows you to define run-time options that control how the PDF forms service renders HTML forms. An object of this type is passed to the FormsServiceClient object's renderHTMLForm method. To see an object of this type used in a code example, see the Rendering an HTML form using the Java API quick start in Programming with Adobe Experience Manager forms.

See Also:

Serialized Form

Constructor Summary

HTMLRenderSpec()
A standard constructor that creates a HTMLRenderSpec object.

HTMLRenderSpec(OutputType outputType, java.lang.String charset, int pageNumber, java.lang.String locale, java.lang.Boolean cacheEnabled, boolean xMLData, boolean standAlone, FormModel formModel, java.lang.String xCIURI, java.lang.String digSigCSSURI, java.lang.String customCSSURI, HTMLToolbar htmlToolbar, java.lang.String toolbarURI, java.lang.String fontMapURI)
A constructor that enables you to set all options.

Method Summary

int	getAuditLog() Get Audit Log Configuration value
java.lang.Boolean	getCacheEnabled() Specifies whether the PDF forms service caches a PDF form to boost performance.
java.lang.String	getCharset() Gets the character set used to encode the output byte stream.
java.lang.String	getCustomCSSURI() Retuns the URI of the custom CSS file that is used to render an HTML form.
java.lang.String	getDigSigCSSURI() Returns the digSigCSSURI value.
java.lang.String	getFontMapURI() Specifies the URI location of the font mapping file.
FormModel	getFormModel() Gets the location to where the form is processed.
java.lang.Boolean	getGenerateTabIndex() Specifies whether the generate tab index option is set.
HTMLToolbar	getHTMLToolbar() Gets the HTML toolbar that is rendered with an HTML form.
java.lang.String	getLocale() Gets a locale value that is used by the PDF forms service to send validation messsages to client devices, such as web browsers, as part of HTML transformations.
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.
StyleGenerationLevel	getStyleGenerationLevel() Gets the StyleGenerationLevel.
java.lang.String	getToolbarURI() Returns a string value that represents a URI location to where custom collateral required for a toolbar is located.
java.lang.String	getXCIURI() Gets the URI location of the XCI file used for rendering.
java.lang.Boolean	isCacheEnabled() Specifies whether the PDF forms service caches a PDF form to boost performance.
boolean	isDebugEnabled() Specifies whether the debug option is set.
boolean	isLogPerformance() Returns true if PDF forms performance logging has been enabled for this request
boolean	isStandAlone() Specifies if the standAlone option is set to true, which results in a form being rendered without state information.
boolean	isXMLData() Returns a Boolean value that represents the xmlData option that specifies whether the PDF forms service produces the form's XML data based on its current processing state.
void	setAuditLog(int auditLog) Set Audit Log Configuration value
void	setCacheEnabled(java.lang.Boolean cacheEnabled) Instructs the PDF forms service to cache a form in order to improve performance.
void	setCharset(java.lang.String charset) Sets the character set used to encode the output byte stream.
void	setCustomCSSURI(java.lang.String customCSSURI) Sets the URI of the custom CSS file that is used to render an HTML form.
void	setDebugEnabled(boolean debugEnabled) Sets the debug option that controls how the PDF forms service handles debugging information.
void	setDigSigCSSURI(java.lang.String digSigCSSURI) Sets the digSigCSSURI value.
void	setFontMapURI(java.lang.String fontMapURI) Sets the URI location of the font mapping file.
void	setFormModel(FormModel formModel) Sets the location to where the form and its scripts are processed.
void	setGenerateTabIndex(java.lang.Boolean generateTabIndex) Sets the generate tab index option that specifies whether the tab indexes are generated.
void	setHTMLToolbar(HTMLToolbar htmlToolbar) Sets the HTML toolbar that is rendered with an HTML form.
void	setLocale(java.lang.String locale) Sets the locale value that the PDF forms service uses to send validation messsages to client devices, such as web browsers, when a HTML form is rendered.
void	setLogPerformance(boolean logPerformance) Used for setting performance logging for this request
void	setOutputType(OutputType outputType) Sets the output type value that is used by the PDF 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	setStandAlone(boolean standAlone) Sets the standAlone option.
void	setStyleGenerationLevel(StyleGenerationLevel styleGenerationLevel) Sets the StyleGenerationLevel.
void	setToolbarURI(java.lang.String toolbarURI) Sets a URL value that represents a location to where custom collateral required for a toolbar is located.
void	setXCIURI(java.lang.String xCIURI) Sets the URI location of the XCI file used for rendering.
void	setXMLData(boolean xMLData) Sets the xmlData option that instructs the PDF forms service to produce the form's XML data based on its current processing state.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLRenderSpec

public HTMLRenderSpec()

A standard constructor that creates a HTMLRenderSpec object.

HTMLRenderSpec

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

A constructor that enables you to set all options.

Method Detail

isLogPerformance

public boolean isLogPerformance()

Returns true if PDF forms performance logging has been enabled for this request

Returns:

setLogPerformance

public void setLogPerformance(boolean logPerformance)

Used for setting performance logging for this request

Parameters:

logPerformance -

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 PDF forms service.

See Also:

setOutputType()

setOutputType

public void setOutputType(OutputType outputType)

Sets the output type value that is used by the PDF forms service to render a form as HTML. An output type value specifies how a form that is rendered as HTML is displayed.

To see this method used within a code example, see the Rendering an HTML form using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

outputType - An OutputType enumeration value that specifies how an HTML form is rendered.

getCharset

public java.lang.String getCharset()

Gets the character set used to encode the output byte stream. The PDF 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(java.lang.String charset)

Sets the character set used to encode the output byte stream. The PDF 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.

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.

getLocale

public java.lang.String getLocale()

Gets a locale value that is used by the PDF 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(java.lang.String locale)

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

To see this method used within a code example, see the Rendering an HTML form using the Java API quick start in Programming with Adobe Experience Manager forms.

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)

isCacheEnabled

public java.lang.Boolean isCacheEnabled()

Specifies whether the PDF 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 java.lang.Boolean getCacheEnabled()

Specifies whether the PDF 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()

setCacheEnabled

public void setCacheEnabled(java.lang.Boolean cacheEnabled)

Instructs the PDF 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 Adobe Experience Manager forms Designer Help.

Parameters:

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

isXMLData

public boolean isXMLData()

Returns a Boolean value that represents the xmlData option that specifies whether the PDF forms 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 PDF forms service to produce the form's XML data based on its current processing state.

Parameters:

xMLData - A Boolean value that represents the xmlData option.

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 PDF forms service. The PDF forms 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 PDF forms service. Set this option to true if you are using the PDF forms service for rendering purposes and are running scripts that are located within the form while disconnected from the PDF forms 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 PDF forms service. The PDF forms 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 PDF forms service. Set this option to true if you are using the PDF forms service for rendering purposes and are running scripts that are located within the form while disconnected from the PDF forms service.

The PDF 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 Adobe Experience Manager forms. The application web root value is set by invoking the URLSpec object's setApplicationWebRoot() method.

Parameters:

standAlone - The value of standAlone option.

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

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 Adobe Experience Manager forms Designer. 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 Adobe Experience Manager forms.

Parameters:

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

getXCIURI

public java.lang.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.

setXCIURI

public void setXCIURI(java.lang.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.

getDigSigCSSURI

public java.lang.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(java.lang.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.

getHTMLToolbar

public HTMLToolbar getHTMLToolbar()

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

Returns:

An HTMLToolbar enumeration value that specifies the HTML toolbar.

setHTMLToolbar

public void setHTMLToolbar(HTMLToolbar htmlToolbar)

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

To see this method used within a code example, see the Rendering an HTML form using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

htmlToolbar - An HTMLToolbar enumeration value that specifies the HTML toolbar.

getToolbarURI

public java.lang.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.

setToolbarURI

public void setToolbarURI(java.lang.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.

To see this method in a code example, see the Rendering an HTML Form with a custom toolbar using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

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

getFontMapURI

public java.lang.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 Adobe Experience Manager forms ear file.

Returns:

The location of the font mapping file.

setFontMapURI

public void setFontMapURI(java.lang.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.

getCustomCSSURI

public java.lang.String getCustomCSSURI()

Retuns the URI of the custom CSS file that is used to render an HTML form. A custom CSS can be used to change the look and feel of HTML forms.

Returns:

A string value that specifies the URI of the custom CSS file.

setCustomCSSURI

public void setCustomCSSURI(java.lang.String customCSSURI)

Sets the URI of the custom CSS file that is used to render an HTML form. A custom CSS can be used to change the look and feel of HTML forms.

To see this method used in a code example, see the "Rendering an HTML form that uses a CSS file using the Java API" quick start in Programming with Adobe Experience Manager forms.

Parameters:

customCSSURI - A string value that specifies the URI of the custom CSS file.

isDebugEnabled

public boolean isDebugEnabled()

Specifies whether the debug option is set.

Returns:

A boolean that specifies whether the debug option is set.

setDebugEnabled

public void setDebugEnabled(boolean debugEnabled)

Sets the debug option that controls how the PDF forms service handles debugging information. The value true instructs the PDF forms service to generate debugging information.

Parameters:

debugEnabled - A boolean that sets the debug option.

getGenerateTabIndex

public java.lang.Boolean getGenerateTabIndex()

Specifies whether the generate tab index option is set.

Returns:

A boolean that specifies whether the tab indexes are generated.

setGenerateTabIndex

public void setGenerateTabIndex(java.lang.Boolean generateTabIndex)

Sets the generate tab index option that specifies whether the tab indexes are generated. The value true instructs the PDF forms service to generate tab indexes.

Parameters:

generateTabIndex - A boolean that sets the generate tab index option.

getStyleGenerationLevel

public StyleGenerationLevel getStyleGenerationLevel()

Gets the StyleGenerationLevel.

Returns:

StyleGenerationLevel enumeration value specifies the style generation level.

setStyleGenerationLevel

public void setStyleGenerationLevel(StyleGenerationLevel styleGenerationLevel)

Sets the StyleGenerationLevel.

Parameters:

StyleGenerationLevel - enumeration value specifies the style generation level.

getAuditLog

public int getAuditLog()

Get Audit Log Configuration value

Returns:

An integer that specifies the audit log configuration

setAuditLog

public void setAuditLog(int auditLog)

Set Audit Log Configuration value

Parameters:

auditLog - An integer that specifies the audit log configuration