com.broadleafcommerce.metadata.dsl.core

Interface Field<F extends Field<F>>

All Superinterfaces:

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

All Known Subinterfaces:

CustomAttributesGridField<F>, DateField<F>, DerivedSelectField<F>, DerivedUrlField<F>, DynamicField<F>, FieldArrayBlockField<F>, FieldArrayField<F>, FieldArrayGridField<F>, FileInputField<F>, LookupField<F>, MoneyField<F>, PhoneField<F>, QueryBuilderField<F>, ResidentGridField<F>, ResidentMapField<F>, RuleBuilderField<F>, SelectField<F>

All Known Implementing Classes:

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

public interface Field<F extends Field<F>>
extends FormComponent<F>

Represents the metadata for a field component.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Field.Attributes

Method Summary

Modifier and Type	Method and Description
default F	decorated(boolean decorated) Set whether or not this field should be decorated with a label, help text, hint, and other elements.
default F	defaultValue(Object defaultValue)
Object	getDefaultValue()
String	getName()
InternationalizedMessage	getPlaceholder()
InternationalizedMessage	getRequiredMessage()
AbstractValidationSchema<?>	getValidationSchema()
boolean	isReadOnly()
boolean	isRequired()
boolean	isShowInQueryBuilder()
default F	name(String name)
default F	notReadOnly()
default F	notRequired()
default F	placeholder(InternationalizedMessage placeholder)
default F	placeholder(String placeholderKey)
default F	readOnly()
default F	readOnly(boolean readOnly)
default F	required()
default F	required(boolean required)
default F	required(InternationalizedMessage requiredMessage)
default F	required(String requiredMessageKey)
default F	requiredMessage(InternationalizedMessage requiredMessage)
default F	requiredMessage(String requiredMessageKey)
void	setDefaultValue(Object defaultValue)
void	setName(String name)
void	setPlaceholder(InternationalizedMessage placeholder)
void	setReadOnly(boolean readOnly)
void	setRequired(boolean required)
void	setRequiredMessage(InternationalizedMessage requiredMessage)
void	setShowInQueryBuilder(boolean showInQueryBuilder)
void	setValidationSchema(AbstractValidationSchema<?> validationSchema)
default F	validationMethod(ValidationMethod<?> validationMethod)
default F	validationSchema(AbstractValidationSchema<?> validationSchema)
default F	validationSchema(UnaryOperator<AbstractValidationSchema<?>> fn)

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

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 java.lang.Comparable

compareTo

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

copy

Method Detail

getName

@Nullable
String getName()

getDefaultValue

@Nullable
Object getDefaultValue()

isReadOnly

boolean isReadOnly()

isRequired

boolean isRequired()

isShowInQueryBuilder

boolean isShowInQueryBuilder()

getRequiredMessage

@Nullable
InternationalizedMessage getRequiredMessage()

getPlaceholder

@Nullable
InternationalizedMessage getPlaceholder()

getValidationSchema

@Nullable
AbstractValidationSchema<?> getValidationSchema()

setName

void setName(String name)

setDefaultValue

void setDefaultValue(Object defaultValue)

setReadOnly

void setReadOnly(boolean readOnly)

setRequired

void setRequired(boolean required)

setShowInQueryBuilder

void setShowInQueryBuilder(boolean showInQueryBuilder)

setRequiredMessage

void setRequiredMessage(InternationalizedMessage requiredMessage)

setPlaceholder

void setPlaceholder(InternationalizedMessage placeholder)

setValidationSchema

void setValidationSchema(AbstractValidationSchema<?> validationSchema)

name

default F name(String name)

defaultValue

default F defaultValue(Object defaultValue)

readOnly

default F readOnly()

notReadOnly

default F notReadOnly()

readOnly

default F readOnly(boolean readOnly)

required

default F required()

notRequired

default F notRequired()

required

default F required(boolean required)

required

default F required(String requiredMessageKey)

required

default F required(InternationalizedMessage requiredMessage)

requiredMessage

default F requiredMessage(InternationalizedMessage requiredMessage)

requiredMessage

default F requiredMessage(String requiredMessageKey)

placeholder

default F placeholder(InternationalizedMessage placeholder)

placeholder

default F placeholder(String placeholderKey)

validationSchema

default F validationSchema(AbstractValidationSchema<?> validationSchema)

validationSchema

default F validationSchema(UnaryOperator<AbstractValidationSchema<?>> fn)

validationMethod

default F validationMethod(ValidationMethod<?> validationMethod)

decorated

default F decorated(boolean decorated)

Set whether or not this field should be decorated with a label, help text, hint, and other elements.

Parameters:

decorated - whether or not decorated

Returns:

this field for further customization