com.adobe.livecycle.formsservice.client
Class ActivityGuideRenderSpec

java.lang.Object
  extended by 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 PDF 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 Adobe Experience Manager forms.

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

Parameters:
injectFormBridge - true if the PDF 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 PDF forms service to produce FormGuide transformations.

Parameters:
locale - The locale value to set. The following table lists valid values:
LocaleDescription
zh_CNChinese, Simplified (P.R.C.)
zh_TWChinese, Traditional (Taiwan
zh_HKChinese, Traditional with HKSCS-2001 Extensions (Hong Kong)
hr_HRCroatian (Republic of Croatia)
cs_CZCzech (Czech Republic)
da_DKDanish (Denmark)
nl_BEDutch (Belgium)
nl_NLDutch (Netherlands)
en_AUEnglish (Australia)
en_CAEnglish (Canada)
en_INEnglish (India)
en_IEEnglish (Ireland)
en_NZEnglish (New Zealand)
en_ZAEnglish (South Africa)
en_GBEnglish (United Kingdom)
en_ENEnglish (United Kingdom, Euro Currency)
en_USEnglish (United States)
fi_FIFinnish (Finland)
fr_BEFrench (Belgium)
fr_CAFrench (Canada)
fr_FRFrench (France)
fr_LUFrench (Luxembourg)
fr_CHFrench (Switzerland)
de_ATGerman (Austria)
de_DEGerman (Germany)
de_LUGerman (Luxembourg)
de_CHGerman (Switzerland)
el_GRGreek (Greece)
hu_HUHungarian (Hungary)
it_ITItalian (Italy)
it_CHItalian (Switzerland)
ja_JPJapanese (Japan)
ko_KRKorean (Korea)
no_NONorwegian (Norway)
no_NO_NYNorwegian (Norway, Nynorsk)
pl_PLPolish (Poland)
pt_BRPortuguese (Brazil)
pt_PTPortuguese (Portugal)
ro_RORomanian (Romania)
sh_BASerbo-Croatian (Bosnia and Herzegovina)
sh_HRSerbo-Croatian (Croatia)
sh_CSSerbo-Croatian (Republic of Serbia and Montenegro)
sk_SKSlovak (Slovak Republic)
es_ARSpanish (Argentina)
da_DKSpanish (Bolivia)
es_CLSpanish (Chile)
es_COSpanish (Costa Rica)
es_DOSpanish (Dominican Republic)
es_ECSpanish (Ecuador)
es_SVSpanish (El Salvador)
es_GTSpanish (Guatemala)
es_HNSpanish (Honduras)
es_MXSpanish (Mexico)
es_NISpanish (Nicaragua)
es_PASpanish (Panama)
es_PYSpanish (Paraguay)
es_PESpanish (Peru)
es_PRSpanish (Puerto Rico)
es_ESSpanish (Spain)
es_UYSpanish (Uruguay
es_VESpanish (Venezuela)
sv_SESwedish (Sweden)
tr_TRTurkish (Turkey)