Package com.adobe.aemds.guide.common
Class AEMForm
- java.lang.Object
-
- com.adobe.cq.sightly.WCMUsePojo
-
- com.adobe.aemds.guide.common.AEMForm
-
- All Implemented Interfaces:
Use
- Direct Known Subclasses:
AdaptiveForm
public class AEMForm extends WCMUsePojo
AEMForm class encapsulates basic properties of an AEM Form.- Since:
- 6.2
-
-
Field Summary
Fields Modifier and Type Field Description static intADAPTIVE_FORMstatic intINLINE_SUBMITstatic intMC_DOCUMENTstatic intMOBILE_FORMstatic intMOBILE_FORMSETstatic intNO_FORM_SELECTEDstatic intPAGE_REFRESH_SUBMITstatic java.lang.StringPROP_THANK_YOU_CONFIGstatic java.lang.StringPROP_THANK_YOU_MESSAGEstatic java.lang.StringPROP_THANK_YOU_PAGE
-
Constructor Summary
Constructors Constructor Description AEMForm()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactivate()Implement this method to perform post initialization tasks.java.lang.StringgetAdditionalParamString()java.lang.StringgetCssClientlib()booleangetEnableFocusOnFirstField()Returns the configuration to enable focus on form.java.lang.StringgetFormEditPagePath()java.lang.StringgetFormPath()intgetFormType()java.lang.StringgetHeight()The functions checks the height set in the dialog.booleangetIsAdaptiveForm()booleangetIsFormSelected()booleangetIsMCDocument()booleangetIsMobileForm()booleangetIsMobileFormset()booleangetIsPlaceholderVisible()java.lang.StringgetPath()java.lang.StringgetSubmitType()java.lang.StringgetThankyouConfig()java.lang.StringgetThankyouMessage()java.lang.StringgetThankyouPage()java.lang.StringgetThemeName()Returns the client lib name for the themejava.lang.StringgetThemePath()Returns the path of the theme associated with adaptive form.-
Methods inherited from class com.adobe.cq.sightly.WCMUsePojo
get, getComponent, getComponentContext, getCurrentDesign, getCurrentPage, getCurrentStyle, getDesigner, getEditContext, getInheritedPageProperties, getInheritedProperties, getPageManager, getPageProperties, getProperties, getRequest, getResource, getResourceDesign, getResourcePage, getResourceResolver, getResponse, getSlingScriptHelper, getWcmMode, getXSSAPI, init
-
-
-
-
Field Detail
-
NO_FORM_SELECTED
public static final int NO_FORM_SELECTED
- See Also:
- Constant Field Values
-
MOBILE_FORM
public static final int MOBILE_FORM
- See Also:
- Constant Field Values
-
ADAPTIVE_FORM
public static final int ADAPTIVE_FORM
- See Also:
- Constant Field Values
-
MC_DOCUMENT
public static final int MC_DOCUMENT
- See Also:
- Constant Field Values
-
MOBILE_FORMSET
public static final int MOBILE_FORMSET
- See Also:
- Constant Field Values
-
INLINE_SUBMIT
public static final int INLINE_SUBMIT
- See Also:
- Constant Field Values
-
PAGE_REFRESH_SUBMIT
public static final int PAGE_REFRESH_SUBMIT
- See Also:
- Constant Field Values
-
PROP_THANK_YOU_CONFIG
public static final java.lang.String PROP_THANK_YOU_CONFIG
- See Also:
- Constant Field Values
-
PROP_THANK_YOU_PAGE
public static final java.lang.String PROP_THANK_YOU_PAGE
- See Also:
- Constant Field Values
-
PROP_THANK_YOU_MESSAGE
public static final java.lang.String PROP_THANK_YOU_MESSAGE
- See Also:
- Constant Field Values
-
-
Method Detail
-
activate
public void activate() throws java.lang.ExceptionDescription copied from class:WCMUsePojoImplement this method to perform post initialization tasks. This method is called byWCMUsePojo.init(Bindings).- Specified by:
activatein classWCMUsePojo- Throws:
java.lang.Exception- in case of any error during activation
-
getThemeName
public java.lang.String getThemeName()
Returns the client lib name for the theme- Returns:
- client lib name of the theme configured for the form
-
getFormPath
public java.lang.String getFormPath()
-
getEnableFocusOnFirstField
public boolean getEnableFocusOnFirstField()
Returns the configuration to enable focus on form.- Returns:
- boolean to enable/disable focus on form
-
getThemePath
public java.lang.String getThemePath()
Returns the path of the theme associated with adaptive form.- Returns:
- Path of the theme associated with adaptive form.
-
getFormEditPagePath
public java.lang.String getFormEditPagePath()
-
getFormType
public int getFormType()
-
getIsAdaptiveForm
public boolean getIsAdaptiveForm()
-
getIsMCDocument
public boolean getIsMCDocument()
-
getIsMobileForm
public boolean getIsMobileForm()
-
getIsMobileFormset
public boolean getIsMobileFormset()
-
getIsFormSelected
public boolean getIsFormSelected()
-
getSubmitType
public java.lang.String getSubmitType()
-
getThankyouMessage
public java.lang.String getThankyouMessage()
-
getThankyouPage
public java.lang.String getThankyouPage()
-
getThankyouConfig
public java.lang.String getThankyouConfig()
-
getHeight
public java.lang.String getHeight()
The functions checks the height set in the dialog. It appends the height with px unless it is auto. For invalid values (non integers), auto is returned.- Returns:
- height of the form configured
-
getCssClientlib
public java.lang.String getCssClientlib()
-
getAdditionalParamString
public java.lang.String getAdditionalParamString()
-
getIsPlaceholderVisible
public boolean getIsPlaceholderVisible()
-
getPath
public java.lang.String getPath()
-
-