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>

Type Parameters:

E - the type of entity being handled by this action

All Implemented Interfaces:

ExecutableAction, SecuredAction, TargetAction<EntityPickerComponent<E>>, ViewOpeningAction, Action, HasShortcutCombination

Direct Known Subclasses:

EntityOpenCompositionAction

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

Represents an action that allows opening a DetailView for the entity associated with an EntityPickerComponent.

Nested Class Summary

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

SecuredBaseAction.EnabledRule

Nested classes/interfaces inherited from interface io.jmix.flowui.action.ViewOpeningAction

ViewOpeningAction.QueryParametersProvider, ViewOpeningAction.RouteParametersProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<E>	afterSaveHandler
protected DialogWindows	dialogWindows
static final String	ID
protected Messages	messages
protected Notifications	notifications
protected Function<E,E>	transformation
protected ActionViewInitializer	viewInitializer

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

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
EntityOpenAction()
EntityOpenAction(String id)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
<V extends View<?>> Consumer<DialogWindow.AfterCloseEvent<V>>	getAfterCloseHandler()
OpenMode	getOpenMode()	Returns the view open mode if it was set by ViewOpeningAction.setOpenMode(OpenMode) or in the view XML, otherwise returns null.
ViewOpeningAction.QueryParametersProvider	getQueryParametersProvider()
ViewOpeningAction.RouteParametersProvider	getRouteParametersProvider()
Class<? extends View>	getViewClass()	Returns the view class if it was set by ViewOpeningAction.setViewClass(Class) or in the view XML, otherwise returns null.
<V extends View<?>> Consumer<V>	getViewConfigurer()
String	getViewId()	Returns the view id if it was set by ViewOpeningAction.setViewId(String) or in the view XML, otherwise returns null.
protected void	initAction()
protected boolean	isEmpty()
<V extends View<?>> void	setAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)	Sets the handler to be invoked when the detail view closes.
void	setAfterSaveHandler(Consumer<E> afterSaveHandler)	Sets a handler that will be executed after the entity is saved.
void	setDialogWindows(DialogWindows dialogWindows)
void	setMessages(Messages messages)
void	setNotifications(Notifications notifications)
void	setOpenMode(OpenMode openMode)	Sets the view open mode.
void	setQueryParametersProvider(ViewOpeningAction.QueryParametersProvider provider)	Sets query parameters provider that returns query parameters that should be used in the URL.
void	setRouteParametersProvider(ViewOpeningAction.RouteParametersProvider provider)	Sets route parameters provider that returns route parameters that should be used in the route template.
void	setTarget(EntityPickerComponent<E> target)
void	setTransformation(Function<E,E> transformation)	Sets a transformation function to be applied to the entity.
protected void	setUiComponentProperties(UiComponentProperties uiComponentProperties)
void	setViewClass(Class<? extends View> viewClass)	Sets the view class.
<V extends View<?>> void	setViewConfigurer(Consumer<V> viewConfigurer)	Sets the view configurer.
void	setViewId(String viewId)	Sets the view id.
EntityOpenAction<E>	withAfterSaveHandler(Consumer<E> afterSaveHandler)
EntityOpenAction<E>	withTransformation(Function<E,E> transformation)
EntityOpenAction<E>	withViewClass(Class<? extends View> viewClass)
<V extends View<?>> EntityOpenAction<E>	withViewConfigurer(Consumer<V> viewConfigurer)
EntityOpenAction<E>	withViewId(String viewId)

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

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, 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, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

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

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

messages

protected Messages messages

notifications

protected Notifications notifications

dialogWindows

protected DialogWindows dialogWindows

viewInitializer

protected ActionViewInitializer viewInitializer

afterSaveHandler

protected Consumer<E> afterSaveHandler

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>

setDialogWindows

@Autowired
public void setDialogWindows(DialogWindows dialogWindows)

setNotifications

@Autowired
public void setNotifications(Notifications notifications)

setMessages

@Autowired
public void setMessages(Messages messages)

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties uiComponentProperties)

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>

setAfterSaveHandler

public void setAfterSaveHandler(Consumer<E> afterSaveHandler)

Sets a handler that will be executed after the entity is saved.

Parameters:

afterSaveHandler - a Consumer that defines the action to be performed with the entity after it is saved

setTransformation

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

Sets a transformation function to be applied to the entity.

Parameters:

transformation - a Function that takes an entity as input and returns the transformed entity.

getOpenMode

@Nullable
public OpenMode getOpenMode()

Description copied from interface: ViewOpeningAction

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

Specified by:

getOpenMode in interface ViewOpeningAction

setOpenMode

public void setOpenMode(@Nullable
 OpenMode openMode)

