io.jmix.ui.screen

Class ScreenValidation

java.lang.Object

io.jmix.ui.screen.ScreenValidation

@Component(value="ui_ScreenValidation")
public class ScreenValidation
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScreenValidation.SaveChangesDialogResult Callbacks holder for save changes dialog.
static class	ScreenValidation.UnsavedChangesDialogResult Callbacks holder for unsaved changes dialog.

Field Summary

Fields

Modifier and Type	Field and Description
protected Icons	icons
protected io.jmix.core.Messages	messages
protected UiScreenProperties	screenProperties
protected javax.validation.Validator	validator

Constructor Summary

Constructors

Constructor and Description
ScreenValidation()

Method Summary

Modifier and Type	Method and Description
protected void	focusProblemComponent(ValidationErrors errors)
ScreenValidation.SaveChangesDialogResult	showSaveConfirmationDialog(FrameOwner origin, CloseAction closeAction) Shows standard save confirmation dialog with Save, Discard and Cancel actions.
ScreenValidation.UnsavedChangesDialogResult	showUnsavedChangesDialog(FrameOwner origin, CloseAction closeAction) Shows standard unsaved changes dialog with Discard and Cancel actions.
void	showValidationErrors(FrameOwner origin, ValidationErrors errors) Show validation alert with passed errors and first problem UI component.
protected void	validate(Validatable validatable, ValidationErrors errors)
ValidationErrors	validateCrossFieldRules(FrameOwner origin, java.lang.Object item) Validate cross-field BeanValidation rules.
ValidationErrors	validateUiComponents(java.util.Collection<Component> components) Validates UI components by invoking their Validatable.validate().
ValidationErrors	validateUiComponents(ComponentContainer container) Validates UI components by invoking their Validatable.validate().

Methods inherited from class java.lang.Object

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

Field Detail

screenProperties

@Autowired
protected UiScreenProperties screenProperties

messages

@Autowired
protected io.jmix.core.Messages messages

icons

@Autowired
protected Icons icons

validator

@Autowired
protected javax.validation.Validator validator

Constructor Detail

ScreenValidation

public ScreenValidation()

Method Detail

validateUiComponents

public ValidationErrors validateUiComponents(java.util.Collection<Component> components)

Validates UI components by invoking their Validatable.validate().

Parameters:

components - components collection

Returns:

validation errors

validateUiComponents

public ValidationErrors validateUiComponents(ComponentContainer container)

Validates UI components by invoking their Validatable.validate().

Parameters:

container - components container

Returns:

validation errors

validate

protected void validate(Validatable validatable,
                        ValidationErrors errors)

showValidationErrors

public void showValidationErrors(FrameOwner origin,
                                 ValidationErrors errors)

Show validation alert with passed errors and first problem UI component.

Parameters:

origin - screen controller

errors - validation error

focusProblemComponent

protected void focusProblemComponent(ValidationErrors errors)

validateCrossFieldRules

public ValidationErrors validateCrossFieldRules(@Nullable
                                                FrameOwner origin,
                                                java.lang.Object item)

Validate cross-field BeanValidation rules.

Parameters:

origin - screen controller

item - item to validate

Returns:

validation errors

showUnsavedChangesDialog

public ScreenValidation.UnsavedChangesDialogResult showUnsavedChangesDialog(FrameOwner origin,
                                                                            CloseAction closeAction)

Shows standard unsaved changes dialog with Discard and Cancel actions.

Parameters:

origin - screen controller

closeAction - close action

Returns:

result

showSaveConfirmationDialog

public ScreenValidation.SaveChangesDialogResult showSaveConfirmationDialog(FrameOwner origin,
                                                                           CloseAction closeAction)

Shows standard save confirmation dialog with Save, Discard and Cancel actions.

Parameters:

origin - screen controller

closeAction - close action

Returns:

result