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.HasTarget, Action.UiPermissionAware

Enclosing interface:

PickerField

@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.Status, Action.UiPermissionAware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static java.lang.String	READONLY

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.
static PickerField.OpenAction	create(PickerField pickerField)
java.lang.String	getEditScreen()
DialogParams	getEditScreenDialogParams() Deprecated.
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()
void	setEditable(boolean editable)
void	setEditScreen(java.lang.String editScreen) Set the edit screen ID explicitly.
void	setEditScreenDialogParams(DialogParams editScreenDialogParams) Deprecated. Use #setEditScreenOpenType(OpenType)
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.actions.BaseAction

addEnabledRule, getTarget, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, 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, setCaption, 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, setCaption, setDescription, setIcon, setIconFromSet, setShortcut, setShortcutCombination

Field Detail

NAME

public static final java.lang.String NAME

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

getEditScreenDialogParams

@Deprecated
 @Nullable
public DialogParams getEditScreenDialogParams()

Deprecated.

setEditScreenDialogParams

@Deprecated
public void setEditScreenDialogParams(DialogParams editScreenDialogParams)

Deprecated. Use #setEditScreenOpenType(OpenType)

Set edit screen geometry when opening it in WindowManager.OpenType.DIALOG mode. Doesn't affect other modes.

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

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class PickerField.StandardAction