Package ch.tocco.nice2.model.form.api.form2.builder

Interface ActionGroupBuilder

All Known Implementing Classes:
ActionGroupBuilderImpl
public interface ActionGroupBuilder
can be used to build ActionGroup

  • Method Details

    • addAction

      default ActionBuilder addAction(String id)
      add an action with default position
      Parameters:
      id - id of the action
      Returns:
      the builder of the newly created action

    • addAction

      ActionBuilder addAction(String id, @Nullable @Nullable String position)
      add an action
      Parameters:
      id - id of the action
      position - relative position of the action
      Returns:
      the builder of the newly created action

    • addAction

      ActionBuilder addAction(Action action)
      add an existing action
      Parameters:
      action - the action to be added
      Returns:
      the builder of the newly added action

    • setDefaultAction

      ActionBuilder setDefaultAction(String id)
      set the default action
      Parameters:
      id - id of the action
      Returns:
      the builder of the newly created action

    • addReport

      default ReportBuilder addReport(String id)
      add a report with default position
      Parameters:
      id - id of the report
      Returns:
      the builder of the newly created action

    • addReport

      ReportBuilder addReport(String id, @Nullable @Nullable String position)
      add a report
      Parameters:
      id - id of the report
      position - relative position of the report
      Returns:
      the builder of the newly created report

    • addReport

      ReportBuilder addReport(Report report)
      add a report
      Returns:
      the builder of the newly created report

    • addActionGroup

      default ActionGroupBuilder addActionGroup(String id, String label)
      add a action group with default position
      Parameters:
      id - id of the action group
      label - label of the action group
      Returns:
      the builder of the newly created action group

    • addActionGroup

      ActionGroupBuilder addActionGroup(String id, String label, @Nullable @Nullable String position)
      add an action group
      Parameters:
      id - id of the action group
      label - label of the action group
      position - relative position of the action group
      Returns:
      the builder of the newly created action group

    • addActionGroup

      ActionGroupBuilder addActionGroup(ActionGroup childActionGroup)
      add an existing action group
      Parameters:
      childActionGroup - actionGroup to be added
      Returns:
      the builder of the newly added action group

    • setDefaultAction

      ActionGroupBuilder setDefaultAction(Action action)
      Sets the default action on the action group.
      Parameters:
      action - the default action.
      Returns:
      the current builder (allows chaining)

    • setIcon

      ActionGroupBuilder setIcon(String icon)
      Sets the icon on the action group.
      Parameters:
      icon - icon of the action group.
      Returns:
      the current builder (allows chaining)

    • get

      ActionGroup get() throws ModelBuildException
      Returns the underlying action group.
      Returns:
      the action group.
      Throws:
      ModelBuildException - if the validation fails