AEMForm (AEM Forms API)

java.lang.Object
- WCMUsePojo
- - com.adobe.aemds.guide.common.AEMForm

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 and Description
`static int`	`ADAPTIVE_FORM`
`static int`	`INLINE_SUBMIT`
`static int`	`MOBILE_FORM`
`static int`	`MOBILE_FORMSET`
`protected org.apache.sling.api.resource.Resource`	`mResource`
`protected org.apache.sling.api.resource.ValueMap`	`mResourceProps`
`static int`	`NO_FORM_SELECTED`
`static int`	`PAGE_REFRESH_SUBMIT`
`static String`	`PROP_THANK_YOU_CONFIG`
`static String`	`PROP_THANK_YOU_MESSAGE`
`static String`	`PROP_THANK_YOU_PAGE`

Constructor Summary

Constructors
Constructor and Description

AEMForm()

Constructors
Constructor and Description
`AEMForm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()`
`String`	`getAdditionalParamString()`
`protected String`	`getClientLibCategory(String themePath)`
`String`	`getCssClientlib()`
`String`	`getFormEditPagePath()`
`String`	`getFormPath()`
`int`	`getFormType()`
`String`	`getHeight()` The functions checks the height set in the dialog.
`boolean`	`getIsAdaptiveForm()`
`boolean`	`getIsFormSelected()`
`boolean`	`getIsMobileForm()`
`boolean`	`getIsMobileFormset()`
`boolean`	`getIsPlaceholderVisible()`
`String`	`getSubmitType()`
`String`	`getThankyouConfig()`
`String`	`getThankyouMessage()`
`String`	`getThankyouPage()`
`String`	`getThemeName()` Returns the client lib name for the theme
`String`	`getThemePath()` Returns the path of the theme associated with adaptive form.
`protected String`	`getThemeRef()` Returns the theme associated with adaptive form.

- 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
  - 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 String PROP_THANK_YOU_CONFIG
```
    See Also:
    
    Constant Field Values
  - PROP_THANK_YOU_PAGE
```
public static final String PROP_THANK_YOU_PAGE
```
    See Also:
    
    Constant Field Values
  - PROP_THANK_YOU_MESSAGE
```
public static final String PROP_THANK_YOU_MESSAGE
```
    See Also:
    
    Constant Field Values
  - mResource
```
protected org.apache.sling.api.resource.Resource mResource
```
  - mResourceProps
```
protected org.apache.sling.api.resource.ValueMap mResourceProps
```
- Constructor Detail
  - AEMForm
```
public AEMForm()
```
- Method Detail
  - activate
```
public void activate()
              throws Exception
```
    Throws:
    
    Exception
  - getClientLibCategory
```
protected String getClientLibCategory(String themePath)
```
  - getThemeName
```
public String getThemeName()
```
    Returns the client lib name for the theme
    
    Returns:
    
    client lib name of the theme configured for the form
  - getFormPath
```
public String getFormPath()
```
  - getThemeRef
```
protected String getThemeRef()
```
    Returns the theme associated with adaptive form.
    
    Returns:
    
    path of the theme associated with the form.
  - getThemePath
```
public String getThemePath()
```
    Returns the path of the theme associated with adaptive form.
    
    Returns:
    
    Path of the theme associated with adaptive form.
  - getFormEditPagePath
```
public String getFormEditPagePath()
```
  - getFormType
```
public int getFormType()
```
  - getIsAdaptiveForm
```
public boolean getIsAdaptiveForm()
```
  - getIsMobileForm
```
public boolean getIsMobileForm()
```
  - getIsMobileFormset
```
public boolean getIsMobileFormset()
```
  - getIsFormSelected
```
public boolean getIsFormSelected()
```
  - getSubmitType
```
public String getSubmitType()
```
  - getThankyouMessage
```
public String getThankyouMessage()
```
  - getThankyouPage
```
public String getThankyouPage()
```
  - getThankyouConfig
```
public String getThankyouConfig()
```
  - getHeight
```
public 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 String getCssClientlib()
```
  - getAdditionalParamString
```
public String getAdditionalParamString()
```
  - getIsPlaceholderVisible
```
public boolean getIsPlaceholderVisible()
```

Class AEMForm

Field Summary

Constructor Summary

Method Summary

Field Detail

NO_FORM_SELECTED

MOBILE_FORM

ADAPTIVE_FORM

MOBILE_FORMSET

INLINE_SUBMIT

PAGE_REFRESH_SUBMIT

PROP_THANK_YOU_CONFIG

PROP_THANK_YOU_PAGE

PROP_THANK_YOU_MESSAGE

mResource

mResourceProps

Constructor Detail

AEMForm

Method Detail

activate

getClientLibCategory

getThemeName

getFormPath

getThemeRef

getThemePath

getFormEditPagePath

getFormType

getIsAdaptiveForm

getIsMobileForm

getIsMobileFormset

getIsFormSelected

getSubmitType

getThankyouMessage

getThankyouPage

getThankyouConfig

getHeight

getCssClientlib

getAdditionalParamString

getIsPlaceholderVisible