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)

  • 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 action

    • 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 action

    • 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

    • autoFocus

      default A autoFocus(boolean autoFocus)
      Sets whether the modal should automatically focus on the first input field when opened. Default is true.
      Parameters:
      autoFocus - whether to autofocus
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • autoFocus

      default A autoFocus()
      Enables autofocus for the modal.
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • noAutoFocus

      default A noAutoFocus()
      Disables autofocus for the modal.
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • showCloseButtonInFooter

      default A showCloseButtonInFooter(boolean showCloseButtonInFooter)
      Sets whether to show a close button in the footer of the modal. Default is false.
      Parameters:
      showCloseButtonInFooter - whether to show the close button in the footer
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • showCloseButtonInFooter

      default A showCloseButtonInFooter()
      Enables the close button in the footer of the modal.
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • noCloseButtonInFooter

      default A noCloseButtonInFooter()
      Disables the close button in the footer of the modal.
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • closeButtonLabel

      default A closeButtonLabel(InternationalizedMessage closeButtonLabel)
      Sets the label for the close button in the footer of the modal. Default is "Close". Implies the close button is shown in the footer.
      Parameters:
      closeButtonLabel - the close button label
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • closeButtonLabel

      default A closeButtonLabel(String closeButtonLabelKey)
      Sets the label for the close button in the footer of the modal. Default is "Close".Implies the close button is shown in the footer.
      Parameters:
      closeButtonLabelKey - the close button label message key
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2

    • submitColor

      default A submitColor(String submitColor)
      Sets the color for the submit button within the modal form.

      Accepted values are primary, secondary, danger, and default. Default is primary.

      Parameters:
      submitColor - the submit color
      Returns:
      the action
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2
      See Also:

    • submitConfirmationMessage

      default A submitConfirmationMessage(InternationalizedMessage message)
      Sets a message to display to the before submitting the modal form.
      Parameters:
      message - a message to display to the before submitting the modal form.
      Returns:
      this
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2
      See Also:

    • submitConfirmationMessage

      default A submitConfirmationMessage(String messageKey)
      Sets a message key to display to the before submitting the modal form.
      Parameters:
      messageKey - a message key to display to the before submitting the modal form.
      Returns:
      this
      See Also:

    • removeSubmitConfirmationMessage

      default A removeSubmitConfirmationMessage()
      Removes the submit confirmation message.
      Returns:
      this
      Since:
      Metadata 2.0.8, Release Train 2.1.6, Metadata 2.0.8, Release Train 2.2.2
      See Also:

    • readOnSuccess

      default A readOnSuccess(boolean readOnSuccess)
      Whether a re-fetch should be executed after the modal form action is successfully executed. The read endpoint that is configured for the grid will be used to trigger this re-fetch.
      Parameters:
      readOnSuccess - Whether a re-fetch should be triggerred on modal form action success
      Returns:
      this
      Since:
      Metadata 2.0.8, Release Train 2.1.6, 2.2.2
      See Also:

    • readOnSuccess

      default A readOnSuccess()
      Convenience method that is the same as readOnSuccess(true).
      Returns:
      this
      Since:
      Metadata 2.0.8, Release Train 2.1.6, 2.2.2