Package io.jmix.flowui.action.inputdialog

Class InputDialogAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.view.ViewAction<InputDialogAction,InputDialog>

io.jmix.flowui.action.inputdialog.InputDialogAction

All Implemented Interfaces:

ExecutableAction, SecuredAction, TargetAction<InputDialog>, Action, HasShortcutCombination

public class InputDialogAction
extends ViewAction<InputDialogAction,InputDialog>

Action can be used in InputDialog.

See Also:

• InputDialog
• Dialogs.InputDialogBuilder

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.flow.component.Component	component
protected InputDialog	inputDialog
protected boolean	validationRequired

Fields inherited from class io.jmix.flowui.action.view.ViewAction

target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

enabledByUiPermissions, enabledRules, visibleByUiPermissions

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
InputDialogAction(String id)

Method Summary

Modifier and Type	Method	Description
static InputDialogAction	action(String id)	Creates new instance of InputDialogAction.
void	actionPerform(com.vaadin.flow.component.Component component)	Executes action logic.
void	execute()	Executes the Action
InputDialog	getInputDialog()
boolean	isValidationRequired()
void	setShortcutCombination(KeyCombination shortcutCombination)	Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.
InputDialogAction	withValidationRequired(boolean validationRequired)	Set to true if handler should be invoked after successful validation.

Methods inherited from class io.jmix.flowui.action.view.ViewAction

checkTarget, getTarget, initAction, isApplicable, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.action.SecuredBaseAction

addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setText, setVariant

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.kit.action.Action

addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination

Field Details

validationRequired

protected boolean validationRequired

inputDialog

protected InputDialog inputDialog

component

protected com.vaadin.flow.component.Component component

Constructor Details

InputDialogAction

public InputDialogAction(String id)

Method Details

getInputDialog

@Nullable
public InputDialog getInputDialog()

actionPerform

public void actionPerform(com.vaadin.flow.component.Component component)

Description copied from interface: Action

Executes action logic.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class ViewAction<InputDialogAction,InputDialog>

Parameters:

component - Component that triggered this action

action

public static InputDialogAction action(String id)

Creates new instance of InputDialogAction.

Parameters:

id - action id

Returns:

input dialog action

withValidationRequired

public InputDialogAction withValidationRequired(boolean validationRequired)

Set to true if handler should be invoked after successful validation. False - validation won't be preformed and handler will be invoked. Default value is true.

Parameters:

validationRequired - validation required option

Returns:

current instance of action

setShortcutCombination

public void setShortcutCombination(@Nullable
 KeyCombination shortcutCombination)

Description copied from interface: HasShortcutCombination

Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.

Specified by:

setShortcutCombination in interface HasShortcutCombination

Overrides:

setShortcutCombination in class AbstractAction

Parameters:

shortcutCombination - key combination to set or null to remove

isValidationRequired

public boolean isValidationRequired()

Returns:

true if handler should be invoked after successful validation

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action