Package io.jmix.flowui.action.entitypicker

Class EntityOpenAction<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.valuepicker.PickerAction<EntityOpenAction<E>,EntityPickerComponent<E>,E>

io.jmix.flowui.action.entitypicker.EntityOpenAction<E>

All Implemented Interfaces:

ExecutableAction, ScreenOpeningAction, SecuredAction, TargetAction<EntityPickerComponent<E>>, Action

Direct Known Subclasses:

EntityOpenCompositionAction

@ActionType("entity_open")
public class EntityOpenAction<E>
extends PickerAction<EntityOpenAction<E>,EntityPickerComponent<E>,E>
implements ScreenOpeningAction

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<E>	afterCommitHandler
protected DialogWindowBuilders	dialogBuilders
static final String	ID
protected Messages	messages
protected Notifications	notifications
protected ActionScreenInitializer	screenInitializer
protected Function<E,E>	transformation

Fields inherited from class io.jmix.flowui.action.valuepicker.PickerAction

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
EntityOpenAction()
EntityOpenAction(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 screen class if it was set by ScreenOpeningAction.setScreenClass(Class) or in the screen XML, otherwise returns null.
String	getScreenId()	Returns the screen id if it was set by ScreenOpeningAction.setScreenId(String) or in the screen XML, otherwise returns null.
protected void	initAction()
protected boolean	isEmpty()
<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)
void	setDialogBuilders(DialogWindowBuilders dialogBuilders)
protected void	setFlowUiComponentProperties(FlowUiComponentProperties flowUiComponentProperties)
void	setMessages(Messages messages)
void	setNotifications(Notifications notifications)
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 screen class.
void	setScreenId(String screenId)	Sets the screen id.
void	setTarget(EntityPickerComponent<E> target)
void	setTransformation(Function<E,E> transformation)
EntityOpenAction<E>	withAfterCommitHandler(Consumer<E> afterCommitHandler)
EntityOpenAction<E>	withTransformation(Function<E,E> transformation)

Methods inherited from class io.jmix.flowui.action.valuepicker.PickerAction

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

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

isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, 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, 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

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

messages

protected Messages messages

notifications

protected Notifications notifications

dialogBuilders

protected DialogWindowBuilders dialogBuilders

screenInitializer

protected ActionScreenInitializer screenInitializer

afterCommitHandler

protected Consumer<E> afterCommitHandler

transformation

protected Function<E,E> transformation

Constructor Details

EntityOpenAction

public EntityOpenAction()

EntityOpenAction

public EntityOpenAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

initAction in class PickerAction<EntityOpenAction<E>,EntityPickerComponent<E>,E>

setDialogBuilders

@Autowired
public void setDialogBuilders(DialogWindowBuilders dialogBuilders)

setNotifications

@Autowired
public void setNotifications(Notifications notifications)

setMessages

@Autowired
public void setMessages(Messages messages)

setFlowUiComponentProperties

@Autowired
protected void setFlowUiComponentProperties(FlowUiComponentProperties flowUiComponentProperties)

setTarget

public void setTarget(@Nullable
 EntityPickerComponent<E> target)

Specified by:

setTarget in interface TargetAction<E>

Overrides:

setTarget in class PickerAction<EntityOpenAction<E>,EntityPickerComponent<E>,E>

setAfterCommitHandler

public void setAfterCommitHandler(Consumer<E> afterCommitHandler)

setTransformation

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

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()

Description copied from interface: ScreenOpeningAction

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

Specified by:

getScreenId in interface ScreenOpeningAction

setScreenId

public void setScreenId(@Nullable
 String screenId)

Description copied from interface: ScreenOpeningAction

Sets the screen id.

Specified by:

setScreenId in interface ScreenOpeningAction

Parameters:

screenId - the screen id to set

getScreenClass

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

Description copied from interface: ScreenOpeningAction

Returns the screen class if it was set by ScreenOpeningAction.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)

Description copied from interface: ScreenOpeningAction

Sets the screen class.

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

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

withAfterCommitHandler

public EntityOpenAction<E> withAfterCommitHandler(Consumer<E> afterCommitHandler)

withTransformation

public EntityOpenAction<E> withTransformation(Function<E,E> transformation)

isEmpty

protected boolean isEmpty()