Package io.jmix.flowui.impl

Class DialogsImpl.InputDialogBuilderImpl

java.lang.Object

io.jmix.flowui.impl.DialogsImpl.InputDialogBuilderImpl

All Implemented Interfaces:

Dialogs.DialogBuilder<Dialogs.InputDialogBuilder>, Dialogs.Draggable<Dialogs.InputDialogBuilder>, Dialogs.HasHeader<Dialogs.InputDialogBuilder>, Dialogs.HasPosition<Dialogs.InputDialogBuilder>, Dialogs.HasSize<Dialogs.InputDialogBuilder>, Dialogs.InputDialogBuilder

Enclosing class:

DialogsImpl

public class DialogsImpl.InputDialogBuilderImpl
extends Object
implements Dialogs.InputDialogBuilder

Implementation of the Dialogs.InputDialogBuilder interface designed to facilitate the creation and customization of InputDialog components. This class provides methods to configure dialog properties such as dimensions, position, input parameters, actions, and other features.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.Dialogs.InputDialogBuilder

Dialogs.InputDialogBuilder.LabelsPosition

Field Summary

Fields

Modifier and Type	Field	Description
protected DialogWindow<InputDialog>	dialogBuild
protected InputDialog	inputDialog

Constructor Summary

Constructors

Constructor	Description
InputDialogBuilderImpl(View<?> origin)

Method Summary

Modifier and Type	Method	Description
DialogWindow<InputDialog>	build()	Builds the input dialog.
Collection<Action>	getActions()	Returns the collection of Action objects associated with the InputDialog.
DialogActions	getDialogActions()	Returns the predefined dialog actions associated with the input dialog.
String	getHeader()
String	getHeight()
Dialogs.InputDialogBuilder.LabelsPosition	getLabelsPosition()	Returns the position of labels for components in the InputDialog.
String	getLeft()	Gets the left position of the dialog.
Collection<InputParameter>	getParameters()	Returns the collection of InputParameter objects associated with the InputDialog.
List<com.vaadin.flow.component.formlayout.FormLayout.ResponsiveStep>	getResponsiveSteps()	Returns a list of responsive steps used in the FormLayout of the InputDialog.
Consumer<InputDialog.InputDialogResult>	getResultHandler()
String	getTop()	Gets the top position of the dialog.
Function<InputDialog.ValidationContext,ValidationErrors>	getValidator()	Returns the validator function associated with the input dialog.
String	getWidth()
boolean	isDraggable()
InputDialog	open()	Opens the dialog.
Dialogs.InputDialogBuilder	withActions(InputDialogAction... actions)	Sets dialog actions.
Dialogs.InputDialogBuilder	withActions(DialogActions actions)	Sets predefined dialog actions.
Dialogs.InputDialogBuilder	withActions(DialogActions actions, Consumer<InputDialog.InputDialogResult> resultHandler)	Sets dialog actions and result handler.
Dialogs.InputDialogBuilder	withCloseListener(com.vaadin.flow.component.ComponentEventListener<InputDialog.InputDialogCloseEvent> listener)	Add close listener to the dialog.
Dialogs.InputDialogBuilder	withDraggable(boolean draggable)	Sets whether dialog is enabled to be dragged by the user or not.
Dialogs.InputDialogBuilder	withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)	Adds a listener that is called after user finishes dragging the dialog.
Dialogs.InputDialogBuilder	withHeader(String header)	Sets a header text.
Dialogs.InputDialogBuilder	withHeight(String height)	Sets dialog height.
Dialogs.InputDialogBuilder	withLabelsPosition(Dialogs.InputDialogBuilder.LabelsPosition labelsPosition)	Sets labels position for default responsive steps.
Dialogs.InputDialogBuilder	withLeft(String left)	Sets the distance of the dialog from the left of its container.
Dialogs.InputDialogBuilder	withParameter(InputParameter parameter)	Adds input parameter to the dialog.
Dialogs.InputDialogBuilder	withParameters(InputParameter... parameters)	Sets input parameters.
Dialogs.InputDialogBuilder	withResponsiveSteps(List<com.vaadin.flow.component.formlayout.FormLayout.ResponsiveStep> responsiveSteps)	Sets responsive steps.
Dialogs.InputDialogBuilder	withTop(String top)	Sets the top position of the dialog.
Dialogs.InputDialogBuilder	withValidator(Function<InputDialog.ValidationContext,ValidationErrors> validator)	Sets additional handler for field validation.
Dialogs.InputDialogBuilder	withWidth(String width)	Sets dialog width.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

inputDialog

protected InputDialog inputDialog

dialogBuild

