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

Interface ResidentMapField<F extends ResidentMapField<F>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultResidentMapField

public interface ResidentMapField<F extends ResidentMapField<F>>
extends Grid<F>, Field<F>

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ResidentMapField.ActionDefaults
static final class	ResidentMapField.ActionKeys
static final class	ResidentMapField.ActionPlacements
static final class	ResidentMapField.ActionTypes
static final class	ResidentMapField.Attributes

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

Grid.Keys

Method Summary

Modifier and Type	Method	Description
default F	addCreateAction(ResidentMapCreateAction<?> createAction)	Adds the ResidentMapField.ActionTypes.CREATE action.
default F	addDeleteAction(Action<?> deleteAction)	Adds the ResidentMapField.ActionTypes.DELETE action.
default F	addEntryAction(String type, Action<?> action)	Adds an ResidentMapField.ActionPlacements.ENTRY action.
default F	addMapAction(String type, Action<?> action)	Adds an ResidentMapField.ActionPlacements.MAP action.
default F	addUpdateAction(ModalFormAction<?> updateAction)	Adds the ResidentMapField.ActionTypes.UPDATE action.
default F	collapsedByDefault()	Sets the entries to be collapsed by default.
default F	createAction(UnaryOperator<ResidentMapCreateAction<?>> fn)	Selects the ResidentMapField.ActionTypes.CREATE action for functional customization.
default F	deleteAction(UnaryOperator<Action<?>> fn)	Selects the ResidentMapField.ActionTypes.DELETE action for functional customization.
default F	emptyMessage(String emptyMessageKey)	Sets the message that is displayed when no entries are defined.
default Optional<ResidentMapCreateAction<?>>	findCreateAction()	Finds the ResidentMapField.ActionTypes.CREATE action.
default Optional<Action<?>>	findDeleteAction()	Finds the ResidentMapField.ActionTypes.DELETE action.
default Optional<Action<?>>	findEntryAction(String type)	Finds the ResidentMapField.ActionPlacements.ENTRY action with the provided type.
default Optional<Action<?>>	findMapAction(String type)	Finds the ResidentMapField.ActionPlacements.MAP action with the provided type.
default Optional<ModalFormAction<?>>	findUpdateAction()	Finds the ResidentMapField.ActionTypes.UPDATE action.
default ResidentMapCreateAction<?>	getCreateAction()	Retrieves the ResidentMapField.ActionTypes.CREATE action.
default Action<?>	getDeleteAction()	Retrieves the ResidentMapField.ActionTypes.DELETE action.
default Action<?>	getEntryAction(String type)	Retrieves the ResidentMapField.ActionPlacements.ENTRY action with the provided type.
default Action<?>	getMapAction(String type)	Retrieves the ResidentMapField.ActionPlacements.MAP action with the provided type.
default ModalFormAction<?>	getUpdateAction()	Retrieves the ResidentMapField.ActionTypes.UPDATE action.
default F	notCollapsedByDefault()	Sets the entries to NOT be collapsed by default.
default F	updateAction(UnaryOperator<ModalFormAction<?>> fn)	Selects the ResidentMapField.ActionTypes.UPDATE action for functional customization.

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.Grid

addColumn, addColumn, addColumn, addColumns, findColumn, getColumn, idKey, removeColumn

Method Details

collapsedByDefault

default F collapsedByDefault()

Sets the entries to be collapsed by default.

Returns:

this

notCollapsedByDefault

default F notCollapsedByDefault()

Sets the entries to NOT be collapsed by default.

Returns:

this

emptyMessage

default F emptyMessage(String emptyMessageKey)

Sets the message that is displayed when no entries are defined.

Parameters:

emptyMessageKey - the empty message key

Returns:

this

addEntryAction

default F addEntryAction(String type,
 Action<?> action)

Adds an ResidentMapField.ActionPlacements.ENTRY action.

Parameters:

type - the type of the action

action - the action

Returns:

this

getEntryAction

default Action<?> getEntryAction(String type)

Retrieves the ResidentMapField.ActionPlacements.ENTRY action with the provided type.

Parameters:

type - the action type

Returns:

the action, if it exists

findEntryAction

default Optional<Action<?>> findEntryAction(String type)

Finds the ResidentMapField.ActionPlacements.ENTRY action with the provided type.

Parameters:

type - the action type

Returns:

an optional with the action, or empty

addMapAction

default F addMapAction(String type,
 Action<?> action)

Adds an ResidentMapField.ActionPlacements.MAP action.

Parameters:

type - the type of the action

action - the action

Returns:

this

getMapAction

default Action<?> getMapAction(String type)

Retrieves the ResidentMapField.ActionPlacements.MAP action with the provided type.

Parameters:

type - the action type

Returns:

the action, if it exists

findMapAction

default Optional<Action<?>> findMapAction(String type)

Finds the ResidentMapField.ActionPlacements.MAP action with the provided type.

Parameters:

type - the action type

Returns:

an optional with the action, or empty

addCreateAction

default F addCreateAction(ResidentMapCreateAction<?> createAction)

Adds the ResidentMapField.ActionTypes.CREATE action.

Parameters:

createAction - the create action

Returns:

this

createAction

default F createAction(UnaryOperator<ResidentMapCreateAction<?>> fn)

Selects the ResidentMapField.ActionTypes.CREATE action for functional customization.

Parameters:

fn - the function to customize

Returns:

this

getCreateAction

default ResidentMapCreateAction<?> getCreateAction()

Retrieves the ResidentMapField.ActionTypes.CREATE action.

Returns:

the action, if it exists

findCreateAction

default Optional<ResidentMapCreateAction<?>> findCreateAction()

Finds the ResidentMapField.ActionTypes.CREATE action.

Returns:

an optional with the action, or empty

addDeleteAction

default F addDeleteAction(Action<?> deleteAction)

Adds the ResidentMapField.ActionTypes.DELETE action.

Parameters:

deleteAction - the delete action

Returns:

this

deleteAction

default F deleteAction(UnaryOperator<Action<?>> fn)

Selects the ResidentMapField.ActionTypes.DELETE action for functional customization.

Parameters:

fn - the function to customize

Returns:

this

getDeleteAction

default Action<?> getDeleteAction()

Retrieves the ResidentMapField.ActionTypes.DELETE action.

Returns:

the action, if it exists

findDeleteAction

default Optional<Action<?>> findDeleteAction()

Finds the ResidentMapField.ActionTypes.DELETE action.

Returns:

an optional with the action, or empty

addUpdateAction

default F addUpdateAction(ModalFormAction<?> updateAction)

Adds the ResidentMapField.ActionTypes.UPDATE action.

Parameters:

updateAction - the update action

Returns:

this

updateAction

default F updateAction(UnaryOperator<ModalFormAction<?>> fn)

Selects the ResidentMapField.ActionTypes.UPDATE action for functional customization.

Parameters:

fn - the function to customize

Returns:

this

getUpdateAction

default ModalFormAction<?> getUpdateAction()

Retrieves the ResidentMapField.ActionTypes.UPDATE action.

Returns:

the action, if it exists

findUpdateAction

default Optional<ModalFormAction<?>> findUpdateAction()

Finds the ResidentMapField.ActionTypes.UPDATE action.

Returns:

an optional with the action, or empty