com.adobe.aemds.guide.common

Class GuideField

java.lang.Object

WCMUsePojo

com.adobe.aemds.guide.common.GuideNode

com.adobe.aemds.guide.common.GuideField

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GuideButton, GuideCaptcha, GuideChart, GuideCheckBox, GuideDatePicker, GuideDropDownList, GuideFileUpload, GuideImage, GuideNumericBox, GuidePasswordBox, GuideScribble, GuideSeparator, GuideSwitch, GuideTermsAndConditions, GuideTextBox, GuideTextDraw

public abstract class GuideField
extends GuideNode

GuideField is a base class from which every AEM form field component inherits from. It abstracts the basic properties of a field. Few are:

• Hiding the title of the field
• Short Description of the field
• Long description

This provides basic getter's and setter's required to create/initialize an AEM Form Field Component.

Since:

AEM 6.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	helpQuestionMarkContent

Fields inherited from class com.adobe.aemds.guide.common.GuideNode

baseName, clientLibRef, error, i18n, id, inlineStyles, locale, localeName, logger, resourceProps, slingRequest, xssapi

Constructor Summary

Constructors

Constructor and Description
GuideField()

Method Summary

Modifier and Type	Method and Description
Boolean	getAutocomplete() Returns the value of autocomplete
String	getAutofillFieldKeyword() Returns the value of autofill field keyword
String	getCaptionInlineStyles() Returns the string containing the inline style specified for the caption
Boolean	getDescriptionVisibility() Returns the visibility of the short description as specified in the Authoring Dialog
String	getErrorSimulatorString() Returns the error simulation string to be shown in Authoring for styling purposes
String	getFieldLayout() Returns the field layout configured during authoring.
String	getFieldLayoutName() Returns the name of the field layout
abstract String	getGuideFieldType() Returns the field type of the AEM Forms Component
String	getHelpIndicatorContent() Returns the help content for field
boolean	getHideTitle() Returns if the current field's title is hidden or not
boolean	getIsOldFieldLayout()
Boolean	getIsReadOnly()
Boolean	getIsRequired()
String	getLongDescription() Returns the long description of the field configured in authoring dialog
String	getPlaceholderText() Returns the placeholder text set in the authoring dialog
String	getShortDescription() Returns the short description of the field configured in the authoring dialog
String	getShortDescriptionInlineStyles() Returns the string containing the inline style specified for the short description
String	getValue() Returns the initial value of the field set in the authoring dialog
String	getWidgetInlineStyles() Returns the string containing the inline style specified for the widget
boolean	isMandatory() Return if the field is marked as required.
void	setHelpIndicatorContent(String helpQuestionMarkContent) Sets the help indicator content for the field.

Methods inherited from class com.adobe.aemds.guide.common.GuideNode

activate, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getClientLibRef, getColspan, getCssClassName, getDescription, getEnabled, getEnabledExp, getError, getFieldInlineStyles, getHeight, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsRepeatable, getItems, getLayoutPath, getLayoutProperty, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getSlingRequest, getStyles, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisible, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, setSlingRequest, syncNode

Field Detail

helpQuestionMarkContent

protected String helpQuestionMarkContent

Constructor Detail

GuideField

public GuideField()

Method Detail

getIsRequired

public Boolean getIsRequired()

getIsReadOnly

public Boolean getIsReadOnly()

getAutofillFieldKeyword

public String getAutofillFieldKeyword()

Returns the value of autofill field keyword

Returns:

String representing autofill field keyword value

getAutocomplete

public Boolean getAutocomplete()

Returns the value of autocomplete

Returns:

Boolean representing autocomplete value

getGuideFieldType

public abstract String getGuideFieldType()

Returns the field type of the AEM Forms Component

Returns:

String representing guide field type

getIsOldFieldLayout

public boolean getIsOldFieldLayout()

getFieldLayout

public String getFieldLayout()

Returns the field layout configured during authoring. If field layout is specified at field level, it takes priority, else field layout configured in adaptive form container is honored.

Returns:

path of the field layout

getFieldLayoutName

public String getFieldLayoutName()

Returns the name of the field layout

Returns:

name of the field layout configured

getHideTitle

public boolean getHideTitle()

Returns if the current field's title is hidden or not

Returns:

boolean indicating if title is hidden or not

getShortDescription

public String getShortDescription()

Returns the short description of the field configured in the authoring dialog

Returns:

string representing the short description of the field

getLongDescription

public String getLongDescription()

Returns the long description of the field configured in authoring dialog

Returns:

String representing the long description

getDescriptionVisibility

public Boolean getDescriptionVisibility()

Returns the visibility of the short description as specified in the Authoring Dialog

Returns:

true if "Always show short Description" is selected otherwise false

getValue

public String getValue()

Returns the initial value of the field set in the authoring dialog

Returns:

String representing the default value

getCaptionInlineStyles

public String getCaptionInlineStyles()

Returns the string containing the inline style specified for the caption

Returns:

inline style of the caption

getWidgetInlineStyles

public String getWidgetInlineStyles()

Returns the string containing the inline style specified for the widget

Returns:

inline style of the widget

setHelpIndicatorContent

public void setHelpIndicatorContent(String helpQuestionMarkContent)

Sets the help indicator content for the field. By default the indicator is represented as a "?", but can be changed through this API.

Parameters:

helpQuestionMarkContent - string representing the help question mark content

getHelpIndicatorContent

public String getHelpIndicatorContent()

Returns the help content for field

Returns:

question mark content of the help

getShortDescriptionInlineStyles

public String getShortDescriptionInlineStyles()

Returns the string containing the inline style specified for the short description

Returns:

inline style of the short description

getPlaceholderText

public String getPlaceholderText()

Returns the placeholder text set in the authoring dialog

Returns:

place holder text set for the field

getErrorSimulatorString

public String getErrorSimulatorString()

Returns the error simulation string to be shown in Authoring for styling purposes

Returns:

error simulation string for a given field

isMandatory

public boolean isMandatory()

Return if the field is marked as required.

Returns:

true if field is configured as mandatory, false otherwise