Package com.broadleafcommerce.metadata.dsl.core.extension.fields

Class AbstractField<F extends AbstractField<F>>

java.lang.Object

com.broadleafcommerce.metadata.dsl.core.AbstractComponent<C>

com.broadleafcommerce.metadata.dsl.core.AbstractFormComponent<F>

com.broadleafcommerce.metadata.dsl.core.extension.fields.AbstractField<F>

All Implemented Interfaces:

Component<F>, Copyable<F>, Field<F>, FormComponent<F>, Serializable, Comparable<F>

Direct Known Subclasses:

DefaultCustomAttributesGridField, DefaultDateField, DefaultDerivedField, DefaultDerivedSelectField, DefaultDerivedUrlField, DefaultDynamicField, DefaultField, DefaultFieldArrayBlockField, DefaultFieldArrayGridField, DefaultFileInputField, DefaultIntegerField, DefaultLookupField, DefaultMoneyField, DefaultPhoneField, DefaultQueryBuilderField, DefaultResidentGridField, DefaultResidentMapField, DefaultRuleBuilderField, DefaultSelectField

public abstract class AbstractField<F extends AbstractField<F>>
extends AbstractFormComponent<F>
implements Field<F>

The abstract field component specification. Extension of AbstractFormComponent with additional properties for field components.

Author:

Nick Crum (ncrum)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Field

Field.Attributes

Constructor Summary

Constructors

Constructor	Description
AbstractField()
AbstractField(Field<?> component)
AbstractField(String type)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Object	getDefaultValue()
String	getName()
InternationalizedMessage	getPlaceholder()
List<Conditional<?>>	getReadOnlyConditionals()
InternationalizedMessage	getRequiredMessage()
AbstractValidationSchema<?>	getValidationSchema()
int	hashCode()
boolean	isReadOnly()
boolean	isRequired()
boolean	isShowInQueryBuilder()
void	setDefaultValue(Object defaultValue)
void	setName(String name)
void	setPlaceholder(InternationalizedMessage placeholder)
void	setReadOnly(boolean readOnly)
void	setReadOnlyConditionals(List<Conditional<?>> readOnlyConditionals)
void	setRequired(boolean required)
void	setRequiredMessage(InternationalizedMessage requiredMessage)
void	setShowInQueryBuilder(boolean showInQueryBuilder)
void	setValidationSchema(AbstractValidationSchema<?> validationSchema)

Methods inherited from class com.broadleafcommerce.metadata.dsl.core.AbstractFormComponent

getDescription, getHelpText, getHint, getTooltip, isHidden, setDescription, setHelpText, setHidden, setHint, setTooltip

Methods inherited from class com.broadleafcommerce.metadata.dsl.core.AbstractComponent

compareTo, getActions, getAttributes, getAugmentationKey, getClassifier, getComponents, getConditionals, getEndpoints, getId, getLabel, getOrder, getScope, getType, isTranslatable, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Field

clearReadOnlyConditionals, decorated, defaultValue, isTargetCollection, name, notReadOnly, notRequired, placeholder, placeholder, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, required, required, required, required, requiredMessage, requiredMessage, targetIsCollection, targetIsNotCollection, validationMethod, validationSchema, validationSchema

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.FormComponent

getHelpText, getHint, getTooltip, helpText, helpText, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltip

Constructor Details

AbstractField

public AbstractField()

AbstractField

public AbstractField(String type)

AbstractField

public AbstractField(Field<?> component)

Method Details

getName

public String getName()

Specified by:

getName in interface Field<F extends AbstractField<F>>

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface Field<F extends AbstractField<F>>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Field<F extends AbstractField<F>>

getReadOnlyConditionals

public List<Conditional<?>> getReadOnlyConditionals()

Specified by:

getReadOnlyConditionals in interface Field<F extends AbstractField<F>>

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Field<F extends AbstractField<F>>

isShowInQueryBuilder

public boolean isShowInQueryBuilder()

Specified by:

isShowInQueryBuilder in interface Field<F extends AbstractField<F>>

getRequiredMessage

public InternationalizedMessage getRequiredMessage()

Specified by:

getRequiredMessage in interface Field<F extends AbstractField<F>>

getPlaceholder

public InternationalizedMessage getPlaceholder()

Specified by:

getPlaceholder in interface Field<F extends AbstractField<F>>

getValidationSchema

public AbstractValidationSchema<?> getValidationSchema()

Specified by:

getValidationSchema in interface Field<F extends AbstractField<F>>

setName

public void setName(String name)

Specified by:

setName in interface Field<F extends AbstractField<F>>

setDefaultValue

public void setDefaultValue(Object defaultValue)

Specified by:

setDefaultValue in interface Field<F extends AbstractField<F>>

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface Field<F extends AbstractField<F>>

setReadOnlyConditionals

public void setReadOnlyConditionals(List<Conditional<?>> readOnlyConditionals)

Specified by:

setReadOnlyConditionals in interface Field<F extends AbstractField<F>>

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface Field<F extends AbstractField<F>>

setShowInQueryBuilder

public void setShowInQueryBuilder(boolean showInQueryBuilder)

Specified by:

setShowInQueryBuilder in interface Field<F extends AbstractField<F>>

setRequiredMessage

public void setRequiredMessage(InternationalizedMessage requiredMessage)

Specified by:

setRequiredMessage in interface Field<F extends AbstractField<F>>

setPlaceholder

public void setPlaceholder(InternationalizedMessage placeholder)

Specified by:

setPlaceholder in interface Field<F extends AbstractField<F>>

setValidationSchema

public void setValidationSchema(AbstractValidationSchema<?> validationSchema)

Specified by:

setValidationSchema in interface Field<F extends AbstractField<F>>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractFormComponent<F extends AbstractField<F>>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractFormComponent<F extends AbstractField<F>>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractFormComponent<F extends AbstractField<F>>