com.haulmont.cuba.gui.components

Class PickerField.OpenAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.cuba.gui.components.PickerField.StandardAction

com.haulmont.cuba.gui.components.PickerField.OpenAction

All Implemented Interfaces:

Action, Action.SecuredAction, PickerField.PickerFieldAction

Enclosing interface:

PickerField<V extends Entity>

@Component(value="cuba_OpenAction")
 @Scope(value="prototype")
public static class PickerField.OpenAction
extends PickerField.StandardAction

Action to open an edit screen for entity instance which is currently set in the PickerField.

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

 <bean id="cuba_OpenAction" class="com.company.sample.gui.MyOpenAction" scope="prototype"/>
 

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	editScreen
protected WindowManager.OpenType	editScreenOpenType
protected java.util.Map<java.lang.String,java.lang.Object>	editScreenParams
protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	editScreenParamsSupplier
static java.lang.String	NAME
static java.lang.String	READONLY
protected WindowConfig	windowConfig

Fields inherited from class com.haulmont.cuba.gui.components.PickerField.StandardAction

clientConfig, editable, pickerField

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.PickerField.PickerFieldAction

PROP_EDITABLE

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
OpenAction(PickerField pickerField)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
protected void	afterCommitOpenedEntity(Entity item)
protected void	afterWindowClosed(Window window) Hook invoked after the editor was closed
static PickerField.OpenAction	create(PickerField pickerField)
protected java.lang.String	getEditableIcon(java.lang.String icon, boolean editable)
java.lang.String	getEditScreen()
WindowManager.OpenType	getEditScreenOpenType()
java.util.Map<java.lang.String,java.lang.Object>	getEditScreenParams()
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	getEditScreenParamsSupplier()
protected Entity	getEntity()
protected Entity	initEntity()
protected java.util.Map<java.lang.String,java.lang.Object>	prepareScreenParams()
void	setEditable(boolean editable)
void	setEditScreen(java.lang.String editScreen) Set the edit screen ID explicitly.
void	setEditScreenOpenType(WindowManager.OpenType editScreenOpenType) How to open the edit screen.
void	setEditScreenParams(java.util.Map<java.lang.String,java.lang.Object> editScreenParams) Parameters to pass to the edit screen.
void	setEditScreenParamsSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> editScreenParamsSupplier)

Methods inherited from class com.haulmont.cuba.gui.components.PickerField.StandardAction

editableChanged, getPropertyDatasource, isEditable, setPickerField

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

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

Field Detail

NAME

public static final java.lang.String NAME

editScreen

protected java.lang.String editScreen

editScreenOpenType

protected WindowManager.OpenType editScreenOpenType

editScreenParams

protected java.util.Map<java.lang.String,java.lang.Object> editScreenParams

editScreenParamsSupplier

protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> editScreenParamsSupplier

windowConfig

protected WindowConfig windowConfig

READONLY

public static final java.lang.String READONLY

See Also:

Constant Field Values

Constructor Detail

OpenAction

public OpenAction(PickerField pickerField)

Method Detail

create

public static PickerField.OpenAction create(PickerField pickerField)

getEditScreen

public java.lang.String getEditScreen()

setEditScreen

public void setEditScreen(java.lang.String editScreen)

Set the edit screen ID explicitly. By default an edit screen ID is inferred from the entity metaclass name by adding suffix .edit to it.

Parameters:

editScreen - edit screen ID, e.g. sec$User.edit

getEditScreenOpenType

public WindowManager.OpenType getEditScreenOpenType()

setEditScreenOpenType

public void setEditScreenOpenType(WindowManager.OpenType editScreenOpenType)

How to open the edit screen. By default it is opened in WindowManager.OpenType.THIS_TAB mode.

Parameters:

editScreenOpenType - open type

getEditScreenParams

@Nullable
public java.util.Map<java.lang.String,java.lang.Object> getEditScreenParams()

setEditScreenParams

public void setEditScreenParams(java.util.Map<java.lang.String,java.lang.Object> editScreenParams)

Parameters to pass to the edit screen. By default the empty map is passed.

Parameters:

editScreenParams - map of parameters

getEditScreenParamsSupplier

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

setEditScreenParamsSupplier

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

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component when an action occurs.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

prepareScreenParams

@Nonnull
protected java.util.Map<java.lang.String,java.lang.Object> prepareScreenParams()

getEntity

protected Entity getEntity()

initEntity

protected Entity initEntity()

afterCommitOpenedEntity

protected void afterCommitOpenedEntity(Entity item)

afterWindowClosed

protected void afterWindowClosed(Window window)

Hook invoked after the editor was closed

Parameters:

window - the editor window

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class PickerField.StandardAction

getEditableIcon

protected java.lang.String getEditableIcon(java.lang.String icon,
                                           boolean editable)