io.jmix.ui.app.inputdialog

Class InputDialog

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.ui.app.inputdialog.InputDialog

All Implemented Interfaces:

FrameOwner

@UiDescriptor(value="inputdialog.xml")
 @UiController(value="inputDialog")
public class InputDialog
extends Screen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputDialog.InputDialogCloseEvent Event sent to a listener added using withCloseListener() method of the input dialog builder.
static class	InputDialog.InputDialogResult Describes result of handler that can be used with DialogActions in the input dialog.
static class	InputDialog.ValidationContext Describes input dialog validation context.

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen

Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected Actions	actions
protected HBoxLayout	actionsLayout
protected java.util.List<Action>	actionsList
protected DataComponents	dataComponents
protected io.jmix.core.metamodel.datatype.DatatypeRegistry	datatypeRegistry
protected DialogActions	dialogActions
protected EntityFieldCreationSupport	entityFieldCreationSupport
protected java.util.List<java.lang.String>	fieldIds
protected Form	form
protected Icons	icons
static CloseAction	INPUT_DIALOG_CANCEL_ACTION A CloseAction used when the user clicks "CANCEL" button.
static CloseAction	INPUT_DIALOG_NO_ACTION A CloseAction used when the user clicks "NO" button.
static CloseAction	INPUT_DIALOG_OK_ACTION A CloseAction used when the user clicks "OK" button and fields validation is successful.
static CloseAction	INPUT_DIALOG_YES_ACTION A CloseAction used when the user clicks "YES" button and fields validation is successful.
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata
protected java.util.List<InputParameter>	parameters
protected java.util.function.Consumer<InputDialog.InputDialogResult>	resultHandler
protected ScreenValidation	screenValidation
protected ThemeConstants	theme
protected UiComponents	uiComponents
protected UiProperties	uiProperties
protected java.util.function.Function<InputDialog.ValidationContext,ValidationErrors>	validator

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
InputDialog()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> listener) Adds a close listener to the input dialog.
protected DialogAction	createDialogAction(DialogAction.Type type, CloseAction closeAction)
protected Field	createEntityField(InputParameter parameter)
protected Field	createEnumField(InputParameter parameter)
protected Field	createField(InputParameter parameter)
protected void	fireCloseAndResultEvents(CloseAction closeAction)
java.util.List<Action>	getActions()
DialogActions	getDialogActions() Returns predefined dialog actions.
DialogWindow	getDialogWindow()
java.util.List<InputParameter>	getParameters()
java.util.function.Consumer<InputDialog.InputDialogResult>	getResultHandler()
java.util.function.Function<InputDialog.ValidationContext,ValidationErrors>	getValidator()
<T> T	getValue(java.lang.String parameterId) Returns value from parameter by its id.
java.util.Map<java.lang.String,java.lang.Object>	getValues() Returns values from parameters.
protected void	initActions(java.util.List<Action> actions)
protected void	initDialogActions()
protected void	initParameters()
boolean	isValid() Validates form components and conditions from custom validation supplier and show errors.
protected void	onAfterClose(Screen.AfterCloseEvent event)
protected void	onBeforeShow(Screen.BeforeShowEvent event)
void	setActions(InputDialogAction... actions) Sets dialog actions.
void	setDialogActions(DialogActions actions) Sets predefined dialog actions.
void	setParameter(InputParameter parameter) Add input parameter to the dialog.
void	setParameters(InputParameter... parameters) Sets input parameters.
void	setResultHandler(java.util.function.Consumer<InputDialog.InputDialogResult> resultHandler) Sets handler for dialog actions (e.g.
void	setValidator(java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator) Sets additional handler for field validation.

Methods inherited from class io.jmix.ui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, close, close, closeWithDefaultAction, fireEvent, getApplicationContext, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSameScreen, setApplicationContext, setExtensions, setId, setScreenData, setUiEventListeners, setWindow, show

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_DIALOG_OK_ACTION

public static final CloseAction INPUT_DIALOG_OK_ACTION

A CloseAction used when the user clicks "OK" button and fields validation is successful.

INPUT_DIALOG_CANCEL_ACTION

public static final CloseAction INPUT_DIALOG_CANCEL_ACTION

A CloseAction used when the user clicks "CANCEL" button.

INPUT_DIALOG_YES_ACTION

public static final CloseAction INPUT_DIALOG_YES_ACTION

A CloseAction used when the user clicks "YES" button and fields validation is successful.

INPUT_DIALOG_NO_ACTION

public static final CloseAction INPUT_DIALOG_NO_ACTION

A CloseAction used when the user clicks "NO" button.

uiComponents

@Autowired
protected UiComponents uiComponents

datatypeRegistry

@Autowired
protected io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry

metadata

@Autowired
protected io.jmix.core.Metadata metadata

actions

@Autowired
protected Actions actions

messages

@Autowired
protected io.jmix.core.Messages messages

icons

@Autowired
protected Icons icons

screenValidation

@Autowired
protected ScreenValidation screenValidation

theme

@Autowired
protected ThemeConstants theme

uiProperties

@Autowired
protected UiProperties uiProperties

entityFieldCreationSupport

@Autowired
protected EntityFieldCreationSupport entityFieldCreationSupport

dataComponents

@Autowired
protected DataComponents dataComponents

form

@Autowired
protected Form form

actionsLayout

@Autowired
protected HBoxLayout actionsLayout

parameters

protected java.util.List<InputParameter> parameters

actionsList

protected java.util.List<Action> actionsList

dialogActions

protected DialogActions dialogActions

fieldIds

protected java.util.List<java.lang.String> fieldIds

resultHandler

protected java.util.function.Consumer<InputDialog.InputDialogResult> resultHandler

validator

protected java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator

Constructor Detail

InputDialog

public InputDialog()

Method Detail

onBeforeShow

@Subscribe
protected void onBeforeShow(Screen.BeforeShowEvent event)

onAfterClose

@Subscribe
protected void onAfterClose(Screen.AfterCloseEvent event)

getValue

public <T> T getValue(java.lang.String parameterId)

Returns value from parameter by its id.

Parameters:

parameterId - parameter id

Returns:

parameter value

Throws:

java.lang.IllegalArgumentException - exception if wrong parameter id is sent

getDialogWindow

public DialogWindow getDialogWindow()

Returns:

dialog window in which you can set dialog properties (e.g. modal, resizable, etc)

getValues

public java.util.Map<java.lang.String,java.lang.Object> getValues()

Returns values from parameters. String - parameter id, Object - parameter value.

Returns:

values

setParameter

public void setParameter(InputParameter parameter)

Add input parameter to the dialog. Input parameter will be represented as a field.

Parameters:

parameter - input parameter that will be added to the dialog

setParameters

public void setParameters(InputParameter... parameters)

Sets input parameters.

Parameters:

parameters - input parameters

getParameters

public java.util.List<InputParameter> getParameters()

Returns:

input parameters from dialog

addCloseListener

public io.jmix.core.common.event.Subscription addCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> listener)

