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

Interface DerivedSelectField<F extends DerivedSelectField<F>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultDerivedSelectField

public interface DerivedSelectField<F extends DerivedSelectField<F>>
extends SelectField<F>

Represents the metadata for a FieldTypes.DERIVED_ENUM field component that is built as a derived version of a SelectField. This field is useful for managing a property whose selectable options are derived from the value of another property on the entity.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DerivedSelectField.Attributes

Method Summary

Modifier and Type	Method	Description
default F	source(String source)	The source property to derive the options from.

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, 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, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltip

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.fields.SelectField

clearOptions, getOptions, labelKey, multi, multi, notMulti, notSearchable, option, option, options, searchable, searchable, valueKey

Method Detail

source

default F source(String source)

The source property to derive the options from. The source property is expected to be an array of object values with a label and value property.

Note, if this is used in combination with SelectField.options(Collection), then the two option sets will be merged together.

Parameters:

source - the source property

Returns:

this