com.haulmont.cuba.gui.actions.list

Class ViewAction<E extends Entity>

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.cuba.gui.components.actions.BaseAction

com.haulmont.cuba.gui.components.actions.ListAction

com.haulmont.cuba.gui.actions.list.SecuredListAction

com.haulmont.cuba.gui.actions.list.ViewAction<E>

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction

@StudioAction(category="List Actions",
              description="Opens an editor screen for an entity instance in read-only mode")
 @ActionType(value="view")
public class ViewAction<E extends Entity>
extends SecuredListAction
implements Action.ExecutableAction

Standard action for opening an editor screen in the read-only mode. The editor screen must implement the ReadOnlyAwareScreen interface.

Should be defined for a list component (Table, DataGrid, etc.) in a screen XML descriptor.

The action instance can be parameterized using the nested properties XML element or programmatically in the screen controller.

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.BeforeActionPerformedHandler, Action.DisabledWhenScreenReadOnly, Action.ExecutableAction, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<E>	afterCommitHandler
static java.lang.String	ID
protected ScreenBuilders	screenBuilders
protected ActionScreenInitializer	screenInitializer
protected java.util.function.Function<E,E>	transformation

Fields inherited from class com.haulmont.cuba.gui.actions.list.SecuredListAction

constraintCode, constraintOperationType, security

Fields inherited from class com.haulmont.cuba.gui.components.actions.ListAction

target

Fields inherited from class com.haulmont.cuba.gui.components.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface com.haulmont.cuba.gui.components.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
ViewAction()
ViewAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component to execute the action.
void	execute() Executes the action.
OpenMode	getOpenMode() Returns the editor screen open mode if it was set by setOpenMode(OpenMode) or in the screen XML.
java.lang.Class	getScreenClass() Returns the editor screen class if it was set by setScreenClass(Class) or in the screen XML.
java.lang.String	getScreenId() Returns the editor screen id if it was set by setScreenId(String) or in the screen XML.
protected boolean	isPermitted() Callback method which is invoked by the action to determine its enabled state.
void	setAfterCloseHandler(java.util.function.Consumer<Screen.AfterCloseEvent> afterCloseHandler) Sets the handler to be invoked when the editor screen closes.
void	setAfterCommitHandler(java.util.function.Consumer<E> afterCommitHandler) Sets the handler to be invoked when the editor screen commits the entity if "enable editing" action was executed.
protected void	setConfiguration(Configuration configuration)
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setOpenMode(OpenMode openMode) Sets the editor screen open mode.
protected void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setScreenClass(java.lang.Class screenClass) Sets the editor screen id.
void	setScreenConfigurer(java.util.function.Consumer<Screen> screenConfigurer) Sets the editor screen configurer.
void	setScreenId(java.lang.String screenId) Sets the editor screen id.
void	setScreenOptionsSupplier(java.util.function.Supplier<ScreenOptions> screenOptionsSupplier) Sets the editor screen options supplier.
void	setTransformation(java.util.function.Function<E,E> transformation) Sets the function to transform the committed in the editor screen entity (if "enable editing" action was executed) before setting it to the target data container.

Methods inherited from class com.haulmont.cuba.gui.actions.list.SecuredListAction

getConstraintCode, getConstraintOperationType, isApplicable, setConstraintCode, setConstraintOperationType, setSecurity

Methods inherited from class com.haulmont.cuba.gui.components.actions.ListAction

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

addActionPerformedListener, addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

Methods inherited from class com.haulmont.cuba.gui.components.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDefaultCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, setPrimary, setShortcut, setShortcutCombination

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.components.Action

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setIconFromSet, setShortcut, setShortcutCombination, setVisible

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

screenBuilders

protected ScreenBuilders screenBuilders

screenInitializer

protected ActionScreenInitializer screenInitializer

afterCommitHandler

protected java.util.function.Consumer<E extends Entity> afterCommitHandler

transformation

protected java.util.function.Function<E extends Entity,E extends Entity> transformation

Constructor Detail

ViewAction

public ViewAction()

ViewAction

public ViewAction(java.lang.String id)

Method Detail

getOpenMode

@Nullable
public OpenMode getOpenMode()

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

setOpenMode

@StudioPropertiesItem
public void setOpenMode(OpenMode openMode)

Sets the editor screen open mode.

getScreenId

@Nullable
public java.lang.String getScreenId()

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

setScreenId

@StudioPropertiesItem
public void setScreenId(java.lang.String screenId)

Sets the editor screen id.

getScreenClass

@Nullable
public java.lang.Class getScreenClass()

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

setScreenClass

@StudioPropertiesItem
public void setScreenClass(java.lang.Class screenClass)

Sets the editor screen id.

setScreenOptionsSupplier

public void setScreenOptionsSupplier(java.util.function.Supplier<ScreenOptions> screenOptionsSupplier)

Sets the editor screen options supplier. The supplier provides ScreenOptions to the opened screen.

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

 @Install(to = "petsTable.view", subject = "screenOptionsSupplier")
 protected ScreenOptions petsTableViewScreenOptionsSupplier() {
     return new MapScreenOptions(ParamsMap.of("someParameter", 10));
 }
 

setScreenConfigurer

public void setScreenConfigurer(java.util.function.Consumer<Screen> screenConfigurer)

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

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

 @Install(to = "petsTable.view", subject = "screenConfigurer")
 protected void petsTableViewScreenConfigurer(Screen editorScreen) {
     ((PetEdit) editorScreen).setSomeParameter(someValue);
 }
 

setAfterCloseHandler

public void setAfterCloseHandler(java.util.function.Consumer<Screen.AfterCloseEvent> afterCloseHandler)

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

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");
     }
 }
 

setAfterCommitHandler

public void setAfterCommitHandler(java.util.function.Consumer<E> afterCommitHandler)

Sets the handler to be invoked when the editor screen commits the entity if "enable editing" action was executed.

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

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

setTransformation

public void setTransformation(java.util.function.Function<E,E> transformation)

Sets the function to transform the committed in the editor screen entity (if "enable editing" action was executed) before setting it to the target data container.

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

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

setScreenBuilders

@Inject
protected void setScreenBuilders(ScreenBuilders screenBuilders)

setIcons

@Inject
protected void setIcons(Icons icons)

setMessages

@Inject
protected void setMessages(Messages messages)

setConfiguration

@Inject
protected void setConfiguration(Configuration configuration)

isPermitted

protected boolean isPermitted()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isPermitted in class SecuredListAction

Returns:

true if the action is enabled for the current user

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction