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

Interface EnumSwitchField<F extends EnumSwitchField<F>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultEnumSwitchField

public interface EnumSwitchField<F extends EnumSwitchField<F>>
extends Field<F>

Defines a type of field use to display enumerated values in a boolean-like toggle switch component. However, unlike boolean, there can be as many switch values as enumerated values. Generally, SelectField is preferred as it presents a dropdown, but there may be special cases where a switch that shows all available values at once in a row is desired.

This component also automatically adds an empty value or "None" to display if the field is not required to allow nulling it out.

Since:

2.x.x

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EnumSwitchField.Attributes

Method Summary

Modifier and Type	Method	Description
default F	clearOptions()	Removes all the options from the select field.
default F	displaySingle()	Sets the EnumSwitchField.Attributes.DISPLAY_SINGLE attribute to true.
default F	displaySingle(boolean value)	Sets the EnumSwitchField.Attributes.DISPLAY_SINGLE attribute.
default F	notDisplaySingle()	Sets the EnumSwitchField.Attributes.DISPLAY_SINGLE attribute to false.
default F	option(SelectOption... options)	Provides options which can be selected by a select field.
default F	option(String value, String label)	Provides an option which can be selected by a select field.
default <O extends SelectOption> F	options(Collection<O> optionsToAdd)	Provides options which can be selected by a select field using a collection of SelectOptions.

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, findAttribute, findComponent, findComponent, findComponents, findEndpoint, 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, decorated, defaultValue, getDefaultValue, getName, getPlaceholder, getReadOnlyConditionals, getRequiredMessage, getValidationSchema, isReadOnly, isRequired, isShowInQueryBuilder, isTargetCollection, name, notReadOnly, notRequired, placeholder, placeholder, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, required, required, required, required, requiredMessage, requiredMessage, setDefaultValue, setName, setPlaceholder, setReadOnly, setReadOnlyConditionals, setRequired, setRequiredMessage, setShowInQueryBuilder, setValidationSchema, targetIsCollection, targetIsNotCollection, validationMethod, validationSchema, validationSchema

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

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

Method Details

displaySingle

default F displaySingle(boolean value)

Sets the EnumSwitchField.Attributes.DISPLAY_SINGLE attribute.

Parameters:

value - the value to set

Returns:

this

displaySingle

default F displaySingle()

Sets the EnumSwitchField.Attributes.DISPLAY_SINGLE attribute to true.

Returns:

this

notDisplaySingle

default F notDisplaySingle()

Sets the EnumSwitchField.Attributes.DISPLAY_SINGLE attribute to false.

Returns:

this

option

default F option(String value,
 String label)

Provides an option which can be selected by a select field.

Parameters:

value - the value of the option

label - the label of the option

Returns:

this

option

default F option(SelectOption... options)

Provides options which can be selected by a select field.

Parameters:

options - SelectOptions to be set as options

Returns:

this

options

default <O extends SelectOption> F options(Collection<O> optionsToAdd)

Provides options which can be selected by a select field using a collection of SelectOptions.

Parameters:

optionsToAdd - A collection of SelectOptions

Returns:

this

clearOptions

default F clearOptions()

Removes all the options from the select field.

Returns:

this