Package io.jmix.ui.sys

Class DialogsImpl.InputDialogBuilderImpl

java.lang.Object

io.jmix.ui.sys.DialogsImpl.InputDialogBuilderImpl

All Implemented Interfaces:

Dialogs.DialogBuilder<Dialogs.InputDialogBuilder>, Dialogs.HasCaption<Dialogs.InputDialogBuilder>, Dialogs.HasSize<Dialogs.InputDialogBuilder>, Dialogs.InputDialogBuilder

Enclosing class:

DialogsImpl

public class DialogsImpl.InputDialogBuilderImpl
extends Object
implements Dialogs.InputDialogBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected InputDialog	inputDialog

Constructor Summary

Constructors

Constructor	Description
InputDialogBuilderImpl(FrameOwner owner)

Method Summary

Modifier and Type	Method	Description
InputDialog	build()	Builds the input dialog.
Collection<Action>	getActions()
String	getCaption()
DialogActions	getDialogActions()
float	getHeight()
SizeUnit	getHeightSizeUnit()
Collection<InputParameter>	getParameters()
Consumer<InputDialog.InputDialogResult>	getResultHandler()
Function<InputDialog.ValidationContext,ValidationErrors>	getValidator()
float	getWidth()
SizeUnit	getWidthSizeUnit()
InputDialog	show()	Shows the dialog.
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	withActions(InputDialogAction... actions)	Sets dialog actions.
Dialogs.InputDialogBuilder	withCaption(String caption)	Sets caption text.
Dialogs.InputDialogBuilder	withCloseListener(Consumer<InputDialog.InputDialogCloseEvent> listener)	Add close listener to the dialog.
Dialogs.InputDialogBuilder	withHeight(String height)	Sets dialog height.
Dialogs.InputDialogBuilder	withParameter(InputParameter parameter)	Adds input parameter to the dialog.
Dialogs.InputDialogBuilder	withParameters(InputParameter... parameters)	Sets input parameters.
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

Constructor Details

InputDialogBuilderImpl

public InputDialogBuilderImpl(FrameOwner owner)

Method Details

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)
                         .withCaption("User field")
                         .withRequired(true)
         )
         .show();
  

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")
                          .withCaption("Name field caption")
                          .withDefaultValue("default value"),
                  intParameter("countField")
                          .withCaption("Count field caption")
                          .withRequired(true))
          .show();
   

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

withCloseListener

public Dialogs.InputDialogBuilder withCloseListener(Consumer<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. InputDialogAction provides access to input dialog in InputDialogAction.InputDialogActionPerformed where it is possible to get values form the fields and implement logic to close dialog.

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

Example:

  dialogs.createInputDialog(this)
         .withCaption("Dialog caption")
         .withParameter(parameter("nameField").withCaption("Name"))
         .withActions(
                 action("okAction")
                         .withCaption("OK")
                         .withIcon(JmixIcon.DIALOG_OK)
                         .withHandler(event -> {
                             InputDialog inputDialog = event.getInputDialog();
                             String name = inputDialog.getValue("nameField");
                             // do logic
                             inputDialog.close(InputDialog.INPUT_DIALOG_OK_ACTION);
                         }),
                 action("cancelAction")
                         .withCaption("Cancel")
                         .withIcon(JmixIcon.DIALOG_CANCEL)
                         .withValidationRequired(false)
                         .withHandler(event -> {
                             InputDialog inputDialog = event.getInputDialog();
                             inputDialog.close(InputDialog.INPUT_DIALOG_CANCEL_ACTION);
                         }))
         .show();
 
 

Specified by:

withActions in interface Dialogs.InputDialogBuilder

Parameters:

actions - actions

Returns:

builder

See Also:

• InputDialogAction.action(String)

getActions

public Collection<Action> getActions()

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(Consumer). Example

  dialogs.createInputDialog(this)
         .withCaption("Dialog caption")
         .withParameter(parameter("nameField").withCaption("Name"))
         .withActions(DialogActions.OK_CANCEL, result -> {
             switch (result.getCloseActionType()) {
                 case OK:
                     String name = result.getValue("nameField");
                     // do logic
                     break;
                 case CANCEL:
                     // do logic
                     break;
             }
         })
         .show();
  

Specified by:

withActions in interface Dialogs.InputDialogBuilder

Parameters:

actions - dialog actions

resultHandler - result handler

Returns:

builder

getDialogActions

public DialogActions getDialogActions()

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").withCaption("Phone"),
                 stringParameter("addressField").withCaption("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();
         })
         .show();
  

Specified by:

withValidator in interface Dialogs.InputDialogBuilder

Parameters:

validator - validator

Returns:

builder

getValidator

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

withCaption

public Dialogs.InputDialogBuilder withCaption(String caption)

Description copied from interface: Dialogs.HasCaption

Sets caption text.

Specified by:

withCaption in interface Dialogs.HasCaption<Dialogs.InputDialogBuilder>

Parameters:

caption - caption text

Returns:

builder

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 float getWidth()

Specified by:

getWidth in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Returns:

dialog width value

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Specified by:

getWidthSizeUnit in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Returns:

dialog width unit

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 float getHeight()

Specified by:

getHeight in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Returns:

dialog height value

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Specified by:

getHeightSizeUnit in interface Dialogs.HasSize<Dialogs.InputDialogBuilder>

Returns:

dialog height unit

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface Dialogs.HasCaption<Dialogs.InputDialogBuilder>

Returns:

caption text

show

public InputDialog show()

Description copied from interface: Dialogs.InputDialogBuilder

Shows the dialog.

Specified by:

show in interface Dialogs.InputDialogBuilder

Returns:

opened input dialog

build

public InputDialog build()

Description copied from interface: Dialogs.InputDialogBuilder

Builds the input dialog.

Specified by:

build in interface Dialogs.InputDialogBuilder

Returns:

input dialog