Package io.jmix.flowui.action.entitypicker

Class EntityReadAction<E>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction<EntityReadAction<E>>

io.jmix.flowui.action.ObservableBaseAction<EntityReadAction<E>>

io.jmix.flowui.action.SecuredBaseAction<EntityReadAction<E>>

io.jmix.flowui.action.valuepicker.PickerAction<EntityReadAction<E>,EntityPickerComponent<E>,E>

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

Type Parameters:

E - entity type

All Implemented Interfaces:

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

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

Shows the entity set to an entity picker component in a read view.

The view is resolved as ReadAction resolves it: the view annotated with PrimaryReadView, otherwise the view with the <entity>.read id, otherwise the entity's detail view opened in the read-only mode. In contrast to EntityOpenAction the action never saves: it requires no UPDATE permission and stays enabled on a read-only view.

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 DialogWindows	dialogWindows
static final String	ID
protected Messages	messages
protected Notifications	notifications
protected ActionViewInitializer	viewInitializer

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

target

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

enabledRules

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

uiObservationSupport

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
<V extends View<?>> Consumer<DialogWindow.AfterCloseEvent<V>>	getAfterCloseHandler()
@Nullable OpenMode	getOpenMode()	Returns the view open mode if it was set by ViewOpeningAction.setOpenMode(OpenMode) or in the view XML, otherwise returns null.
@Nullable ViewOpeningAction.QueryParametersProvider	getQueryParametersProvider()
@Nullable ViewOpeningAction.RouteParametersProvider	getRouteParametersProvider()
@Nullable 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()
@Nullable String	getViewId()	Returns the view id if it was set by ViewOpeningAction.setViewId(String) or in the view XML, otherwise returns null.
protected boolean	isEmpty()
<V extends View<?>> void	setAfterCloseHandler(@Nullable Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)	Sets the handler to be invoked when the detail view closes.
void	setDialogWindows(DialogWindows dialogWindows)
protected void	setIcons(Icons icons)
void	setMessages(Messages messages)
void	setNotifications(Notifications notifications)
void	setOpenMode(@Nullable OpenMode openMode)	Sets the view open mode.
void	setQueryParametersProvider(@Nullable ViewOpeningAction.QueryParametersProvider provider)	Sets query parameters provider that returns query parameters that should be used in the URL.
void	setRouteParametersProvider(@Nullable ViewOpeningAction.RouteParametersProvider provider)	Sets route parameters provider that returns route parameters that should be used in the route template.
void	setTarget(@Nullable EntityPickerComponent<E> target)
protected void	setUiComponentProperties(UiComponentProperties uiComponentProperties)
void	setViewClass(@Nullable Class<? extends View> viewClass)	Sets the view class.
<V extends View<?>> void	setViewConfigurer(@Nullable Consumer<V> viewConfigurer)	Sets the view configurer.
void	setViewId(@Nullable String viewId)	Sets the view id.
EntityReadAction<E>	withViewClass(@Nullable Class<? extends View> viewClass)	Sets the class of the view to open and returns the action for chaining.
<V extends View<?>> EntityReadAction<E>	withViewConfigurer(@Nullable Consumer<V> viewConfigurer)	Sets the handler that configures the view before it is shown and returns the action for chaining.
EntityReadAction<E>	withViewId(@Nullable String viewId)	Sets the id of the view to open and returns the action for chaining.

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

actionPerform, checkTarget, getTarget, initAction, isApplicable, withTarget

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

addEnabledRule, isEnabledByRule, isPermitted, refreshState, removeEnabledRule

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

getUiObservationSupport

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

addActionPerformedListener, self, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription, withEnabled, withHandler, withIcon, withShortcutCombination, withText, withVariant, withVisible

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

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

Constructor Details

EntityReadAction

public EntityReadAction()

EntityReadAction

public EntityReadAction(String id)

Method Details

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)

setIcons

@Autowired
protected void setIcons(Icons icons)

setTarget

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

Specified by:

setTarget in interface TargetAction<E>

Overrides:

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

getOpenMode

public @Nullable 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

public @Nullable 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

public @Nullable 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

public @Nullable 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

public @Nullable 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 EntityReadAction<E> withViewId(@Nullable String viewId)

Sets the id of the view to open and returns the action for chaining.

Parameters:

viewId - id of the view to open

Returns:

this instance for chaining

withViewClass

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

Sets the class of the view to open and returns the action for chaining.

Parameters:

viewClass - class of the view to open

Returns:

this instance for chaining

withViewConfigurer

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

Sets the handler that configures the view before it is shown and returns the action for chaining.

Type Parameters:

V - view type

Parameters:

viewConfigurer - handler to set

Returns:

this instance for chaining

isEmpty

protected boolean isEmpty()