protected DialogWindow<InputDialog> dialogBuild

Constructor Details

InputDialogBuilderImpl

public InputDialogBuilderImpl(View<?> origin)

Method Details

withHeader

public Dialogs.InputDialogBuilder withHeader(String header)

Description copied from interface: Dialogs.HasHeader

Sets a header text.

Specified by:

withHeader in interface Dialogs.HasHeader<Dialogs.InputDialogBuilder>

Parameters:

header - header text

Returns:

builder

getHeader

@Nullable
public String getHeader()

Specified by:

getHeader in interface Dialogs.HasHeader<Dialogs.InputDialogBuilder>

Returns:

header text

withWidth

public Dialogs.InputDialogBuilder withWidth(String width)

Description copied from interface: Dialogs.HasSize

Sets dialog width.

Specified by:

withWidth in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Parameters:

width - width

Returns:

builder

getWidth

public String getWidth()

Specified by:

getWidth in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Returns:

dialog width value

withHeight

public Dialogs.InputDialogBuilder withHeight(String height)

Description copied from interface: Dialogs.HasSize

Sets dialog height.

Specified by:

withHeight in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Parameters:

height - height

Returns:

builder

getHeight

public String getHeight()

Specified by:

getHeight in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Returns:

dialog height value

getLeft

public String getLeft()

Description copied from interface: Dialogs.HasPosition

Gets the left position of the dialog.

Specified by:

getLeft in interface Dialogs.HasPosition<Dialogs.InputDialogBuilder>

Returns:

the left position of the dialog

withLeft

public Dialogs.InputDialogBuilder withLeft(String left)

Description copied from interface: Dialogs.HasPosition

Sets the distance of the dialog from the left of its container. If a unitless number is provided, pixels are assumed.

Note that the dialog left edge may not be the same as the viewport left edge (e.g. the Lumo theme defines some spacing to prevent the dialog from stretching all the way to the left of the viewport).

Specified by:

withLeft in interface Dialogs.HasPosition<Dialogs.InputDialogBuilder>

Parameters:

left - the left position of the dialog

Returns:

builder

getTop

public String getTop()

Description copied from interface: Dialogs.HasPosition

Gets the top position of the dialog.

Specified by:

getTop in interface Dialogs.HasPosition<Dialogs.InputDialogBuilder>

Returns:

the top position of the dialog

withTop

public Dialogs.InputDialogBuilder withTop(String top)

Description copied from interface: Dialogs.HasPosition

Sets the top position of the dialog. If a unitless number is provided, pixels are assumed.

Note that the dialog top edge may not be the same as the viewport top edge (e.g. the Lumo theme defines some spacing to prevent the dialog from stretching all the way to the top of the viewport).

Specified by:

withTop in interface Dialogs.HasPosition<Dialogs.InputDialogBuilder>

Parameters:

top - the top position of the dialog

Returns:

builder

withDraggable

public Dialogs.InputDialogBuilder withDraggable(boolean draggable)

Description copied from interface: Dialogs.Draggable

Sets whether dialog is enabled to be dragged by the user or not.

Specified by:

withDraggable in interface Dialogs.Draggable<Dialogs.InputDialogBuilder>

Parameters:

draggable - true to enable dragging of the dialog, false otherwise

Returns:

builder

isDraggable

public boolean isDraggable()

Specified by:

isDraggable in interface Dialogs.Draggable<Dialogs.InputDialogBuilder>

Returns:

true if dragging is enabled, false otherwise

withDraggedListener

public Dialogs.InputDialogBuilder withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)

Description copied from interface: Dialogs.Draggable

Adds a listener that is called after user finishes dragging the dialog. It is called only if dragging is enabled.

Note: By default, the component will sync the top/left values after every dragging.

Specified by:

withDraggedListener in interface Dialogs.Draggable<Dialogs.InputDialogBuilder>

Parameters:

listener - the listener to add

Returns:

builder

See Also:

• Dialogs.Draggable.withDraggable(boolean)

withParameter

public Dialogs.InputDialogBuilder withParameter(InputParameter parameter)

Description copied from interface: Dialogs.InputDialogBuilder

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();
  

Specified by:

withParameter in interface Dialogs.InputDialogBuilder

Parameters:

parameter - input parameter that will be added to the dialog

Returns:

builder

See Also:

• InputParameter.entityParameter(String, Class)

withParameters

public Dialogs.InputDialogBuilder withParameters(InputParameter... parameters)

Description copied from interface: Dialogs.InputDialogBuilder

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();
   

Specified by:

withParameters in interface Dialogs.InputDialogBuilder

Parameters:

parameters - input parameters

Returns:

builder

See Also:

