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

Interface FormComponent

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

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

@ProviderType
public interface FormComponent
extends Component

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CUSTOM_PROPERTY_WRAPPER

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

PN_ID

Method Summary

Modifier and Type	Method	Description
default @Nullable java.lang.String	getDataRef()	Returns the reference to the data model
default java.util.Map<java.lang.String,java.lang.Object>	getDorProperties()	Custom DOR Properties
default @NotNull java.util.Map<java.lang.String,java.lang.String[]>	getEvents()	Returns the events defined for the component after filtering out invalid rules
java.lang.String	getFieldType()	Returns the field type
default @Nullable java.lang.String	getName()	Returns the name of the form field
default java.lang.String	getPath()	Returns getPath of the form field
default @NotNull java.util.Map<java.lang.String,java.lang.Object>	getProperties()	Custom Properties
default @NotNull java.util.Map<java.lang.String,java.lang.String>	getRules()	Returns the rules defined for the component after filtering out invalid rules If no rules are defined, returns an empty map
default @Nullable java.lang.Boolean	isVisible()	Returns true if form field should be visible, otherwise false.
default void	setI18n(com.day.cq.i18n.I18n i18n)	Sets i18n object

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

getAppliedCssClasses, getData, getExportedType, getId

Field Detail

CUSTOM_PROPERTY_WRAPPER

static final java.lang.String CUSTOM_PROPERTY_WRAPPER

See Also:

Constant Field Values

Method Detail

getFieldType

java.lang.String getFieldType()

Returns the field type

Returns:

the field type

Since:

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

isVisible

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

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

Returns:

true if form field should be visible, otherwise false

Since:

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

getProperties

@NotNull
default @NotNull java.util.Map<java.lang.String,java.lang.Object> getProperties()

Custom Properties

Since:

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

getDorProperties

default java.util.Map<java.lang.String,java.lang.Object> getDorProperties()

Custom DOR Properties

Since:

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

getPath

default java.lang.String getPath()

Returns getPath of the form field

Returns:

getPath of the field

Since:

com.adobe.cq.forms.core.components.util 3.1.0

getName

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

Returns the name of the form field

Returns:

name of the form field

Since:

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

getDataRef

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

Returns the reference to the data model

Returns:

reference to the data model

Since:

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

getRules

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

Returns the rules defined for the component after filtering out invalid rules If no rules are defined, returns an empty map

Returns:

map containing the rules and their expressions

getEvents

@NotNull
default @NotNull java.util.Map<java.lang.String,java.lang.String[]> getEvents()

Returns the events defined for the component after filtering out invalid rules

Returns:

map containing the events and their expressions If no rules are defined, returns an empty map

setI18n

default void setI18n(@Nonnull
                     com.day.cq.i18n.I18n i18n)

Sets i18n object

Parameters:

i18n - reference to the I18n object

Since:

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