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

Class AbstractBaseImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractContainerImpl, AbstractFieldImpl

public abstract class AbstractBaseImpl
extends AbstractFormComponentImpl
implements Base, BaseConstraint

Abstract class which can be used as base class for Base 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
AbstractBaseImpl()

Method Summary

Modifier and Type	Method	Description
@NotNull java.util.Map<ConstraintType,java.lang.String>	getConstraintMessages()	Returns map of constraint messages specific to each constraint (like required, minLength etc).
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getCustomLayoutProperties()
@Nullable java.lang.String	getDescription()	Returns the description of the field
java.lang.Boolean	getEnabledIfPresent()
@NotNull java.lang.String	getExportedType()
@Nullable java.lang.String	getHtmlScreenReaderText()	Returns the string to indicate the text to be read by screen readers.
Label	getLabel()	Returns label of the form field
java.lang.String	getLang()	Returns the language to use for formatting the field.
@Nullable java.lang.String	getScreenReaderText()	Returns json formula rule to indicate the text to be read by screen readers based on the AssistPriority configured.
@Nullable java.lang.String	getTooltip()	Returns the tool tip of the field
java.lang.String	getTooltipText()	Returns the text contained in the short description rich text string.
BaseConstraint.Type	getType()	Returns the data type of the form field.
@Nullable java.lang.String	getValidationExpression()	Returns an expression returning boolean value indicating whether the value in the field is valid or not
@Nullable java.lang.Boolean	isEnabled()	Returns true if form field should be enabled, otherwise false.
boolean	isTooltipVisible()	Returns true if tooltip should always be visible, otherwise false.

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.BaseConstraint

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

Constructor Detail

AbstractBaseImpl

public AbstractBaseImpl()

Method Detail

getLabel

public Label getLabel()

Returns label of the form field

Specified by:

getLabel in interface Base

Overrides:

getLabel in class AbstractFormComponentImpl

Returns:

label of the field

Since:

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

getTooltip

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

Description copied from interface: Base

Returns the tool tip of the field

Specified by:

getTooltip in interface Base

Returns:

the tool tip of the field

isTooltipVisible

public boolean isTooltipVisible()

Description copied from interface: Base

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

Specified by:

isTooltipVisible in interface Base

Returns:

true if tooltip should always be visible, otherwise false

getLang

public java.lang.String getLang()

Description copied from interface: Base

Returns the language to use for formatting the field.

Specified by:

getLang in interface Base

Returns:

returns the language to use for formatting the field.

getCustomLayoutProperties

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.Object> getCustomLayoutProperties()

Overrides:

getCustomLayoutProperties in class AbstractFormComponentImpl

getScreenReaderText

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

Description copied from interface: Base

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

Specified by:

getScreenReaderText in interface Base

Returns:

the screen reader text as json formula rule

getHtmlScreenReaderText

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

Description copied from interface: Base

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

Specified by:

getHtmlScreenReaderText in interface Base

Returns:

the screen reader text

getDescription

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

Returns the description of the field

Specified by:

getDescription in interface Base

Overrides:

getDescription in class AbstractFormComponentImpl

Returns:

the description of the field

Since:

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

isEnabled

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

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

Specified by:

isEnabled in interface Base

Returns:

true if form field should be enabled, otherwise false

Since:

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

getEnabledIfPresent

public java.lang.Boolean getEnabledIfPresent()

getTooltipText

public java.lang.String getTooltipText()

Returns the text contained in the short description rich text string.

getConstraintMessages

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

Description copied from interface: Base

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

Specified by:

getConstraintMessages in interface Base

Returns:

map of constraint messages specific to each constraint.

getExportedType

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

Specified by:

getExportedType in interface Base

Specified by:

getExportedType in interface Component

Specified by:

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

Overrides:

getExportedType in class AbstractComponentImpl

See Also:

ComponentExporter.getExportedType()

getType

public BaseConstraint.Type getType()

Description copied from interface: BaseConstraint

Returns the data type of the form field.

Specified by:

getType in interface BaseConstraint

Overrides:

getType in class AbstractFormComponentImpl

Returns:

the data type of the form field

getValidationExpression

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

Description copied from interface: BaseConstraint

Returns an expression returning boolean value indicating whether the value in the field is valid or not

Specified by:

getValidationExpression in interface BaseConstraint

Returns:

an expression