Package com.adobe.cq.forms.core.components.models.form

Interface Base

All Superinterfaces:

Component, com.adobe.cq.export.json.ComponentExporter, FormComponent

All Known Subinterfaces:

Button, Captcha, CheckBox, CheckBoxGroup, Container, DatePicker, DropDown, Field, FileInput, FormContainer, Fragment, HCaptcha, NumberInput, Panel, RadioButton, Review, Switch, TermsAndConditions, TextInput, Turnstile

All Known Implementing Classes:

AbstractBaseImpl, AbstractCaptchaImpl, AbstractCaptchaImplV2, AbstractCheckboxImpl, AbstractContainerImpl, AbstractFieldImpl, AbstractOptionsFieldImpl

@ProviderType
public interface Base
extends FormComponent

A base interface to be extended by all the different types of form elements.

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DATE_FORMATTER
static java.lang.String	DEFAULT_LANGUAGE	Constant representing the default language used, typically "en-US".

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

PN_ID

Fields inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent

CUSTOM_PROPERTY_WRAPPER

Method Summary

Modifier and Type	Method	Description
default @NotNull java.util.Map<ConstraintType,java.lang.String>	getConstraintMessages()	Returns map of constraint messages specific to each constraint (like required, minLength etc).
default @Nullable java.lang.String	getDescription()	Returns the description of the field
default @NotNull java.lang.String	getExportedType()
default @Nullable java.lang.String	getHtmlScreenReaderText()	Returns the string to indicate the text to be read by screen readers.
default @Nullable Label	getLabel()	Returns label of the form field
default @Nullable java.lang.String	getLang()	Returns the language to use for formatting the field.
default @Nullable java.lang.String	getScreenReaderText()	Returns json formula rule to indicate the text to be read by screen readers based on the AssistPriority configured.
default @Nullable java.lang.String	getTooltip()	Returns the tool tip of the field
default @Nullable java.lang.Boolean	isEnabled()	Returns true if form field should be enabled, otherwise false.
default boolean	isTooltipVisible()	Returns true if tooltip should always be visible, otherwise false.

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

getAppliedCssClasses, getData, getId

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent

getDataRef, getDorProperties, getEvents, getFieldType, getName, getPath, getProperties, getRules, isVisible, setI18n

Field Detail

DATE_FORMATTER

static final java.lang.String DATE_FORMATTER

See Also:

Constant Field Values

DEFAULT_LANGUAGE

static final java.lang.String DEFAULT_LANGUAGE

Constant representing the default language used, typically "en-US".

Since:

com.adobe.cq.forms.core.components.models.form 5.3.1

See Also:

Constant Field Values

Method Detail

getLabel

@Nullable
default @Nullable Label getLabel()

Returns label of the form field

Returns:

label of the field

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getDescription

@Nullable
default @Nullable java.lang.String getDescription()

Returns the description of the field

Returns:

the description of the field

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getScreenReaderText

@Nullable
default @Nullable java.lang.String getScreenReaderText()

Returns json formula rule to indicate the text to be read by screen readers based on the AssistPriority configured.

Returns:

the screen reader text as json formula rule

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getHtmlScreenReaderText

@Nullable
default @Nullable java.lang.String getHtmlScreenReaderText()

Returns the string to indicate the text to be read by screen readers. This could be used on server side to compute initial rendition

Returns:

the screen reader text

Since:

com.adobe.cq.forms.core.components.models.form 2.0.0

isEnabled

@Nullable
default @Nullable java.lang.Boolean isEnabled()

Returns true if form field should be enabled, otherwise false.

Returns:

true if form field should be enabled, otherwise false

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getConstraintMessages

@NotNull
default @NotNull java.util.Map<ConstraintType,java.lang.String> getConstraintMessages()

Returns map of constraint messages specific to each constraint (like required, minLength etc). The constraint list would change based on the form field type

Returns:

map of constraint messages specific to each constraint.

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getExportedType

@NotNull
default @NotNull java.lang.String getExportedType()

Specified by:

getExportedType in interface Component

Specified by:

getExportedType in interface com.adobe.cq.export.json.ComponentExporter

Since:

com.adobe.cq.wcm.core.components.models.form 14.2.0

See Also:

ComponentExporter.getExportedType()

getTooltip

@Nullable
default @Nullable java.lang.String getTooltip()

Returns the tool tip of the field

Returns:

the tool tip of the field

Since:

com.adobe.cq.forms.core.components.models.form 2.0.0

isTooltipVisible

default boolean isTooltipVisible()

Returns true if tooltip should always be visible, otherwise false.

Returns:

true if tooltip should always be visible, otherwise false

Since:

com.adobe.cq.forms.core.components.models.form 2.0.0

getLang

@Nullable
default @Nullable java.lang.String getLang()

Returns the language to use for formatting the field.

Returns:

returns the language to use for formatting the field.

Since:

com.adobe.cq.forms.core.components.models.form 5.3.1