Package io.jmix.flowui.action.list

Class EditAction<E>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.list.ListDataComponentAction<A,E>

io.jmix.flowui.action.list.SecuredListDataComponentAction<EditAction<E>,E>

io.jmix.flowui.action.list.EditAction<E>

All Implemented Interfaces:

AdjustWhenScreenReadOnly, ExecutableAction, ScreenOpeningAction, SecuredAction, SecurityConstraintAction, TargetAction<ListDataComponent<E>>, Action

@ActionType("edit")
public class EditAction<E>
extends SecuredListDataComponentAction<EditAction<E>,E>
implements AdjustWhenScreenReadOnly, ScreenOpeningAction, ExecutableAction

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<E>	afterCommitHandler
protected DialogWindowBuilders	dialogWindowBuilders
static final String	ID
protected Messages	messages
protected OpenMode	openMode
protected ActionScreenInitializer	screenInitializer
protected ScreenNavigators	screenNavigators
protected boolean	textInitialized
protected Function<E,E>	transformation

Fields inherited from class io.jmix.flowui.action.list.SecuredListDataComponentAction

accessManager, applicationContext, constraintEntityOp, metadata

Fields inherited from class io.jmix.flowui.action.list.ListDataComponentAction

selectionListenerRegistration, target

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

enabledByUiPermissions, 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, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
EditAction()
EditAction(String id)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the action.
OpenMode	getOpenMode()	Returns the screen open mode if it was set by ScreenOpeningAction.setOpenMode(OpenMode) or in the screen XML, otherwise returns null.
com.vaadin.flow.router.QueryParameters	getQueryParameters()
com.vaadin.flow.router.RouteParameters	getRouteParameters()
Class<? extends Screen>	getScreenClass()	Returns the editor screen class if it was set by setScreenClass(Class) or in the screen XML.
String	getScreenId()	Returns the editor screen id if it was set by setScreenId(String) or in the screen XML.
protected void	initAction()
boolean	isDisabledWhenScreenReadOnly()
protected boolean	isPermitted()
protected void	navigateToScreen(E editedEntity)
protected void	openDialog(E editedEntity)
void	refreshState()
<S extends Screen<?>> void	setAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<S>> afterCloseHandler)	Sets the handler to be invoked when the editor screen closes.
void	setAfterCommitHandler(Consumer<E> afterCommitHandler)	Sets the handler to be invoked when the editor screen commits the entity.
void	setDialogWindowBuilders(DialogWindowBuilders dialogWindowBuilders)
protected void	setFlowUiComponentProperties(FlowUiComponentProperties flowUiComponentProperties)
protected void	setMessages(Messages messages)
void	setOpenMode(OpenMode openMode)	Sets the screen open mode.
void	setQueryParameters(com.vaadin.flow.router.QueryParameters queryParameters)	Sets query parameters that should be used in the URL.
void	setRouteParameters(com.vaadin.flow.router.RouteParameters routeParameters)	Sets route parameters that should be used in the route template.
void	setScreenClass(Class<? extends Screen> screenClass)	Sets the editor screen id.
void	setScreenId(String screenId)	Sets the editor screen id.
void	setScreenNavigators(ScreenNavigators screenNavigators)
void	setText(String text)
void	setTransformation(Function<E,E> transformation)	Sets the function to transform the committed in the editor screen entity before setting it to the target data container.
<S extends Screen<?>> EditAction<E>	withAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<S>> afterCloseHandler)
EditAction<E>	withAfterCommitHandler(Consumer<E> afterCommitHandler)
EditAction<E>	withOpenMode(OpenMode openMode)
EditAction<E>	withQueryParameters(com.vaadin.flow.router.QueryParameters queryParameters)
EditAction<E>	withRouteParameters(com.vaadin.flow.router.RouteParameters routeParameters)
EditAction<E>	withScreenClass(Class<? extends Screen> screenClass)
EditAction<E>	withScreenId(String screenId)
EditAction<E>	withTransformation(Function<E,E> transformation)

Methods inherited from class io.jmix.flowui.action.list.SecuredListDataComponentAction

getConstraintEntityOp, isApplicable, setAccessManager, setApplicationContext, setConstraintEntityOp, setMetadata, withConstraintEntityOp

