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

Interface Field

All Superinterfaces:

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

All Known Subinterfaces:

Captcha, CheckBox, CheckBoxGroup, DatePicker, DropDown, FileInput, HCaptcha, NumberInput, RadioButton, Switch, TextInput, Turnstile

All Known Implementing Classes:

AbstractCaptchaImpl, AbstractCaptchaImplV2, AbstractCheckboxImpl, AbstractFieldImpl, AbstractOptionsFieldImpl

@ProviderType
public interface Field
extends Base, BaseConstraint

Defines the form Field Sling Model used for form field component.

Since:

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.forms.core.components.models.form.BaseConstraint

BaseConstraint.Type

Field Summary

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

DATE_FORMATTER, DEFAULT_LANGUAGE

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 java.lang.String	getDataFormat()	The format in which the value will be exported or submitted.
default java.lang.Object[]	getDefault()	The value of the field when no value is provided by the end user or data model.
default java.lang.String	getDisplayFormat()	The format in which the value will be displayed to the user on screen in the field.
default java.lang.String	getDisplayValueExpression()	The expression that when evaluated would determine what the displayValue of a field would be
default java.lang.String	getEditFormat()	The format in which the value will be edited by the user.
default java.lang.String	getPlaceHolder()	The placeholder to show on the field.
default java.lang.Boolean	isReadOnly()	Checks if the field should be rendered read only.

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

getConstraintMessages, getDescription, getExportedType, getHtmlScreenReaderText, getLabel, getLang, getScreenReaderText, getTooltip, isEnabled, isTooltipVisible

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

getType, getValidationExpression, isRequired

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

Method Detail

isReadOnly

@Nullable
default java.lang.Boolean isReadOnly()

Checks if the field should be rendered read only.

Returns:

true if the field should be read-only, false otherwise

Since:

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

getPlaceHolder

default java.lang.String getPlaceHolder()

The placeholder to show on the field.

Returns:

placeholder to show on the field

Since:

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

getDisplayFormat

default java.lang.String getDisplayFormat()

The format in which the value will be displayed to the user on screen in the field. For example when using a currency field, the currency sign should be shown to the user.

Returns:

display format of the field

Since:

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

getEditFormat

default java.lang.String getEditFormat()

The format in which the value will be edited by the user. For instance users in Germany would want to interchange decimal (.) and comma (,) when entering numerical values.

Returns:

edit format of the field

Since:

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

getDataFormat

default java.lang.String getDataFormat()

The format in which the value will be exported or submitted.

Returns:

data format of the field

Since:

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

getDefault

default java.lang.Object[] getDefault()

The value of the field when no value is provided by the end user or data model. The type of this property should match the value of the type property defined in the Field. If not, then a type coercion will be tried and if that fails, the value will be set to null.

Returns:

default value of the field

Since:

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

getDisplayValueExpression

default java.lang.String getDisplayValueExpression()

The expression that when evaluated would determine what the displayValue of a field would be

Returns:

display value expression of the field

Since:

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