• InputParameter.stringParameter(String)
• InputParameter.intParameter(String)

getParameters

public Collection<InputParameter> getParameters()

Returns the collection of InputParameter objects associated with the InputDialog.

Returns:

a collection of InputParameter objects

withResponsiveSteps

public Dialogs.InputDialogBuilder withResponsiveSteps(List<com.vaadin.flow.component.formlayout.FormLayout.ResponsiveStep> responsiveSteps)

Description copied from interface: Dialogs.InputDialogBuilder

Sets responsive steps. Responsive steps used in describing the responsive layouting behavior of a FormLayout.

Specified by:

withResponsiveSteps in interface Dialogs.InputDialogBuilder

Parameters:

responsiveSteps - responsive steps

Returns:

builder

getResponsiveSteps

public List<com.vaadin.flow.component.formlayout.FormLayout.ResponsiveStep> getResponsiveSteps()

Returns a list of responsive steps used in the FormLayout of the InputDialog.

Returns:

a List of FormLayout.ResponsiveStep objects representing the responsive steps

withLabelsPosition

public Dialogs.InputDialogBuilder withLabelsPosition(Dialogs.InputDialogBuilder.LabelsPosition labelsPosition)

Description copied from interface: Dialogs.InputDialogBuilder

Sets labels position for default responsive steps.

Specified by:

withLabelsPosition in interface Dialogs.InputDialogBuilder

Parameters:

labelsPosition - position of labels

Returns:

builder

See Also:

• Dialogs.InputDialogBuilder.withResponsiveSteps(List)

getLabelsPosition

public Dialogs.InputDialogBuilder.LabelsPosition getLabelsPosition()

Returns the position of labels for components in the InputDialog.

Returns:

the Dialogs.InputDialogBuilder.LabelsPosition of the labels

withCloseListener

public Dialogs.InputDialogBuilder withCloseListener(com.vaadin.flow.component.ComponentEventListener<InputDialog.InputDialogCloseEvent> listener)

Description copied from interface: Dialogs.InputDialogBuilder

Add close listener to the dialog. See close actions for DialogActions in InputDialog.

Specified by:

withCloseListener in interface Dialogs.InputDialogBuilder

Parameters:

listener - close listener to add

Returns:

builder

withActions

public Dialogs.InputDialogBuilder withActions(InputDialogAction... actions)

Description copied from interface: Dialogs.InputDialogBuilder

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();
 
 

Specified by:

withActions in interface Dialogs.InputDialogBuilder

Parameters:

actions - actions

Returns:

builder

See Also:

• InputDialogAction.action(String)

getActions

public Collection<Action> getActions()

Returns the collection of Action objects associated with the InputDialog.

Returns:

a collection of Action objects

withActions

public Dialogs.InputDialogBuilder withActions(DialogActions actions)

Description copied from interface: Dialogs.InputDialogBuilder

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.

Specified by:

withActions in interface Dialogs.InputDialogBuilder

Parameters:

actions - actions

Returns:

builder

withActions

public Dialogs.InputDialogBuilder withActions(DialogActions actions,
 Consumer<InputDialog.InputDialogResult> resultHandler)

Description copied from interface: Dialogs.InputDialogBuilder

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 Dialogs.InputDialogBuilder.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();
  

Specified by:

withActions in interface Dialogs.InputDialogBuilder

Parameters:

actions - dialog actions

resultHandler - result handler

Returns:

builder

getDialogActions

public DialogActions getDialogActions()

Returns the predefined dialog actions associated with the input dialog. By default, this is DialogActions.OK_CANCEL.

Returns:

the predefined dialog actions

getResultHandler

@Nullable
public Consumer<InputDialog.InputDialogResult> getResultHandler()

withValidator

public Dialogs.InputDialogBuilder withValidator(Function<InputDialog.ValidationContext,ValidationErrors> validator)

Description copied from interface: Dialogs.InputDialogBuilder

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();
  

Specified by:

withValidator in interface Dialogs.InputDialogBuilder

Parameters:

validator - validator

Returns:

builder

getValidator

public Function<InputDialog.ValidationContext,ValidationErrors> getValidator()

Returns the validator function associated with the input dialog.

Returns:

the validator function associated with the input dialog

open

public InputDialog open()

Description copied from interface: Dialogs.InputDialogBuilder

Opens the dialog.

Specified by:

open in interface Dialogs.InputDialogBuilder

Returns:

opened input dialog

build

public DialogWindow<InputDialog> build()

Description copied from interface: Dialogs.InputDialogBuilder

Builds the input dialog.

Specified by:

build in interface Dialogs.InputDialogBuilder

Returns:

input dialog