Package io.jmix.flowui

Interface Dialogs.InputDialogBuilder

All Superinterfaces:
Dialogs.DialogBuilder<Dialogs.InputDialogBuilder>, Dialogs.HasHeader<Dialogs.InputDialogBuilder>, Dialogs.HasSize<Dialogs.InputDialogBuilder>
All Known Implementing Classes:
DialogsImpl.InputDialogBuilderImpl
Enclosing interface:
Dialogs
public static interface Dialogs.InputDialogBuilder extends Dialogs.DialogBuilder<Dialogs.InputDialogBuilder>

  • Method Details

    • withParameter

      Dialogs.InputDialogBuilder withParameter(InputParameter parameter)
      Adds input parameter to the dialog. InputParameter describes field which will be used in the input dialog.
      Example: 
      
  dialogs.createInputDialog(this)
         .withParameter(
                 entityParameter("userField", User.class)
                         .withLabel("User field")
                         .withRequired(true)
         )
         .open();
      Parameters:
      parameter - input parameter that will be added to the dialog
      Returns:
      builder
      See Also:

    • withParameters

      Dialogs.InputDialogBuilder withParameters(InputParameter... parameters)
      Sets input parameters. InputParameter describes field which will be used in the input dialog.
      Example: 
      
  dialogs.createInputDialog(this)
          .withParameters(
                  stringParameter("nameField")
                          .withLabel("Name field label")
                          .withDefaultValue("Default value"),
                  intParameter("countField")
                          .withLabel("Count field label")
                          .withRequired(true))
          .open();
      Parameters:
      parameters - input parameters
      Returns:
      builder
      See Also:

    • withResponsiveSteps

      Dialogs.InputDialogBuilder withResponsiveSteps(List<com.vaadin.flow.component.formlayout.FormLayout.ResponsiveStep> responsiveSteps)
      Sets responsive steps. Responsive steps used in describing the responsive layouting behavior of a FormLayout.
      Parameters:
      responsiveSteps - responsive steps
      Returns:
      builder

    • withLabelsPosition

      Dialogs.InputDialogBuilder withLabelsPosition(Dialogs.InputDialogBuilder.LabelsPosition labelsPosition)
      Sets labels position for default responsive steps.
      Parameters:
      labelsPosition - position of labels
      Returns:
      builder
      See Also:

    • withCloseListener

      Dialogs.InputDialogBuilder withCloseListener(com.vaadin.flow.component.ComponentEventListener<InputDialog.InputDialogCloseEvent> listener)
      Add close listener to the dialog. See close actions for DialogActions in InputDialog.
      Parameters:
      listener - close listener to add
      Returns:
      builder

    • withActions

      Dialogs.InputDialogBuilder withActions(InputDialogAction... actions)
      Sets dialog actions.

      Note, if there is no actions are set input dialog will use DialogActions.OK_CANCEL by default.

      Example: 
      
  dialogs.createInputDialog(this)
         .withHeader("Dialog header")
         .withParameter(parameter("nameField").withLabel("Name"))
         .withActions(
                 action("okAction")
                         .withText("OK")
                         .withIcon(VaadinIcon.CHECK.create())
                         .withHandler(event -> {
                             InputDialogAction inputDialogAction = ((InputDialogAction) event.getSource());
                             InputDialog inputDialog = inputDialogAction.getInputDialog();

                             // do logic
                             inputDialog.close(InputDialog.INPUT_DIALOG_OK_ACTION);
                         }),
                 action("cancelAction")
                         .withText("Cancel")
                         .withIcon(VaadinIcon.BAN.create())
                         .withValidationRequired(false)
                         .withHandler(event -> {
                             // do logic
                         }))
         .open();
      Parameters:
      actions - actions
      Returns:
      builder
      See Also:

    • withActions

      Dialogs.InputDialogBuilder withActions(DialogActions actions)
      Sets predefined dialog actions. "OK" and "YES" actions always check fields validation before close the dialog. By default, if there is no actions are set input dialog will use DialogActions.OK_CANCEL.
      Parameters:
      actions - actions
      Returns:
      builder

    • withActions

      Dialogs.InputDialogBuilder withActions(DialogActions actions, Consumer<InputDialog.InputDialogResult> resultHandler)
      Sets dialog actions and result handler. "OK" and "YES" actions always check fields validation before close the dialog. Handler is invoked after close event and can be used instead of withCloseListener(ComponentEventListener). Example 
      
  dialogs.createInputDialog(this)
         .withHeader("Dialog header")
         .withParameter(parameter("nameField").withLabel("Name"))
         .withActions(DialogActions.OK_CANCEL, result -> {
             switch (result.getCloseActionType()) {
                 case OK -> {
                     // do logic
                 }
                 case CANCEL -> {
                     // do other logic
                 }
             }
         })
         .open();
      Parameters:
      actions - dialog actions
      resultHandler - result handler
      Returns:
      builder

    • withValidator

      Dialogs.InputDialogBuilder withValidator(Function<InputDialog.ValidationContext,ValidationErrors> validator)
      Sets additional handler for field validation. It receives input dialog context and must return ValidationErrors instance. Returned validation errors will be shown with another errors from fields. Example 
      
  dialogs.createInputDialog(this)
         .withParameters(
                 stringParameter("phoneField").withLabel("Phone"),
                 stringParameter("addressField").withLabel("Address"))
         .withValidator(context -> {
             String phone = context.getValue("phoneField");
             String address = context.getValue("addressField");

             if (Strings.isNullOrEmpty(phone) && Strings.isNullOrEmpty(address)) {
                 return ValidationErrors.of("Phone or Address should be filled");
             }
             return ValidationErrors.none();
         })
         .open();
      Parameters:
      validator - validator
      Returns:
      builder

    • open

      InputDialog open()
      Opens the dialog.
      Returns:
      opened input dialog

    • build

      DialogWindow<InputDialog> build()
      Builds the input dialog.
      Returns:
      input dialog