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

Interface ModalFormAction<A extends ModalFormAction<A>>

All Superinterfaces:

Action<A>, Comparable<A>, ConditionalAction<A>, Copyable<A>, FormAction<A>, Serializable

All Known Subinterfaces:

AddAdjustmentModalFormAction<A>, CloneModalFormAction<A>, CreateModalFormAction<A>, EntityModalFormAction<A>, GenerateTemplateAction<A>, OrderableModalFormAction<A>, ResidentMapCreateAction<A>, RowModalFormAction<A>

All Known Implementing Classes:

DefaultAddAdjustmentModalFormAction, DefaultCloneModalFormAction, DefaultCreateModalFormAction, DefaultEntityModalFormAction, DefaultGenerateTemplateAction, DefaultModalFormAction, DefaultOrderableModalFormAction, DefaultResidentMapCreateAction, DefaultRowModalFormAction

public interface ModalFormAction<A extends ModalFormAction<A>>
extends FormAction<A>, ConditionalAction<A>

Represents the metadata for a modal form action.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ModalFormAction.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.FormAction

FormAction.Keys

Method Summary

Modifier and Type	Method	Description
default A	modalSize(String modalSize)	Sets the size for the modal dialog.
default A	submitLabel(InternationalizedMessage submitLabel)	Sets the label for the submit button within the modal form.
default A	submitLabel(String submitLabelKey)	Sets the label for the submit button within the modal form.

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

addComponent, addComponents, addEndpoint, addEndpoint, apply, attribute, clearEndpoints, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAttribute, getAttribute, getAttributes, getComponent, getComponent, getComponents, getComponentsList, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOperationType, getOrder, getPlacement, getScope, getType, hasAttribute, hasComponent, hasEndpoint, id, label, label, operationType, order, placement, removeAttribute, removeComponent, removeEndpoint, scope, self, setAttributes, setComponents, setEndpoints, setId, setLabel, setOperationType, setOrder, setPlacement, setScope, setType, type

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.ConditionalAction

conditional, conditional

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

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.FormAction

addExternal, addExternal, addField, addField, addField, addFormComponents, addGroup, addGroup, external, field, findExternal, findField, findGroup, getExternal, getField, getGroup, group, removeExternal, removeField, removeGroup

Method Details

submitLabel

default A submitLabel(InternationalizedMessage submitLabel)

Sets the label for the submit button within the modal form.

Parameters:

submitLabel - the submit label

Returns:

the actioon

submitLabel

default A submitLabel(String submitLabelKey)

Sets the label for the submit button within the modal form.

Parameters:

submitLabelKey - the submit label message key

Returns:

the actioon

modalSize

default A modalSize(String modalSize)

Sets the size for the modal dialog. Accepted values are sm, lg, and xl. lg is the default size for modals unless the form has a Query Builder or Rule Builder field, in which case the modal default size is xl.

Parameters:

modalSize - the modal size

Returns:

the action