Package com.broadleafcommerce.metadata.dsl.core

Class AbstractFormComponent<C extends AbstractFormComponent<C>>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractExternal, AbstractField, AbstractGroup

public abstract class AbstractFormComponent<C extends AbstractFormComponent<C>>
extends AbstractComponent<C>
implements FormComponent<C>

The abstract form component implementation.

Author:

Nick Crum (ncrum)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractFormComponent(FormComponent<?> component)
AbstractFormComponent(String classifier)
AbstractFormComponent(String classifier, String type)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
InternationalizedMessage	getDescription()	A description used for display purposes.
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
int	hashCode()
boolean	isHidden()	Whether or not this component is hidden within the form.
void	setDescription(InternationalizedMessage description)
void	setHelpText(ExplanatoryMessage helpText)
void	setHidden(boolean hidden)
void	setHint(InternationalizedMessage hint)
void	setTooltip(ExplanatoryMessage tooltip)

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, 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, 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.FormComponent

helpText, helpText, hidden, hidden, hint, hint, notHidden, tooltip, tooltip

Constructor Detail

AbstractFormComponent

public AbstractFormComponent(String classifier)

AbstractFormComponent

public AbstractFormComponent(String classifier,
                             String type)

AbstractFormComponent

public AbstractFormComponent(FormComponent<?> component)

Method Detail

isHidden

public boolean isHidden()

Description copied from interface: FormComponent

Whether or not this component is hidden within the form.

Specified by:

isHidden in interface FormComponent<C extends AbstractFormComponent<C>>

Returns:

whether or not hidden

getHelpText

public ExplanatoryMessage getHelpText()

Description copied from interface: FormComponent

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

Specified by:

getHelpText in interface FormComponent<C extends AbstractFormComponent<C>>

Returns:

the help text

getTooltip

public ExplanatoryMessage getTooltip()

Description copied from interface: FormComponent

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

Specified by:

getTooltip in interface FormComponent<C extends AbstractFormComponent<C>>

Returns:

the tooltip

getHint

public InternationalizedMessage getHint()

Description copied from interface: FormComponent

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

Specified by:

getHint in interface FormComponent<C extends AbstractFormComponent<C>>

Returns:

the hint

getDescription

public InternationalizedMessage getDescription()

Description copied from interface: Component

A description used for display purposes.

Specified by:

getDescription in interface Component<C extends AbstractFormComponent<C>>

Overrides:

getDescription in class AbstractComponent<C extends AbstractFormComponent<C>>

Returns:

the description

setHidden

public void setHidden(boolean hidden)

Specified by:

setHidden in interface FormComponent<C extends AbstractFormComponent<C>>

setHelpText

public void setHelpText(ExplanatoryMessage helpText)

Specified by:

setHelpText in interface FormComponent<C extends AbstractFormComponent<C>>

setTooltip

public void setTooltip(ExplanatoryMessage tooltip)

Specified by:

setTooltip in interface FormComponent<C extends AbstractFormComponent<C>>

setHint

public void setHint(InternationalizedMessage hint)

Specified by:

setHint in interface FormComponent<C extends AbstractFormComponent<C>>

setDescription

public void setDescription(InternationalizedMessage description)

Specified by:

setDescription in interface Component<C extends AbstractFormComponent<C>>

Overrides:

setDescription in class AbstractComponent<C extends AbstractFormComponent<C>>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractComponent<C extends AbstractFormComponent<C>>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractComponent<C extends AbstractFormComponent<C>>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractComponent<C extends AbstractFormComponent<C>>