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

Class AbstractFieldImpl

java.lang.Object

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

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCaptchaImpl, AbstractOptionsFieldImpl

public abstract class AbstractFieldImpl
extends AbstractBaseImpl
implements Field

Abstract class which can be used as base class for Field implementations.

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 class com.adobe.cq.forms.core.components.util.AbstractFormComponentImpl

CUSTOM_DOR_PROPERTY_WRAPPER, CUSTOM_JCR_PATH_PROPERTY_WRAPPER, CUSTOM_RULE_PROPERTY_WRAPPER

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

Constructor Summary

Constructors

Constructor	Description
AbstractFieldImpl()

Method Summary

Modifier and Type	Method	Description
@Nullable java.lang.String	getDataFormat()	The format in which the value will be exported or submitted.
java.lang.Object[]	getDefault()	The value of the field when no value is provided by the end user or data model.
@Nullable java.lang.String	getDisplayFormat()	The format in which the value will be displayed to the user on screen in the field.
@Nullable java.lang.String	getDisplayValueExpression()	The expression that when evaluated would determine what the displayValue of a field would be
@Nullable java.lang.String	getEditFormat()	The format in which the value will be edited by the user.
@Nullable java.lang.String	getPlaceHolder()	The placeholder to show on the field.
java.lang.Boolean	getReadOnlyIfPresent()
java.lang.Boolean	getRequiredIfPresent()
@Nullable java.lang.Boolean	isReadOnly()	Checks if the field should be rendered read only.
@Nullable java.lang.Boolean	isRequired()	Returns true if field is required, otherwise false.

Methods inherited from class com.adobe.cq.forms.core.components.util.AbstractBaseImpl

getConstraintMessages, getCustomLayoutProperties, getDescription, getEnabledIfPresent, getExportedType, getHtmlScreenReaderText, getLabel, getLang, getScreenReaderText, getTooltip, getTooltipText, getType, getValidationExpression, isEnabled, isTooltipVisible

Methods inherited from class com.adobe.cq.forms.core.components.util.AbstractFormComponentImpl

getData, getDataRef, getDorProperties, getEvents, getFieldType, getLinkUrl, getName, getPath, getProperties, getRules, getText, getTitle, getVisibleIfPresent, isVisible, setI18n

Methods inherited from class com.adobe.cq.forms.core.components.util.AbstractComponentImpl

getAppliedCssClasses, getId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

AbstractFieldImpl

public AbstractFieldImpl()

Method Detail

isReadOnly

@Nullable
public @Nullable java.lang.Boolean isReadOnly()

Description copied from interface: Field

Checks if the field should be rendered read only.

Specified by:

isReadOnly in interface Field

Returns:

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

getReadOnlyIfPresent

public java.lang.Boolean getReadOnlyIfPresent()

isRequired

@Nullable
public @Nullable java.lang.Boolean isRequired()

Description copied from interface: BaseConstraint

Returns true if field is required, otherwise false.

Specified by:

isRequired in interface BaseConstraint

Returns:

true if field is required, otherwise false

getRequiredIfPresent

public java.lang.Boolean getRequiredIfPresent()

getDefault

public java.lang.Object[] getDefault()

Description copied from interface: Field

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.

Specified by:

getDefault in interface Field

Returns:

default value of the field

getPlaceHolder

@Nullable
public @Nullable java.lang.String getPlaceHolder()

Description copied from interface: Field

The placeholder to show on the field.

Specified by:

getPlaceHolder in interface Field

Returns:

placeholder to show on the field

getDisplayFormat

@Nullable
public @Nullable java.lang.String getDisplayFormat()

Description copied from interface: Field

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.

Specified by:

getDisplayFormat in interface Field

Returns:

display format of the field

getEditFormat

@Nullable
public @Nullable java.lang.String getEditFormat()

Description copied from interface: Field

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.

Specified by:

getEditFormat in interface Field

Returns:

edit format of the field

getDisplayValueExpression

@Nullable
public @Nullable java.lang.String getDisplayValueExpression()

Description copied from interface: Field

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

Specified by:

getDisplayValueExpression in interface Field

Returns:

display value expression of the field

getDataFormat

@Nullable
public @Nullable java.lang.String getDataFormat()

Description copied from interface: Field

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

Specified by:

getDataFormat in interface Field

Returns:

data format of the field