Package io.jmix.ui.component.inputdialog

Class InputDialogAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.component.inputdialog.InputDialogAction

All Implemented Interfaces:

Action, Action.HasPrimaryState

public class InputDialogAction
extends AbstractAction

Action can be used in InputDialog. It can handle specific InputDialogAction.InputDialogActionPerformed event for managing opened dialog.

See Also:

• InputDialog
• Dialogs.InputDialogBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputDialogAction.InputDialogActionPerformed	Describes action performed event from InputDialogAction.

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.OperationResultAction, Action.ScreenAction<S extends Screen>, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	validationRequired

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, 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(Component component)	Invoked by owning component to execute the action.
boolean	isValidationRequired()
InputDialogAction	withCaption(String caption)	Set caption using fluent API method.
InputDialogAction	withDescription(String description)	Set description using fluent API method.
InputDialogAction	withHandler(Consumer<InputDialogAction.InputDialogActionPerformed> handler)	Set action performed event handler using fluent API method.
InputDialogAction	withIcon(Icons.Icon iconKey)	Sets icon from icons set to the action (e.g.
InputDialogAction	withIcon(String icon)	Set icon using fluent API method.
InputDialogAction	withPrimary(boolean primary)	Set whether this action is primary using fluent API method.
InputDialogAction	withShortcut(String shortcut)	Set shortcut using fluent API method.
InputDialogAction	withValidationRequired(boolean validationRequired)	Set to true if handler should be invoked after successful validation.

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setPrimary, setShortcut, setShortcutCombination, setVisible

Methods inherited from class java.lang.Object

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

Field Details

validationRequired

protected boolean validationRequired

Constructor Details

InputDialogAction

public InputDialogAction(String id)

Method Details

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Parameters:

component - invoking component

action

public static InputDialogAction action(String id)

Creates new instance of InputDialogAction.

Parameters:

id - action id

Returns:

input dialog action

withCaption

public InputDialogAction withCaption(@Nullable
 String caption)

Set caption using fluent API method.

Parameters:

caption - caption

Returns:

current instance of action

withDescription

public InputDialogAction withDescription(@Nullable
 String description)

Set description using fluent API method.

Parameters:

description - description

Returns:

current instance of action

withIcon

public InputDialogAction withIcon(@Nullable
 String icon)

Set icon using fluent API method.

Parameters:

icon - icon

Returns:

current instance of action

withIcon

public InputDialogAction withIcon(Icons.Icon iconKey)

Sets icon from icons set to the action (e.g. JmixIcon.DIALOG_OK).

Parameters:

iconKey - icon

Returns:

current instance of action

withShortcut

public InputDialogAction withShortcut(@Nullable
 String shortcut)

Set shortcut using fluent API method.

Parameters:

shortcut - shortcut

Returns:

current instance of action

withHandler

public InputDialogAction withHandler(Consumer<InputDialogAction.InputDialogActionPerformed> handler)

Set action performed event handler using fluent API method. Can be used instead of subclassing BaseAction class.

Parameters:

handler - action performed handler

Returns:

current instance of action

withPrimary

public InputDialogAction withPrimary(boolean primary)

Set whether this action is primary using fluent API method. Can be used instead of subclassing BaseAction class.

Parameters:

primary - primary

Returns:

current instance of 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

isValidationRequired

public boolean isValidationRequired()

Returns:

true if handler should be invoked after successful validation