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

	Method	Defined By
		ActivityGuideRenderSpec() A standard constructor.	ActivityGuideRenderSpec
		ActivityGuideRenderSpec(String ifModifiedSince, String guideName, boolean guideRSL, boolean guidePDF, boolean guideAccessible, String guideCBURL, boolean cB, String guideStyle, boolean guideSubmitAll, boolean injectFormBridge, String locale) A constructor that enables you to set all options.	ActivityGuideRenderSpec
		String getGuideCBURL() Retrieves the custom override implementation of the callback servlet.	ActivityGuideRenderSpec
		String getGuideName() Returns the name of the specific guide within a guided forms definition.	ActivityGuideRenderSpec
		String getGuideStyle() Returns the name of the style sheet used by guided forms.	ActivityGuideRenderSpec
		String getIfModifiedSince() For internal use only.	ActivityGuideRenderSpec
		String getLocale() Gets a locale value that is used by the Forms service to produce FormGuide transformations.	ActivityGuideRenderSpec
		boolean isCB() Determines the generation of HTML-template initiating content, or guided forms content.	ActivityGuideRenderSpec
		boolean isGuideAccessible() Determines whether guided forms compilation is accessible.	ActivityGuideRenderSpec
		boolean isGuidePDF() Determines whether the Forms service data output is rendered in both Flash and PDF.	ActivityGuideRenderSpec
		boolean isGuideRSL() Determines whether to use run-time shared libraries when compiling guided forms.	ActivityGuideRenderSpec
		boolean isGuideSubmitAll() Specifies whether guided forms submit all data including hidden panels.	ActivityGuideRenderSpec
		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.	ActivityGuideRenderSpec
		void setCB(boolean cB) Sets the generation of HTML-template initiating content, or guided forms content.	ActivityGuideRenderSpec
		void setGuideAccessible(boolean guideAccessible) Sets whether guided forms compilation is accessible.	ActivityGuideRenderSpec
		void setGuideCBURL(String guideCBURL) Sets the custom override implementation of the callback servlet.	ActivityGuideRenderSpec
		void setGuideName(String guideName) Sets the name of the specific guide within a guided forms definition.	ActivityGuideRenderSpec
		void setGuidePDF(boolean guidePDF) Sets whether the Forms service data output is rendered in both Flash and PDF.	ActivityGuideRenderSpec
		void setGuideRSL(boolean guideRSL) Sets whether to use run-time shared libraries when compiling guided forms.	ActivityGuideRenderSpec
		void setGuideStyle(String guideStyle) Sets the name of the style sheet used by a guided form.	ActivityGuideRenderSpec
		void setGuideSubmitAll(boolean guideSubmitAll) Sets whether guided forms submit all data including hidden panels.	ActivityGuideRenderSpec
		void setIfModifiedSince(String ifModifiedSince) For internal use only.	ActivityGuideRenderSpec
		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.	ActivityGuideRenderSpec
		void setLocale(String locale) Sets a locale value that is used by the Forms service to produce FormGuide transformations.	ActivityGuideRenderSpec

Constructor Detail

ActivityGuideRenderSpec

()

public ActivityGuideRenderSpec()

A standard constructor.

ActivityGuideRenderSpec

()

public ActivityGuideRenderSpec(String ifModifiedSince, String guideName, boolean guideRSL, boolean guidePDF, boolean guideAccessible, String guideCBURL, boolean cB, String guideStyle, boolean guideSubmitAll, boolean injectFormBridge, 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

getGuideCBURL

()

public String getGuideCBURL()

Retrieves the custom override implementation of the callback servlet.

Returns

The custom override implementation of the callback servlet.

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.

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.

getIfModifiedSince

()

public String getIfModifiedSince()

For internal use only.

Returns

getLocale

()

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

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.

isGuideAccessible

()

public boolean isGuideAccessible()

Determines whether guided forms compilation is accessible.

Returns

true if guided forms compilation is accessible, false otherwise.

See also

setGuideAccessible()

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

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.

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

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

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.

setGuideAccessible

()

public void setGuideAccessible(boolean guideAccessible)

Sets whether guided forms compilation is accessible.

Parameters

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

setGuideCBURL

()

public void setGuideCBURL(String guideCBURL)

Sets the custom override implementation of the callback servlet.

Parameters

guideCBURL — The custom override implementation of the callback servlet.

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.

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.

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.

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.

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.

setIfModifiedSince

()

public void setIfModifiedSince(String ifModifiedSince)

For internal use only.

Parameters

ifModifiedSince

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

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

setLocale

()

public void setLocale(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)

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/livecycle/formsservice/client/ActivityGuideRenderSpec.html

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
ActivityGuideRenderSpec	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples

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