Adds a close listener to the input dialog.

Parameters:

listener - close listener to add

Returns:

subscription

setActions

public void setActions(InputDialogAction... actions)

Sets dialog actions. If there is no actions are set input dialog will use DialogActions.OK_CANCEL.

Parameters:

actions - actions

See Also:

InputDialogAction

getActions

public java.util.List<Action> getActions()

Returns:

actions list

setDialogActions

public void setDialogActions(DialogActions actions)

Sets predefined dialog actions. By default if there is no actions are input dialog will use DialogActions.OK_CANCEL.

Parameters:

actions - actions

getDialogActions

public DialogActions getDialogActions()

Returns predefined dialog actions. DialogActions.OK_CANCEL by default.

Returns:

dialog actions

setResultHandler

public void setResultHandler(java.util.function.Consumer<InputDialog.InputDialogResult> resultHandler)

Sets handler for dialog actions (e.g. OK, CANCEL, etc) that are used in the dialog. Handler is invoked after close event and can be used instead of addCloseListener(Consumer).

Note, it is worked only with setDialogActions(DialogActions). Custom actions are not handled.

Parameters:

resultHandler - result handler

getResultHandler

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

Returns:

result handler

isValid

public boolean isValid()

Validates form components and conditions from custom validation supplier and show errors.

Returns:

true if validation is successful

setValidator

public void setValidator(java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator)

Sets additional handler for field validation. It takes values map and must return ValidationErrors instance. Returned validation errors will be shown with another errors from fields.

Parameters:

validator - validator

getValidator

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

Returns:

additional field validator

initParameters

protected void initParameters()

createField

protected Field createField(InputParameter parameter)

createEntityField

protected Field createEntityField(InputParameter parameter)

createEnumField

protected Field createEnumField(InputParameter parameter)

initActions

protected void initActions(java.util.List<Action> actions)

initDialogActions

protected void initDialogActions()

createDialogAction

protected DialogAction createDialogAction(DialogAction.Type type,
                                          CloseAction closeAction)

fireCloseAndResultEvents

protected void fireCloseAndResultEvents(CloseAction closeAction)