Package io.jmix.flowui.action.list

Class ReadAction<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<ReadAction<E>,E>

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

All Implemented Interfaces:

ExecutableAction, SecuredAction, SecurityConstraintAction, TargetAction<ListDataComponent<E>>, ViewOpeningAction, Action, HasShortcutCombination

@ActionType("list_read")
public class ReadAction<E>
extends SecuredListDataComponentAction<ReadAction<E>,E>
implements ViewOpeningAction

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 OpenMode	openMode
protected ReadOnlyViewsSupport	readOnlyViewsSupport
protected boolean	textInitialized
protected Function<E,E>	transformation
protected ActionViewInitializer	viewInitializer
protected ViewNavigators	viewNavigators

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the action.
<V extends View<?>> Consumer<DialogWindow.AfterCloseEvent<V>>	getAfterCloseHandler()
Consumer<E>	getAfterSaveHandler()
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()
Function<E,E>	getTransformation()
Class<? extends View>	getViewClass()	Returns the detail view class if it was set by setViewClass(Class) or in the view XML.
<V extends View<?>> Consumer<V>	getViewConfigurer()
String	getViewId()	Returns the detail view id if it was set by setViewId(String) or in the view XML.
protected void	initAction()
protected boolean	isPermitted()
protected void	navigate(E editedEntity)
protected void	openDialog(E editedEntity)
<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 the handler to be invoked when the detail view saves the entity (if "enable editing" action was executed).
void	setDialogWindowBuilders(DialogWindows dialogWindows)
protected void	setMessages(Messages messages)
void	setOpenMode(OpenMode openMode)	Sets the view open mode.
void	setQueryParametersProvider(ViewOpeningAction.QueryParametersProvider queryParameters)	Sets query parameters provider that returns query parameters that should be used in the URL.
void	setReadOnlyViewsSupport(ReadOnlyViewsSupport readOnlyViewsSupport)
void	setRouteParametersProvider(ViewOpeningAction.RouteParametersProvider routeParameters)	Sets route parameters provider that returns route parameters that should be used in the route template.
void	setText(String text)
void	setTransformation(Function<E,E> transformation)	Sets the function to transform the saved in the detail view entity (if "enable editing" action was executed) before setting it to the target data container.
protected void	setUiComponentProperties(UiComponentProperties uiComponentProperties)
void	setViewClass(Class<? extends View> viewClass)	Sets the detail view id.
<V extends View<?>> void	setViewConfigurer(Consumer<V> viewConfigurer)	Sets the view configurer.
void	setViewId(String viewId)	Sets the detail view id.
void	setViewNavigators(ViewNavigators viewNavigators)
<V extends View<?>> ReadAction<E>	withAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)
ReadAction<E>	withAfterSavedHandler(Consumer<E> afterSavedHandler)
ReadAction<E>	withOpenMode(OpenMode openMode)
ReadAction<E>	withQueryParametersProvider(ViewOpeningAction.QueryParametersProvider provider)
ReadAction<E>	withRouteParametersProvider(ViewOpeningAction.RouteParametersProvider provider)
ReadAction<E>	withTransformation(Function<E,E> transformation)
ReadAction<E>	withViewClass(Class<? extends View> viewClass)
<V extends View<?>> ReadAction<E>	withViewConfigurer(Consumer<V> viewConfigurer)
ReadAction<E>	withViewId(String viewId)

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, checkTargetItems, getTarget, onSelectionChange, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

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

addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, 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, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, 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

viewNavigators

protected ViewNavigators viewNavigators

dialogWindows

protected DialogWindows dialogWindows

readOnlyViewsSupport

protected ReadOnlyViewsSupport readOnlyViewsSupport

viewInitializer

protected ActionViewInitializer viewInitializer

afterSaveHandler

protected Consumer<E> afterSaveHandler

transformation

protected Function<E,E> transformation

textInitialized

protected boolean textInitialized

openMode

protected OpenMode openMode

Constructor Details

ReadAction

public ReadAction()

ReadAction

public ReadAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

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

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

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

Specified by:

getViewId in interface ViewOpeningAction

setViewId

public void setViewId(@Nullable
 String viewId)

Sets the detail view id.

Specified by:

setViewId in interface ViewOpeningAction

Parameters:

viewId - the view id to set

getViewClass

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

Returns the detail view class if it was set by 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)

Sets the detail view id.

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

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:

routeParameters - 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 queryParameters)

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:

queryParameters - 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

setAfterSaveHandler

public void setAfterSaveHandler(@Nullable
 Consumer<E> afterSaveHandler)

Sets the handler to be invoked when the detail view saves the entity (if "enable editing" action was executed).

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.read", subject = "afterSaveHandler")
 protected void petsTableReadAfterSaveHandler(Pet entity) {
     System.out.println("Saved " + entity);
 }
 

getAfterSaveHandler

@Nullable
public Consumer<E> getAfterSaveHandler()

setTransformation

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

Sets the function to transform the saved in the detail view entity (if "enable editing" action was executed) before setting it to the target data container.

Note that transformation function is invoked if the detail 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.read", subject = "transformation")
 protected Pet petsTableReadTransformation(Pet entity) {
     return doTransform(entity);
 }
 

Parameters:

transformation - transformation function to set

getTransformation

@Nullable
public Function<E,E> getTransformation()

setMessages

@Autowired
protected void setMessages(Messages messages)

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties uiComponentProperties)

setViewNavigators

@Autowired
public void setViewNavigators(ViewNavigators viewNavigators)

setDialogWindowBuilders

@Autowired
public void setDialogWindowBuilders(DialogWindows dialogWindows)

setReadOnlyViewsSupport

@Autowired
public void setReadOnlyViewsSupport(ReadOnlyViewsSupport readOnlyViewsSupport)

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<ReadAction<E>,E>

execute

public void execute()

Executes the action.

Specified by:

execute in interface ExecutableAction

openDialog

protected void openDialog(E editedEntity)

navigate

protected void navigate(E editedEntity)

withViewId

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

See Also:

• setViewId(String)

withViewClass

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

See Also:

• setViewClass(Class)

withRouteParametersProvider

public ReadAction<E> withRouteParametersProvider(@Nullable
 ViewOpeningAction.RouteParametersProvider provider)

See Also:

• setRouteParametersProvider(RouteParametersProvider)

withQueryParametersProvider

public ReadAction<E> withQueryParametersProvider(@Nullable
 ViewOpeningAction.QueryParametersProvider provider)

See Also:

• setQueryParametersProvider(QueryParametersProvider)

withOpenMode

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

See Also:

• setOpenMode(OpenMode)

withAfterCloseHandler

public <V extends View<?>> ReadAction<E> withAfterCloseHandler(Consumer<DialogWindow.AfterCloseEvent<V>> afterCloseHandler)

See Also:

• setAfterCloseHandler(Consumer)

withViewConfigurer

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

See Also:

• setViewConfigurer(Consumer)

withAfterSavedHandler

public ReadAction<E> withAfterSavedHandler(@Nullable
 Consumer<E> afterSavedHandler)

See Also:

• setAfterSaveHandler(Consumer)

withTransformation

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

See Also:

• setTransformation(Function)