Methods inherited from class io.jmix.flowui.action.list.ListDataComponentAction

actionPerform, attachSelectionListener, checkTarget, getTarget, onSelectionChange, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

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

isEnabledByUiPermissions, isVisibleByUiPermissions, setEnabledByUiPermissions, setVisibleByUiPermissions

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

addActionPerformedListener, setEnabled, setEnabledInternal, setVisible, setVisibleInternal

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

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, 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

actionPerform, addPropertyChangeListener, getDescription, getIcon, getId, getShortcutCombination, getText, getVariant, isEnabled, isVisible, setDescription, setEnabled, setIcon, setShortcutCombination, setVariant, setVisible

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

screenNavigators

protected ScreenNavigators screenNavigators

dialogWindowBuilders

protected DialogWindowBuilders dialogWindowBuilders

screenInitializer

protected ActionScreenInitializer screenInitializer

afterCommitHandler

protected Consumer<E> afterCommitHandler

transformation

protected Function<E,E> transformation

textInitialized

protected boolean textInitialized

messages

protected Messages messages

openMode

protected OpenMode openMode

Constructor Details

EditAction

public EditAction()

EditAction

public EditAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

initAction in class ListDataComponentAction<EditAction<E>,E>

getOpenMode

@Nullable
public OpenMode getOpenMode()

Description copied from interface: ScreenOpeningAction

Returns the screen open mode if it was set by ScreenOpeningAction.setOpenMode(OpenMode) or in the screen XML, otherwise returns null.

Specified by:

getOpenMode in interface ScreenOpeningAction

setOpenMode

public void setOpenMode(@Nullable
 OpenMode openMode)

Description copied from interface: ScreenOpeningAction

Sets the screen open mode.

Specified by:

setOpenMode in interface ScreenOpeningAction

Parameters:

openMode - the open mode to set

getScreenId

@Nullable
public String getScreenId()

Returns the editor screen id if it was set by setScreenId(String) or in the screen XML. Otherwise, returns null.

Specified by:

getScreenId in interface ScreenOpeningAction

setScreenId

public void setScreenId(@Nullable
 String screenId)

Sets the editor screen id.

Specified by:

setScreenId in interface ScreenOpeningAction

Parameters:

screenId - the screen id to set

getScreenClass

@Nullable
public Class<? extends Screen> getScreenClass()

Returns the editor screen class if it was set by setScreenClass(Class) or in the screen XML. Otherwise returns null.

Specified by:

getScreenClass in interface ScreenOpeningAction

setScreenClass

public void setScreenClass(@Nullable
 Class<? extends Screen> screenClass)

Sets the editor screen id.

Specified by:

setScreenClass in interface ScreenOpeningAction

Parameters:

screenClass - the screen class to set

getRouteParameters

@Nullable
public com.vaadin.flow.router.RouteParameters getRouteParameters()

Specified by:

getRouteParameters in interface ScreenOpeningAction

Returns:

route parameters or null if not set

setRouteParameters

public void setRouteParameters(@Nullable
 com.vaadin.flow.router.RouteParameters routeParameters)

Description copied from interface: ScreenOpeningAction

Sets route parameters that should be used in the route template.

Note that route parameters are set if the editor is opened in OpenMode.NAVIGATION.

Specified by:

setRouteParameters in interface ScreenOpeningAction

Parameters:

routeParameters - route parameters to set

See Also:

• Route

getQueryParameters

@Nullable
public com.vaadin.flow.router.QueryParameters getQueryParameters()

Specified by:

getQueryParameters in interface ScreenOpeningAction

Returns:

query parameters or null if not set

setQueryParameters

public void setQueryParameters(@Nullable
 com.vaadin.flow.router.QueryParameters queryParameters)

Description copied from interface: ScreenOpeningAction

Sets query parameters that should be used in the URL.

Note that query parameters are set if the editor is opened in OpenMode.NAVIGATION.

Specified by:

setQueryParameters in interface ScreenOpeningAction

Parameters:

queryParameters - query parameters to set

setAfterCloseHandler

public <S extends Screen<?>> void setAfterCloseHandler(@Nullable
 Consumer<DialogWindow.AfterCloseEvent<S>> afterCloseHandler)

