com.haulmont.cuba.gui.components.actions

Class EditAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.cuba.gui.components.actions.ItemTrackingAction

com.haulmont.cuba.gui.components.actions.EditAction

All Implemented Interfaces:

Action, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.UiPermissionAware

@Component(value="cuba_EditAction")
 @Scope(value="prototype")
public class EditAction
extends ItemTrackingAction
implements Action.HasOpenType, Action.HasBeforeActionPerformedHandler

Standard list action to edit an entity instance.

Action's behaviour can be customized by providing arguments to constructor, setting properties, or overriding methods afterCommit(com.haulmont.cuba.core.entity.Entity), afterWindowClosed(com.haulmont.cuba.gui.components.Window)

In order to provide your own implementation globally, create a subclass and register it in web-spring.xml, for example:

 <bean id="cuba_EditAction" class="com.company.sample.gui.MyEditAction" scope="prototype"/>
 

Also, use create() static methods instead of constructors when creating the action programmatically.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EditAction.AfterCommitHandler
static interface	EditAction.AfterWindowClosedHandler
static class	EditAction.BulkEditorCloseEvent Event that is fired when BulkEditor windows gets closed.
static class	EditAction.BulkEditorIntegration BulkEditor integration options.

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.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.Status, Action.UiPermissionAware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID

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
EditAction(ListComponent target) The simplest constructor.
EditAction(ListComponent target, WindowManager.OpenType openType) Constructor that allows to specify how the editor screen opens.
EditAction(ListComponent target, WindowManager.OpenType openType, java.lang.String id) Constructor that allows to specify the action name and how the editor screen opens.

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) This method is invoked by the action owner component.
static EditAction	create(ListComponent target) Creates an action with default id, opening the edit screen in THIS tab.
static EditAction	create(ListComponent target, WindowManager.OpenType openType) Creates an action with default id.
static EditAction	create(ListComponent target, WindowManager.OpenType openType, java.lang.String id) Creates an action with the given id.
Action.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
EditAction.BulkEditorIntegration	getBulkEditorIntegration()
WindowManager.OpenType	getOpenType()
java.lang.String	getWindowId()
java.util.Map<java.lang.String,java.lang.Object>	getWindowParams()
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	getWindowParamsSupplier()
void	refreshState() Refresh internal state of the action to initialize enabled, visible, caption, icon, etc.
void	setAfterCommitHandler(EditAction.AfterCommitHandler afterCommitHandler)
void	setAfterWindowClosedHandler(EditAction.AfterWindowClosedHandler afterWindowClosedHandler)
void	setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)
void	setCaption(java.lang.String caption)
void	setEditorCloseListener(Window.CloseListener editorCloseListener) Overwrites default close listener for editor window.
void	setOpenType(WindowManager.OpenType openType)
void	setWindowId(java.lang.String windowId)
void	setWindowParams(java.util.Map<java.lang.String,java.lang.Object> windowParams)
void	setWindowParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> windowParamsSupplier)

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

getConstraintCode, getConstraintOperationType, setConstraintCode, setConstraintOperationType

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

addEnabledRule, getTarget, isEnabledByUiPermissions, isVisibleByUiPermissions, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setTarget, setVisible, setVisibleByUiPermissions, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

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

Methods inherited from class java.lang.Object

equals, 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, removeOwner, removePropertyChangeListener, setDescription, setEnabled, setIcon, setIconFromSet, setShortcut, setShortcutCombination, setVisible

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

Constructor Detail

EditAction

public EditAction(ListComponent target)

The simplest constructor. The action has default name and opens the editor screen in THIS tab.

Parameters:

target - component containing this action

EditAction

public EditAction(ListComponent target,
                  WindowManager.OpenType openType)

Constructor that allows to specify how the editor screen opens. The action has default name.

Parameters:

target - component containing this action

openType - how to open the editor screen

EditAction

public EditAction(ListComponent target,
                  WindowManager.OpenType openType,
                  java.lang.String id)

Constructor that allows to specify the action name and how the editor screen opens.

Parameters:

target - component containing this action

openType - how to open the editor screen

id - action name

Method Detail

create

public static EditAction create(ListComponent target)

Creates an action with default id, opening the edit screen in THIS tab.

Parameters:

target - component containing this action

create

public static EditAction create(ListComponent target,
                                WindowManager.OpenType openType)

Creates an action with default id.

Parameters:

target - component containing this action

openType - how to open the editor screen

create

public static EditAction create(ListComponent target,
                                WindowManager.OpenType openType,
                                java.lang.String id)

Creates an action with the given id.

Parameters:

target - component containing this action

openType - how to open the editor screen

id - action name

setCaption

public void setCaption(java.lang.String caption)

Specified by:

setCaption in interface Action

Overrides:

setCaption in class AbstractAction

refreshState

public void refreshState()

Description copied from interface: Action

Refresh internal state of the action to initialize enabled, visible, caption, icon, etc. properties depending on programmatically set values and user permissions set at runtime.
For example, this method is called by visual components holding actions when they are connected to datasources. At this moment the action can find out what entity it is connected to and change its state according to the user permissions.

Specified by:

refreshState in interface Action

Overrides:

refreshState in class BaseAction

actionPerform

public void actionPerform(Component component)

This method is invoked by the action owner component.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - component invoking the action

getOpenType

public WindowManager.OpenType getOpenType()

Specified by:

getOpenType in interface Action.HasOpenType

Returns:

editor screen open type

setOpenType

public void setOpenType(WindowManager.OpenType openType)

Specified by:

setOpenType in interface Action.HasOpenType

Parameters:

openType - editor screen open type

getWindowId

public java.lang.String getWindowId()

Returns:

editor screen identifier

setWindowId

public void setWindowId(java.lang.String windowId)

Parameters:

windowId - editor screen identifier

getWindowParams

public java.util.Map<java.lang.String,java.lang.Object> getWindowParams()

Returns:

editor screen parameters

setWindowParams

public void setWindowParams(java.util.Map<java.lang.String,java.lang.Object> windowParams)

Parameters:

windowParams - editor screen parameters

getWindowParamsSupplier

public java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> getWindowParamsSupplier()

Returns:

supplier that provides editor screen parameters

setWindowParamsSupplier

public void setWindowParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> windowParamsSupplier)

Parameters:

windowParamsSupplier - supplier that provides editor screen parameters

setAfterCommitHandler

public void setAfterCommitHandler(EditAction.AfterCommitHandler afterCommitHandler)

Parameters:

afterCommitHandler - handler that is invoked after the editor was committed and closed

setAfterWindowClosedHandler

public void setAfterWindowClosedHandler(EditAction.AfterWindowClosedHandler afterWindowClosedHandler)

Parameters:

afterWindowClosedHandler - handler that is always invoked after the editor closed

setEditorCloseListener

public void setEditorCloseListener(Window.CloseListener editorCloseListener)

Overwrites default close listener for editor window.

Parameters:

editorCloseListener - new close listener

getBeforeActionPerformedHandler

public Action.BeforeActionPerformedHandler getBeforeActionPerformedHandler()

Specified by:

getBeforeActionPerformedHandler in interface Action.HasBeforeActionPerformedHandler

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)

Specified by:

setBeforeActionPerformedHandler in interface Action.HasBeforeActionPerformedHandler

getBulkEditorIntegration

public EditAction.BulkEditorIntegration getBulkEditorIntegration()

Returns:

bulk editor integration options.