com.broadleafcommerce.metadata.dsl.core

Interface FormComponent<C extends FormComponent<C>>

All Superinterfaces:

Comparable<C>, Component<C>, Copyable<C>, Serializable

All Known Subinterfaces:

CollapsibleGroup<G>, ControlGroup<G>, CustomAttributesGridField<F>, DateField<F>, Dependent<D>, DerivedSelectField<F>, DerivedUrlField<F>, DynamicField<F>, ExportHistoryGridExternal<E>, External<E>, Field<F>, FieldArrayBlockField<F>, FieldArrayField<F>, FieldArrayGridField<F>, FileInputField<F>, GridExternal<E>, Group<G>, InlineGroup<G>, LinkExternal<E>, LinkGroup<G>, LookupField<F>, MoneyField<F>, PhoneField<F>, QueryBuilderField<F>, ResidentGridField<F>, ResidentMapField<F>, RuleBuilderField<F>, SelectField<F>, TreeExternal<E>

All Known Implementing Classes:

AbstractExternal, AbstractField, AbstractFormComponent, AbstractGroup, DefaultBasicGroup, DefaultCollapsibleGroup, DefaultControlGroup, DefaultCustomAttributesGridField, DefaultDateField, DefaultDerivedSelectField, DefaultDerivedUrlField, DefaultDynamicField, DefaultExportHistoryGridExternal, DefaultExternal, DefaultField, DefaultFieldArrayBlockField, DefaultFieldArrayGridField, DefaultFileInputField, DefaultGridExternal, DefaultGroup, DefaultInlineGroup, DefaultLinkExternal, DefaultLinkGroup, DefaultLookupField, DefaultMoneyField, DefaultPhoneField, DefaultQueryBuilderField, DefaultResidentGridField, DefaultResidentMapField, DefaultRuleBuilderField, DefaultSelectField, DefaultTreeExternal

public interface FormComponent<C extends FormComponent<C>>
extends Component<C>

Represents the metadata for a component that resides with a form.

Author:

Nick Crum (ncrum)

Method Summary

Modifier and Type	Method and Description
ExplanatoryMessage	getHelpText() Additional information that can be displayed from a clickable popup from a (?) icon displaying next to the component
InternationalizedMessage	getHint() Displays as text next to the field with information about how a user should fill it out.
ExplanatoryMessage	getTooltip() Displays when hovering over a field that gives additional information on what potential values can be or how the field should be filled out
default C	helpText(ExplanatoryMessage helpText)
default C	helpText(String helpText)
default C	hidden()
default C	hidden(boolean hidden)
default C	hint(InternationalizedMessage hint)
default C	hint(String hint)
boolean	isHidden() Whether or not this component is hidden within the form.
default C	notHidden()
void	setHelpText(ExplanatoryMessage helpText)
void	setHidden(boolean isHidden)
void	setHint(InternationalizedMessage hint)
void	setTooltip(ExplanatoryMessage tooltip)
default C	tooltip(ExplanatoryMessage tooltip)
default C	tooltip(String 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

isHidden

boolean isHidden()

Whether or not this component is hidden within the form.

Returns:

whether or not hidden

getHelpText

ExplanatoryMessage getHelpText()

Additional information that can be displayed from a clickable popup from a (?) icon displaying next to the component

This value is translatable and can be a key that maps into a message bundle

Returns:

the help text

getTooltip

ExplanatoryMessage getTooltip()

Displays when hovering over a field that gives additional information on what potential values can be or how the field should be filled out

This value is translatable and can be a key that maps into a message bundle

Returns:

the tooltip

getHint

InternationalizedMessage getHint()

Displays as text next to the field with information about how a user should fill it out. This is always visible when rendering the field

This value is translatable and can be a key that maps into a message bundle

Returns:

the hint

setHidden

void setHidden(boolean isHidden)

setHelpText

void setHelpText(ExplanatoryMessage helpText)

setTooltip

void setTooltip(ExplanatoryMessage tooltip)

setHint

void setHint(InternationalizedMessage hint)

hidden

default C hidden(boolean hidden)

hidden

default C hidden()

notHidden

default C notHidden()

helpText

default C helpText(String helpText)

helpText

default C helpText(ExplanatoryMessage helpText)

tooltip

default C tooltip(String tooltip)

tooltip

default C tooltip(ExplanatoryMessage tooltip)

hint

default C hint(String hint)

hint

default C hint(InternationalizedMessage hint)