OrderableModalFormAction (Broadleaf Metadata Common 1.7.3-GA API)

All Superinterfaces:

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

All Known Implementing Classes:

DefaultOrderableModalFormAction
```
public interface OrderableModalFormAction<A extends OrderableModalFormAction<A>>
extends ModalFormAction<A>
```
Represents the metadata for the action used to re-order rows within an Orderable grid.
Must configure the fields OrderableModalFormAction.FieldNames.MOVE_TO_FRONT and OrderableModalFormAction.FieldNames.POSITION_AFTER_ID in order for this to pass validation and properly support the re-order behavior.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`OrderableModalFormAction.FieldDefaults`
`static class`	`OrderableModalFormAction.FieldHelp`
`static class`	`OrderableModalFormAction.FieldLabels`
`static class`	`OrderableModalFormAction.FieldNames`

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

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

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default A`	`addMoveToFront(Field<?> moveToFront)`	Adds the `OrderableModalFormAction.FieldNames.MOVE_TO_FRONT` field.
`default A`	`addPositionAfter(LookupField<?> positionAfter)`	Adds the `OrderableModalFormAction.FieldNames.POSITION_AFTER_ID` field.
`default A`	`moveToFront(UnaryOperator<Field<?>> fn)`	Provides the `OrderableModalFormAction.FieldNames.MOVE_TO_FRONT` `Field` within this action's form for configuration.
`default A`	`moveToFrontDefaults()`	Configures with the default `OrderableModalFormAction.FieldDefaults.moveToFront()` field.
`default A`	`positionAfter(UnaryOperator<LookupField<?>> fn)`	Provides the `OrderableModalFormAction.FieldNames.POSITION_AFTER_ID` `LookupField` within this action's form for configuration.

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

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.ModalFormAction
submitLabel, submitLabel

- Method Detail
  - addMoveToFront
```
default A addMoveToFront(Field<?> moveToFront)
```
    Adds the OrderableModalFormAction.FieldNames.MOVE_TO_FRONT field.
    
    Parameters:
    
    moveToFront - the field
    
    Returns:
    
    the action
  - moveToFrontDefaults
```
default A moveToFrontDefaults()
```
    Configures with the default OrderableModalFormAction.FieldDefaults.moveToFront() field.
    
    Returns:
    
    the action
  - moveToFront
```
default A moveToFront(UnaryOperator<Field<?>> fn)
```
    Provides the OrderableModalFormAction.FieldNames.MOVE_TO_FRONT Field within this action's form for configuration. If no such field exists, one will be created.
    
    Parameters:
    
    fn - a function that configures the field
    
    Returns:
    
    the action
  - addPositionAfter
```
default A addPositionAfter(LookupField<?> positionAfter)
```
    Adds the OrderableModalFormAction.FieldNames.POSITION_AFTER_ID field.
    
    Parameters:
    
    positionAfter - the field
    
    Returns:
    
    the action
  - positionAfter
```
default A positionAfter(UnaryOperator<LookupField<?>> fn)
```
    Provides the OrderableModalFormAction.FieldNames.POSITION_AFTER_ID LookupField within this action's form for configuration. If no such field exists, one will be created.
    
    Parameters:
    
    fn - a function that configures the lookup field
    
    Returns:
    
    the action