Description copied from interface: ScreenOpeningAction

Sets the handler to be invoked when the editor screen closes.

Note that handler is invoked if the editor is opened in OpenMode.DIALOG mode.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petsTable.view", subject = "afterCloseHandler")
 protected void petsTableViewAfterCloseHandler(AfterCloseEvent event) {
     if (event.closedWith(StandardOutcome.COMMIT)) {
         System.out.println("Committed");
     }
 }
 

Specified by:

setAfterCloseHandler in interface ScreenOpeningAction

Type Parameters:

S - screen type

Parameters:

afterCloseHandler - handler to set

setAfterCommitHandler

public void setAfterCommitHandler(@Nullable
 Consumer<E> afterCommitHandler)

Sets the handler to be invoked when the editor screen commits the entity.

Note that handler is invoked if the editor is opened in OpenMode.DIALOG mode.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petsTable.edit", subject = "afterCommitHandler")
 protected void petsTableEditAfterCommitHandler(Pet entity) {
     System.out.println("Committed " + entity);
 }
 

setTransformation

public void setTransformation(@Nullable
 Function<E,E> transformation)

Sets the function to transform the committed in the editor screen entity before setting it to the target data container.

Note that transformation function is invoked if the editor is opened in OpenMode.DIALOG mode.

The preferred way to set the function is using a controller method annotated with Install, e.g.:

 @Install(to = "petsTable.edit", subject = "transformation")
 protected Pet petsTableEditTransformation(Pet entity) {
     return doTransform(entity);
 }
 

Parameters:

transformation - transformation function to set

setMessages

@Autowired
protected void setMessages(Messages messages)

setFlowUiComponentProperties

@Autowired
protected void setFlowUiComponentProperties(FlowUiComponentProperties flowUiComponentProperties)

setScreenNavigators

@Autowired
public void setScreenNavigators(ScreenNavigators screenNavigators)

setDialogWindowBuilders

@Autowired
public void setDialogWindowBuilders(DialogWindowBuilders dialogWindowBuilders)

setText

public void setText(@Nullable
 String text)

Specified by:

setText in interface Action

Overrides:

setText in class AbstractAction

isPermitted

protected boolean isPermitted()

Overrides:

isPermitted in class SecuredListDataComponentAction<EditAction<E>,E>

refreshState

public void refreshState()

Specified by:

refreshState in interface Action

Overrides:

refreshState in class SecuredBaseAction

isDisabledWhenScreenReadOnly

public boolean isDisabledWhenScreenReadOnly()

Specified by:

isDisabledWhenScreenReadOnly in interface AdjustWhenScreenReadOnly

Returns:

whether this action must be disabled when a screen in the read-only mode

execute

public void execute()

Executes the action.

Specified by:

execute in interface ExecutableAction

navigateToScreen

protected void navigateToScreen(E editedEntity)

openDialog

protected void openDialog(E editedEntity)

withScreenId

public EditAction<E> withScreenId(@Nullable
 String screenId)

See Also:

• setScreenId(String)

withScreenClass

public EditAction<E> withScreenClass(@Nullable
 Class<? extends Screen> screenClass)

See Also:

• setScreenClass(Class)

withRouteParameters

public EditAction<E> withRouteParameters(@Nullable
 com.vaadin.flow.router.RouteParameters routeParameters)

See Also:

• setRouteParameters(RouteParameters)

withQueryParameters

public EditAction<E> withQueryParameters(@Nullable
 com.vaadin.flow.router.QueryParameters queryParameters)

See Also:

• setQueryParameters(QueryParameters)

withOpenMode

public EditAction<E> withOpenMode(@Nullable
 OpenMode openMode)

See Also:

• setOpenMode(OpenMode)

withAfterCloseHandler

public <S extends Screen<?>> EditAction<E> withAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<S>> afterCloseHandler)

See Also:

• setAfterCloseHandler(Consumer)

withAfterCommitHandler

public EditAction<E> withAfterCommitHandler(@Nullable
 Consumer<E> afterCommitHandler)

See Also:

• setAfterCommitHandler(Consumer)

withTransformation

public EditAction<E> withTransformation(@Nullable
 Function<E,E> transformation)

See Also:

• setTransformation(Function)