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

Interface Form<F extends Form<F>>

All Superinterfaces:

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

All Known Subinterfaces:

BasicGroup<G>, CollapsibleGroup<G>, ControlGroup<G>, CreateModalFormView<V>, EntityFormView<V>, ExternalFieldGroup<G>, FormView<V>, Group<G>, InlineGroup<G>, InterdependentExternalGridsGroup<G>, LinkGroup<G>, ModalLinkColumn<C>, ModalView<V>, SelectTargetEntityFormView<V>, UpdateModalFormView<V>

All Known Implementing Classes:

AbstractGroup, AbstractSelectTargetEntityFormView, DefaultBasicGroup, DefaultCollapsibleGroup, DefaultControlGroup, DefaultCreateModalFormView, DefaultEntityFormView, DefaultExternalFieldGroup, DefaultFormView, DefaultGroup, DefaultInlineGroup, DefaultInterdependentExternalGridsGroup, DefaultLinkGroup, DefaultModalLinkColumn, DefaultModalView, DefaultUpdateModalFormView

public interface Form<F extends Form<F>>
extends Component<F>

A form represents components used to collect user input. Its children are various FormComponents.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Form.Keys

Method Summary

Modifier and Type	Method	Description
default F	addExternal(External<?> external)
default F	addExternal(String id, External<?> external)
default F	addField(Field<?> field)
default F	addField(String name)
default F	addField(String name, Field<?> field)
default F	addFields(Collection<Field<?>> fields)
default F	addFormComponents(Collection<FormComponent<?>> formComponents)
default F	addGroup(Group<?> group)
default F	addGroup(String id, Group<?> group)
default F	addMessage(Message<?> message)
default F	addMessage(String id, Message<?> message)
default F	external(String id, UnaryOperator<External<?>> fn)
default F	field(String name, UnaryOperator<Field<?>> fn)	Selects or creates a field with the given name and provides it as an argument to the function for further customization.
default Optional<External<?>>	findExternal(String id)
default Optional<Field<?>>	findField(String name)
default Optional<Group<?>>	findGroup(String id)
default Optional<Message<?>>	findMessage(String id)
default External<?>	getExternal(String id)
default Field<?>	getField(String name)
default Group<?>	getGroup(String id)
default Message<?>	getMessage(String id)
default F	group(String id, UnaryOperator<Group<?>> fn)
default F	message(String id, UnaryOperator<Message<?>> fn)
default F	removeExternal(String id)
default F	removeField(String name)	Removes a field with the given name.
default F	removeGroup(String id)
default F	removeMessage(String id)

Methods inherited from interface java.lang.Comparable

compareTo

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

addAction, addAction, addComponent, addEndpoint, addEndpoint, addSimpleComponent, apply, attribute, augmentable, 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, getAugmentableFlag, 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, setAugmentable, 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

Method Details

addFormComponents

default F addFormComponents(Collection<FormComponent<?>> formComponents)

addField

default F addField(String name,
 Field<?> field)

addField

default F addField(Field<?> field)

addField

default F addField(String name)

addFields

default F addFields(Collection<Field<?>> fields)

removeField

default F removeField(String name)

Removes a field with the given name.

Parameters:

name - the name of the field

Returns:

this

field

default F field(String name,
 UnaryOperator<Field<?>> fn)

Selects or creates a field with the given name and provides it as an argument to the function for further customization.

Parameters:

name - the name of the field

fn - the customize function

Returns:

this

findField

default Optional<Field<?>> findField(String name)

getField

default Field<?> getField(String name)

addExternal

default F addExternal(String id,
 External<?> external)

addExternal

default F addExternal(External<?> external)

removeExternal

default F removeExternal(String id)

external

default F external(String id,
 UnaryOperator<External<?>> fn)

findExternal

default Optional<External<?>> findExternal(String id)

getExternal

default External<?> getExternal(String id)

addGroup

default F addGroup(String id,
 Group<?> group)

addGroup

default F addGroup(Group<?> group)

removeGroup

default F removeGroup(String id)

group

default F group(String id,
 UnaryOperator<Group<?>> fn)

findGroup

default Optional<Group<?>> findGroup(String id)

getGroup

default Group<?> getGroup(String id)

addMessage

default F addMessage(String id,
 Message<?> message)

addMessage

default F addMessage(Message<?> message)

removeMessage

default F removeMessage(String id)

message

default F message(String id,
 UnaryOperator<Message<?>> fn)

findMessage

default Optional<Message<?>> findMessage(String id)

getMessage

default Message<?> getMessage(String id)