com.adobe.livecycle.formsservice.client
Class ActivityGuideRenderSpec

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

All Implemented Interfaces:

java.io.Serializable

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

Enables you to define run-time options that control how the Forms service renders form guides. An object of this type is passed to the FormsServiceClient object's renderFormGuide method. For information, see the "Rendering Form Guides" section in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

ActivityGuideRenderSpec()
A standard constructor.

ActivityGuideRenderSpec(java.lang.String ifModifiedSince, java.lang.String guideName, boolean guideRSL, boolean guidePDF, boolean guideAccessible, java.lang.String guideCBURL, boolean cB, java.lang.String guideStyle, boolean guideSubmitAll, boolean injectFormBridge, java.lang.String locale)
A constructor that enables you to set all options.

Method Summary

java.lang.String	getGuideCBURL() Retrieves the custom override implementation of the callback servlet.
java.lang.String	getGuideName() Returns the name of the specific guide within a guided forms definition.
java.lang.String	getGuideStyle() Returns the name of the style sheet used by guided forms.
java.lang.String	getIfModifiedSince() For internal use only.
java.lang.String	getLocale() Gets a locale value that is used by the Forms service to produce FormGuide transformations.
boolean	isCB() Determines the generation of HTML-template initiating content, or guided forms content.
boolean	isGuideAccessible() Determines whether guided forms compilation is accessible.
boolean	isGuidePDF() Determines whether the Forms service data output is rendered in both Flash and PDF.
boolean	isGuideRSL() Determines whether to use run-time shared libraries when compiling guided forms.
boolean	isGuideSubmitAll() Specifies whether guided forms submit all data including hidden panels.
boolean	isInjectFormBridge() Determines whether the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms.
void	setCB(boolean cB) Sets the generation of HTML-template initiating content, or guided forms content.
void	setGuideAccessible(boolean guideAccessible) Sets whether guided forms compilation is accessible.
void	setGuideCBURL(java.lang.String guideCBURL) Sets the custom override implementation of the callback servlet.
void	setGuideName(java.lang.String guideName) Sets the name of the specific guide within a guided forms definition.
void	setGuidePDF(boolean guidePDF) Sets whether the Forms service data output is rendered in both Flash and PDF.
void	setGuideRSL(boolean guideRSL) Sets whether to use run-time shared libraries when compiling guided forms.
void	setGuideStyle(java.lang.String guideStyle) Sets the name of the style sheet used by a guided form.
void	setGuideSubmitAll(boolean guideSubmitAll) Sets whether guided forms submit all data including hidden panels.
void	setIfModifiedSince(java.lang.String ifModifiedSince) For internal use only.
void	setInjectFormBridge(boolean injectFormBridge) Sets whether the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms.
void	setLocale(java.lang.String locale) Sets a locale value that is used by the Forms service to produce FormGuide transformations.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityGuideRenderSpec

public ActivityGuideRenderSpec()

A standard constructor.

ActivityGuideRenderSpec

public ActivityGuideRenderSpec(java.lang.String ifModifiedSince,
                               java.lang.String guideName,
                               boolean guideRSL,
                               boolean guidePDF,
                               boolean guideAccessible,
                               java.lang.String guideCBURL,
                               boolean cB,
                               java.lang.String guideStyle,
                               boolean guideSubmitAll,
                               boolean injectFormBridge,
                               java.lang.String locale)

A constructor that enables you to set all options.

Parameters:

ifModifiedSince - For internal use only. Specify null.

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

guideRSL - true to use the run-time shared libraries when compiling forms, false otherwise.

guidePDF - true if the data output is rendered in both Flash and PDF, false otherwise.

guideAccessible - true if guided forms compilation is accessible, false otherwise.

guideCBURL - The custom override implementation of the callback servlet.

cB - false if generating HTML-template initiaing content (default value), true if generating guided forms content.

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

guideSubmitAll - true if guided forms submit all data including hidden panels, false otherwise.

injectFormBridge - true if the Forms service

locale - Used to specify the locale for the FormGuide inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms, false otherwise.

Method Detail

getIfModifiedSince

public java.lang.String getIfModifiedSince()

For internal use only.

setIfModifiedSince

public void setIfModifiedSince(java.lang.String ifModifiedSince)

For internal use only.

getGuideName

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

Determines whether to use run-time shared libraries when compiling guided forms.

Returns:

true to use the run-time shared libraries when compiling forms, false otherwise.

setGuideRSL

public void setGuideRSL(boolean guideRSL)

Sets whether to use run-time shared libraries when compiling guided forms.

Parameters:

guideRSL - true to use the run-time shared libraries when compiling forms, false otherwise.

isGuidePDF

public boolean isGuidePDF()

Determines whether the Forms service data output is rendered in both Flash and PDF.

Returns:

true if the data output is rendered in both Flash and PDF, false otherwise.

See Also:

setGuidePDF()

setGuidePDF

public void setGuidePDF(boolean guidePDF)

Sets whether the Forms service data output is rendered in both Flash and PDF.

Parameters:

guidePDF - true if the data output is rendered in both Flash and PDF, false otherwise.

isGuideAccessible

public boolean isGuideAccessible()

Determines whether guided forms compilation is accessible.

Returns:

true if guided forms compilation is accessible, false otherwise.

See Also:

setGuideAccessible()

setGuideAccessible

public void setGuideAccessible(boolean guideAccessible)

Sets whether guided forms compilation is accessible.

Parameters:

guideAccessible - true if guided forms compilation is accessible, false otherwise.

getGuideCBURL

public java.lang.String getGuideCBURL()

Retrieves the custom override implementation of the callback servlet.

Returns:

The custom override implementation of the callback servlet.

setGuideCBURL

public void setGuideCBURL(java.lang.String guideCBURL)

Sets the custom override implementation of the callback servlet.

Parameters:

guideCBURL - The custom override implementation of the callback servlet.

isCB

public boolean isCB()

Determines the generation of HTML-template initiating content, or guided forms content.

Returns:

false if generating HTML-template initiaing content (default value), true if generating guided forms content.

setCB

public void setCB(boolean cB)

Sets the generation of HTML-template initiating content, or guided forms content.

Parameters:

cB - false if generating HTML-template initiaing content, true if generating guided forms content.

getGuideStyle

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

Specifies whether guided forms submit all data including hidden panels.

Returns:

true if guided forms submit all data including hidden panels, false otherwise.

See Also:

setGuideSubmitAll()

setGuideSubmitAll

public void setGuideSubmitAll(boolean guideSubmitAll)

Sets whether guided forms submit all data including hidden panels.

Parameters:

guideSubmitAll - true if guided forms submit all data including hidden panels, false otherwise.

isInjectFormBridge

public boolean isInjectFormBridge()

Determines whether the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms.

Returns:

true if the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms, false otherwise.

See Also:

setInjectFormBridge()

setInjectFormBridge

public void setInjectFormBridge(boolean injectFormBridge)

Sets whether the Forms service inserts special javascript code into a PDF form that 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 the "Rendering Form Guides" section in Programming with LiveCycle ES4.

Parameters:

injectFormBridge - true if the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms, false otherwise.

See Also:

setGuidePDF()

getLocale

public java.lang.String getLocale()

Gets a locale value that is used by the Forms service to produce FormGuide transformations.

Returns:

A string value that represents the locale value.

See Also:

setLocale()

setLocale

public void setLocale(java.lang.String locale)

Sets a locale value that is used by the Forms service to produce FormGuide transformations.

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)