Interface AEMForm
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
AEMForm.FormType
Defines the form type
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PN_CSSCLIENTLIB
Name of the resource property that defines the client librarystatic java.lang.String
PN_DOCREF
Name of the resource property that defines the document referencestatic java.lang.String
PN_ENABLEFOCUSONFIRSTFIELD
Name of the resource property that defines whether to enable focus on first field of form or notstatic java.lang.String
PN_FORMREF
Name of the resource property that defines the form referencestatic java.lang.String
PN_FORMTYPE
Name of the resource property that defines the type of the formstatic java.lang.String
PN_HEIGHT
Name of the resource property that defines the heightstatic java.lang.String
PN_SUBMITTYPE
Name of the resource property that defines the submit typestatic java.lang.String
PN_THANK_YOU_CONFIG
Name of the resource property that defines the thank you config.static java.lang.String
PN_THANK_YOU_MESSAGE
Name of the resource property that defines the thank you message.static java.lang.String
PN_THANK_YOU_PAGE
Name of the resource property that defines the thank you pagestatic java.lang.String
PN_THEMEREF
Name of the resource property that defines the theme ref property.static java.lang.String
PN_USEIFRAME
Name of the resource property that defines whether to use iframe or notstatic java.lang.String
PN_USEPAGELOCALE
Name of the resource property that defines whether to use page locale or not
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.lang.String
getCssClientlib()
Returns the CSS client librarydefault boolean
getEnableFocusOnFirstField()
Indicates if the form is configured to enable focus on first field or notdefault java.lang.String
getExportedType()
default java.lang.String
getFormEditPagePath()
Returns the form edit page pathdefault java.lang.String
getFormPagePath()
Returns the form page path (ie) path to the container of the form resourcedefault AEMForm.FormType
getFormType()
Returns the form typedefault java.lang.String
getFormVersion()
Provides the form versiondefault java.lang.String
getHeight()
Returns the height of the form/documentdefault @Nullable java.util.List<HtmlPageItem>
getHtmlPageItems()
Returns a list of HTML items that should be included in the formdefault java.lang.String
getLocale()
Returns the form localedefault java.lang.String
getSubmitType()
Returns the submit type for the formdefault java.lang.String
getThankyouConfig()
Returns the thank you configurationdefault java.lang.String
getThankyouMessage()
Returns the thank you messagedefault java.lang.String
getThankyouPage()
Returns the thank you pagedefault java.lang.String
getThemeName()
Returns the name of the themedefault java.lang.String
getThemePath()
Returns the theme pathdefault java.lang.String
getUseIframe()
Indicates if the form is configured to use iframe or notdefault boolean
isAdaptiveForm()
Indicates if the form configured is Adaptive form or notdefault boolean
isFormSelected()
Indicates if the form is selector or notdefault boolean
isMCDocument()
Indicates if the form configured is multi channel document or notdefault boolean
isMobileForm()
Indicates if the form configured is mobile form or notdefault boolean
isMobileFormset()
Indicates if the form configured is mobile formset or not-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getId
-
-
-
-
Field Detail
-
PN_THANK_YOU_CONFIG
static final java.lang.String PN_THANK_YOU_CONFIG
Name of the resource property that defines the thank you config.- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_THANK_YOU_PAGE
static final java.lang.String PN_THANK_YOU_PAGE
Name of the resource property that defines the thank you page- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_THANK_YOU_MESSAGE
static final java.lang.String PN_THANK_YOU_MESSAGE
Name of the resource property that defines the thank you message.- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_FORMTYPE
static final java.lang.String PN_FORMTYPE
Name of the resource property that defines the type of the form- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_FORMREF
static final java.lang.String PN_FORMREF
Name of the resource property that defines the form reference- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_DOCREF
static final java.lang.String PN_DOCREF
Name of the resource property that defines the document reference- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_THEMEREF
static final java.lang.String PN_THEMEREF
Name of the resource property that defines the theme ref property.- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_SUBMITTYPE
static final java.lang.String PN_SUBMITTYPE
Name of the resource property that defines the submit type- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_CSSCLIENTLIB
static final java.lang.String PN_CSSCLIENTLIB
Name of the resource property that defines the client library- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_HEIGHT
static final java.lang.String PN_HEIGHT
Name of the resource property that defines the height- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_USEIFRAME
static final java.lang.String PN_USEIFRAME
Name of the resource property that defines whether to use iframe or not- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_USEPAGELOCALE
static final java.lang.String PN_USEPAGELOCALE
Name of the resource property that defines whether to use page locale or not- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
- Constant Field Values
-
PN_ENABLEFOCUSONFIRSTFIELD
static final java.lang.String PN_ENABLEFOCUSONFIRSTFIELD
Name of the resource property that defines whether to enable focus on first field of form or not- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.14
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFormType
default AEMForm.FormType getFormType()
Returns the form type- Returns:
- the form type, if one was set
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getThemePath
default java.lang.String getThemePath()
Returns the theme path- Returns:
- the theme path, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getFormEditPagePath
default java.lang.String getFormEditPagePath()
Returns the form edit page path- Returns:
- the form path, if one was set
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getFormPagePath
default java.lang.String getFormPagePath()
Returns the form page path (ie) path to the container of the form resource- Returns:
- the form page path, if one was set
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getLocale
default java.lang.String getLocale()
Returns the form locale- Returns:
- the form locale, if one was set
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getThankyouConfig
default java.lang.String getThankyouConfig()
Returns the thank you configuration- Returns:
- the form type, if one was set
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getThankyouPage
default java.lang.String getThankyouPage()
Returns the thank you page- Returns:
- the form type, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getThankyouMessage
default java.lang.String getThankyouMessage()
Returns the thank you message- Returns:
- the thank you message, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getThemeName
default java.lang.String getThemeName()
Returns the name of the theme- Returns:
- the theme name, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getSubmitType
default java.lang.String getSubmitType()
Returns the submit type for the form- Returns:
- the submit type, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getCssClientlib
default java.lang.String getCssClientlib()
Returns the CSS client library- Returns:
- the css client library, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getHeight
default java.lang.String getHeight()
Returns the height of the form/document- Returns:
- the height, if one was set, or
null
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getEnableFocusOnFirstField
default boolean getEnableFocusOnFirstField()
Indicates if the form is configured to enable focus on first field or not- Returns:
- true if the form is configured to enable focus on first field; false otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.14;
-
getUseIframe
default java.lang.String getUseIframe()
Indicates if the form is configured to use iframe or not- Returns:
- "true" if the form is configured to use iframe; "false" otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
isAdaptiveForm
default boolean isAdaptiveForm()
Indicates if the form configured is Adaptive form or not- Returns:
- true if the form is adaptive form; false otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
isMCDocument
default boolean isMCDocument()
Indicates if the form configured is multi channel document or not- Returns:
- true if the form is multi channel document; false otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
isMobileForm
default boolean isMobileForm()
Indicates if the form configured is mobile form or not- Returns:
- true if the form is mobile form; false otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
isMobileFormset
default boolean isMobileFormset()
Indicates if the form configured is mobile formset or not- Returns:
- true if the form is mobile formset; false otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
isFormSelected
default boolean isFormSelected()
Indicates if the form is selector or not- Returns:
- true if a form is selected; false otherwise
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1;
-
getExportedType
@Nonnull default java.lang.String getExportedType()
- Specified by:
getExportedType
in interfaceComponent
- Specified by:
getExportedType
in interfacecom.adobe.cq.export.json.ComponentExporter
- Since:
- com.adobe.cq.forms.core.components.models.aemform 0.0.1
- See Also:
ComponentExporter.getExportedType()
-
getHtmlPageItems
@Nullable default @Nullable java.util.List<HtmlPageItem> getHtmlPageItems()
Returns a list of HTML items that should be included in the form- Returns:
- list of page items
- Since:
- com.adobe.cq.forms.core.components.models.aemform 1.2.0
-
getFormVersion
default java.lang.String getFormVersion()
Provides the form version- Returns:
- form version as set in guidecontainer
- Since:
- com.adobe.cq.forms.core.components.models.aemform 1.3.0;
-
-