Description copied from interface: ViewOpeningAction

Sets the view open mode.

Specified by:

setOpenMode in interface ViewOpeningAction

Parameters:

openMode - the open mode to set

getViewId

@Nullable
public String getViewId()

Description copied from interface: ViewOpeningAction

Returns the view id if it was set by ViewOpeningAction.setViewId(String) or in the view XML, otherwise returns null.

Specified by:

getViewId in interface ViewOpeningAction

setViewId

public void setViewId(@Nullable
 String viewId)

Description copied from interface: ViewOpeningAction

Sets the view id.

Specified by:

setViewId in interface ViewOpeningAction

Parameters:

viewId - the view id to set

getViewClass

@Nullable
public Class<? extends View> getViewClass()

Description copied from interface: ViewOpeningAction

Returns the view class if it was set by ViewOpeningAction.setViewClass(Class) or in the view XML, otherwise returns null.

Specified by:

getViewClass in interface ViewOpeningAction

setViewClass

public void setViewClass(@Nullable
 Class<? extends View> viewClass)

Description copied from interface: ViewOpeningAction

Sets the view class.

Specified by:

setViewClass in interface ViewOpeningAction

Parameters:

viewClass - the view class to set

getRouteParametersProvider

@Nullable
public ViewOpeningAction.RouteParametersProvider getRouteParametersProvider()

Specified by:

getRouteParametersProvider in interface ViewOpeningAction

Returns:

route parameters or null if not set

setRouteParametersProvider

public void setRouteParametersProvider(@Nullable
 ViewOpeningAction.RouteParametersProvider provider)

Description copied from interface: ViewOpeningAction

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

Note that route parameters provider is set if the detail is opened in OpenMode.NAVIGATION.

Specified by:

setRouteParametersProvider in interface ViewOpeningAction

Parameters:

provider - route parameters provider to set

See Also:

• Route

getQueryParametersProvider

@Nullable
public ViewOpeningAction.QueryParametersProvider getQueryParametersProvider()

Specified by:

getQueryParametersProvider in interface ViewOpeningAction

Returns:

query parameters provider or null if not set

setQueryParametersProvider

public void setQueryParametersProvider(@Nullable
 ViewOpeningAction.QueryParametersProvider provider)

Description copied from interface: ViewOpeningAction

Sets query parameters provider that returns query parameters that should be used in the URL.

Note that query parameters provider is set if the detail is opened in OpenMode.NAVIGATION.

Specified by:

setQueryParametersProvider in interface ViewOpeningAction

Parameters:

provider - query parameters provider to set

setAfterCloseHandler

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

Description copied from interface: ViewOpeningAction

Sets the handler to be invoked when the detail view closes.

Note that handler is invoked if the detail 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.SAVE)) {
         System.out.println("Saved");
     }
 }
 

Specified by:

setAfterCloseHandler in interface ViewOpeningAction

Type Parameters:

V - view type

Parameters:

afterCloseHandler - handler to set

getAfterCloseHandler

public <V extends View<?>>
Consumer<DialogWindow.AfterCloseEvent<V>> getAfterCloseHandler()

Specified by:

getAfterCloseHandler in interface ViewOpeningAction

setViewConfigurer

public <V extends View<?>> void setViewConfigurer(@Nullable
 Consumer<V> viewConfigurer)

Description copied from interface: ViewOpeningAction

Sets the view configurer. Use the configurer if you need to provide parameters to the opened view through setters.

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

 @Install(to = "petsTable.view", subject = "viewConfigurer")
 protected void petsTableViewConfigurer(View<?> view) {
     view.setSomeParameter(someValue);
 }
 

Specified by:

setViewConfigurer in interface ViewOpeningAction

getViewConfigurer

public <V extends View<?>> Consumer<V> getViewConfigurer()

Specified by:

getViewConfigurer in interface ViewOpeningAction

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

withViewId

public EntityOpenAction<E> withViewId(@Nullable
 String viewId)

See Also:

• setViewId(String)

withViewClass

public EntityOpenAction<E> withViewClass(@Nullable
 Class<? extends View> viewClass)

See Also:

• setViewClass(Class)

withAfterSaveHandler

public EntityOpenAction<E> withAfterSaveHandler(Consumer<E> afterSaveHandler)

See Also:

• setAfterSaveHandler(Consumer)

withTransformation

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

See Also:

• setTransformation(Function)

withViewConfigurer

public <V extends View<?>> EntityOpenAction<E> withViewConfigurer(@Nullable
 Consumer<V> viewConfigurer)

See Also:

• setViewConfigurer(Consumer)

isEmpty

protected boolean isEmpty()